通知を受け取る

UiPath Robot

UiPath Robot ガイド

引数の説明

コマンド ライン引数を使用しやすくするために、cd (change directory) コマンドを使用して Robot がインストールされているディレクトリまで移動します。Robot の既定の場所を変更していなければ、次のコマンドを使うことができます。
cd C:\Program Files\UiPath\Studio です。

ここに表示されている例はすべて、上記のコマンドを最初に実行したと仮定して構成されています。

Attended ロボットは、人間の監督下でのみ実行してください。

Execute コマンド

  • UiRobot.exe execute [--process <Package_ID> | --file <File_Path>] [--folder <Orchestrator_Folder_ID>] [--input <Input_Parameters>]

このコマンドは、プロセスまたはファイル (.json.xaml、または .nupkg) の実行を開始するために使用されます。execute コマンドの使用時に、--process (-p) および --file (-f) 引数の両方を同時に指定することはできません。次の引数をサポートします。

📘

これまでは、プロセス リストの更新はプロセスの開始前に行われていましたが、v2022.10 からはプロセスの実行と並行して行われるようになりました。つまり、利用可能な更新があるプロセスを実行すると、古いバージョンのプロセスでジョブが実行される可能性があります。

ArgumentDescription
-p
--process <Package_ID>
Mandatory. Starts the execution of a local or Orchestrator process.
Examples:
UiRobot.exe execute --process UiPathDemoProcess
UiRobot.exe execute -p UiPathDemoProcess
-f
--file <File_Path>
Mandatory. Starts the execution of a local project file. The target file can be .json, .xaml, or .nupkg.
Examples:
UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" :warning:
UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" :warning:
UiRobot.exe execute --file "C:\UiPath\Automation\Notepad.1.0.6682.21636.nupkg"
--folder <Orchestrator_Folder_ID>Optional. Allows you to specify the Orchestrator folder from which to install and execute the target process. It can only be used together with the --process argument.
Example:
UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
--input <Input_Parameters>Optional. Allows you to specify input arguments for execution. It can be used with the --process or --file arguments.
Examples:
UiRobot.exe execute --process UiPathDemoProcess --input "{'inArg' : 'value' , 'Integer' : 3}"
UiRobot.exe execute --process UiPathDemoProcess --folder OrchFolder1 --input "{'inArg' : 'value' , 'Integer' : 3}"
UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"
entryAllows you to select the entry point of a process when starting it via the command line.

Example:

UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml"

:warning: Windows プロジェクトまたはポータブル プロジェクトではサポートされていません。

Pack コマンド

📘

注:

v2018.4.4 以降の Studio では、コマンド UiRobot.exe pack ではなくUiPath.Studio.CommandLine.exe publish を使用してパブリッシュすることをお勧めします。詳しくは、Studio ガイドの「一括更新コマンド ライン パラメーター」をご覧ください。

  • UiRobot.exe pack <Project_Path> --output <Destination_Folder> [-v <Project_Version>]

このコマンドは .nupkg ファイルに Project.json ファイルをパックするために使用されます。次の引数をサポートします。

ArgumentDescription
-o
--output <Destination_Folder>
Mandatory. Allows you to specify where the .nupkg file is created.
Example:
UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"
-v <Project_Version>Optional. Allows you to specify a version for the .nupkg file.
Example:
UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages" -v 1.0.6820.22047

Connect コマンド

  • UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]

📘

注:

ロボットが既に接続されている場合、connect コマンドを実行すると次のメッセージが返されます: Orchestrator already connected!

このコマンドは、Robot を Orchestrator インスタンスに接続するために使用されます。次の引数をサポートします。

ArgumentDescription
connectUsed to connect the robot to Orchestrator, must be used with the --url, --key, or --clientID --clientSecret arguments. If the arguments are not specified, the Orchestrator Settings configuration is used to establish the connection.

Example:
UiRobot.exe connect

Machine Key example:
UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00

Client ID and Client Secret example:
UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

Disconnect コマンド

  • UiRobot.exe disconnect

このコマンドは、Robot を Orchestrator インスタンスから切断するために使用されます。

Trace コマンド

  • UiRobot.exe trace --enableLowLevel | --disableLowLevel

このコマンドは、Robot のローレベル (Verbose) のトレースを有効化または無効化するために使用されます。次の引数をサポートします。

ArgumentDescription
--enableLowLevelEnables low-level tracing. An .etl file is generated, which can be opened with the Event Viewer, to help you with troubleshooting crashes and errors.This enables verbose tracing for the Robot Executor and Service in the Event Viewer.
Example:
UiRobot.exe trace --enableLowLevel
--disableLowLevelDisables low-level tracing. An .etl file is generated to the Desktop after you stop it. This file can be opened in the Event Viewer, to help you with troubleshooting crashes and errors.
Example:
UiRobot.exe trace --disableLowLevel

PiP コマンド

マシンのピクチャ イン ピクチャ機能を有効化または無効化できます。この設定はローカル マシン上で適用され、すべてのユーザーに影響があります。また、既存のインストールを変更するために使用されます。

これらのコマンドを実行するには、管理者権限が必要です。

CommandDescription
PiP --enableEnables the Picture in Picture functionality of the machine.
PiP --disableDisables the Picture in Picture functionality of the machine.

ENABLE_PIP コマンド

コマンドラインから UiPath をインストールするときに、マシンのピクチャ イン ピクチャ機能を有効化することができます。

CommandDescription
ENABLE_PIP=1Enables the Picture in Picture functionality of the machine.
ENABLE_PIP=0Does not enable the Picture in Picture functionality of the machine.

その他のコマンド

次のコマンドは純粋に情報を提供するものであり、オートメーション プロジェクトにはまったく影響しません。

ArgumentDescription
--versionDisplays information about the Robot version.
--helpDisplays the list of supported commands, as well as corresponding information and examples.
logs --flushSends all pending logs to Orchestrator.

15 日前に更新


引数の説明


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。