ロボットのコマンド ライン インターフェイス

UiPath Robot のコマンド ライン インターフェイスは、コマンド ライン ターミナルからロボットを操作できるツールです。コマンド ライン インターフェイスでは、UiRobot.exe ファイルを使用して、有人オートメーションと無人オートメーションをコマンド ラインから直接開始、停止、監視します。また、インストール済みパッケージの詳細の取得、ログの作成、構成の更新を行うこともできます。

動作のしくみ

CLI を使用するには、次の点を確認します。

• Robot サービスが実行されていない

• Robot がインストールされているディレクトリで作業している。

その後、オートメーションで実行する操作に応じて、UiRobot.exe プログラムを参照する命令またはコマンドと必要なパラメーターを入力します。

たとえば、コマンド ラインからプロセスを開始するには、次のコマンドを使用します。

UiRobot.exe -file "C:\UiPath\Projects\YourProject\Main.xaml".

UiRobot.exe の一般的なコマンド

実行

このコマンドは、次の種類のプロジェクト ファイルの実行を開始する場合に使用します。

• JSON

• XAML

• NUPKG

注:

Robot v2023.4 以降では、プロセスの実行と同時にプロセス リストが更新されます。ジョブの開始時にプロセスの更新が利用可能である場合、ジョブは古いバージョンのプロセスを使用します。それ以降の実行では、更新されたプロセスが適用されます。

execute コマンドでは、次の引数を使用します。

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

• -p--process <Package_ID> (必須) ローカルまたは Orchestrator プロセスの実行を開始します。

  例:

  UiRobot.exe execute --process UiPathDemoProcess

  UiRobot.exe execute -p UiPathDemoProcess

• -f--file <File_Path> (必須) - ローカル プロジェクト ファイルの実行を開始します。対象のファイルは JSON、XAML、または NUPKG です。

  例:

  UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

  UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

  UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

• --folder <Orchestrator_Folder_ID> (任意) ターゲット プロセスをインストールおよび実行する Orchestrator フォルダーを指定できます。--process 引数と一緒の場合のみ使用できます。

  例：

  UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1

• --input <Input_Parameters> (任意) - 実行用の入力引数を指定できます。--process または --file 引数と使用できます。

  例:

  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}"

• --entry <entrypoint> (任意) - コマンド ラインを使用してプロセスを開始するときに、そのプロセスのエントリ ポイントを選択できます。

  例：

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

重要:

• 以下のコマンドは、Windows プロジェクトまたはクロスプラットフォーム プロジェクトではサポートされていません。

  • UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"

  • UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

• execute コマンドで --process (-p) 引数と --file (-f) 引数を同時に使用することはできません。

プロセスをインストールする

このコマンドは、プロセスをインストールする場合に使用します。Robot が Orchestrator に接続されている場合、Robot は Orchestrator フィード内でプロセスを検索します。Orchestrator に接続されていない場合は、ローカル フィードを使用します。

installprocess コマンドでは、次の引数を使用します。

UiRobot.exe installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]

• --process-name <process_name> (必須) - インストールするプロセスの名前です。

  例：

  UiRobot installprocess --process-name MyProcess

• --folder <orchestrator_folder> (任意) - インストールするプロセスを含む Orchestrator のフォルダーの名前です。この引数は、Orchestrator への接続がアクティブな場合にのみ適用されます。インストールするプロセスが含まれるフォルダーが 1 つしかない場合は、このパラメーターをスキップします。

  例：

  UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder

接続

このコマンドは、Robot を Orchestrator インスタンスに接続する場合に使用します。Robot がすでに Orchestrator に接続されている場合にこのコマンドを実行すると、「Orchestrator はすでに接続されています。」というメッセージが返されます。

connect コマンドでは、次の引数を使用します。

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

• connect - Orchestrator への接続を確立します。--url、--key、または --clientID --clientSecret の引数と一緒に使用する必要があります。これらの引数を指定しない場合は、[Orchestrator の設定] の設定が使用されます。

  例:

  // no arguments
  
  UiRobot.exe connect

  //using the machine key
  
  UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00

  //using the client ID and secret
  
  UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

切断

このコマンドを使用すると、Robot を現在の Orchestrator インスタンスから切断できます。

disconnect コマンドでは、次の引数を使用します。

UiRobot.exe disconnect --force | --wait

• disconnect - ロボット端末で実行中のジョブがない場合にのみ、Robot を Orchestrator から切断します。

  例：

  UiRobot.exe disconnect

• --force - マシン上で実行中のすべてのジョブを強制終了し、Robot を Orchestrator から切断します。

  例：

  UiRobot.exe disconnect --force

• --wait - 実行中のジョブが完了するまで待機してから、Robot を Orchestrator から切断します。

  例：

  UiRobot.exe disconnect --wait

Trace (トレース)

このコマンドは、Robot のローレベルのトレースを有効化または無効化する場合に使用します。

trace コマンドでは、次の引数を使用します。

UiRobot.exe trace --enableLowLevel | --disableLowLevel

• --enableLowLevel - Robot Executor およびサービスの Verbose トレースをイベント ビューアー内で有効化します。ETL ファイルが生成され、イベント ビューアーで開いてクラッシュやエラーなどの問題を解決する際に役立てることができます。

  例：

  UiRobot.exe trace --enableLowLevel

• --disableLowLevel - Robot Executor とサービスの Verbose トレースを無効化します。ETL ファイルが生成され、イベント ビューアーで開いてクラッシュやエラーなどの問題を解決する際に役立てることができます。

  例：

  UiRobot.exe trace --disableLowLevel

PiP

このコマンドは、マシンのロボット セッションまたはピクチャ イン ピクチャ機能を有効化または無効化する場合に使用します。この設定は既存のインストールを変更します。また、ローカル マシン上のすべてのユーザーに適用されます。管理者権限が必要です。

PiP コマンドでは、次の引数を使用します。

UiRobot.exe pip --enable | --disable

• --enable - マシンのロボット セッション (PiP 機能) を有効化します。

  例：

  UiRobot.exe pip --enable

• --disable - マシンのロボット セッション (PiP 機能) を無効化します。

  例：

  UiRobot.exe pip --disable

その他の引数

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

• --version - Robot のバージョンに関する情報を表示します。

• --help - サポートされているコマンドのリスト、および対応する情報と例を表示します。
• flushlogs [--timeout <timeout_in_seconds>] - 保留中のすべてのログを Orchestrator に送信します。