Robot
v2023.4
バナーの背景画像
Robot ガイド
最終更新日 2024年2月27日

コマンド ライン インターフェイス

Robot コマンド ライン インターフェイス (UiRobot.exe) は、ジョブの開始を要求することができ、ジョブの出力を待つコンソール アプリケーションです。Robot サービスの直接のクライアントであり、WCF チャネルを使用して通信が行われます。

ロボットでサポートされるコマンド ライン引数の利用には、UiPath Robot サービスが実行されている必要があります。実行されていない場合は、Microsoft 管理コンソール サービス スナップインから起動してください。



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

引数の説明の章に記載されている例は、この操作を行ったと仮定して構成されています。

引数の説明

コマンド ライン引数を使用しやすくするために、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) 引数の両方を同時に指定することはできません。次の引数をサポートします。
注: これまでは、プロセス リストの更新はプロセスの開始前に行われていましたが、v2023.4 からはプロセスの実行と並行して行われるようになりました。つまり、利用可能な更新があるプロセスを実行すると、古いバージョンのプロセスでジョブが実行される可能性があります。

引数

説明

-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\Main.xaml"
  • UiRobot.exe execute --file "C:\UiPath\Automation\Notepad.1.0.6682.21636.nupkg"
--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"

Install Process コマンド

  • UiRobot installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]
プロセスのインストールには、installprocess コマンドを使用します。ロボットが Orchestrator に接続されている場合、ロボットは Orchestrator フィード内でのみプロセスを検索します。ロボットが Orchestrator に接続されていない場合、ローカル フィードが使用されます。

次の引数がサポートされています。

引数説明
--process-name <process_name>必須です。インストールするプロセスの名前です。

例:

  • UiRobot installprocess --process-name MyProcess
--folder <orchestrator_folder>任意です。インストールするプロセスが含まれる Orchestrator フォルダーの名前です。この引数は、ロボットが Orchestrator に接続されている場合にのみ使用できます。インストールするプロセスが 1 つのフォルダーにしか存在しない場合は、このパラメーターは必要ありません。
例:
  • UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder

Pack コマンド

注: v2018.4.4 以降の Studio では、コマンド UiRobot.exe pack ではなく UiPath.Studio.CommandLine.exe publish を使用してパブリッシュすることをお勧めします。詳しくは、「一括更新コマンド ライン パラメーター」をご覧ください。
  • UiRobot.exe pack <Project_Path> --output <Destination_Folder> [-v <Project_Version>]
このコマンドは .nupkg ファイルに Project.json ファイルをパックするために使用されます。次の引数をサポートします。
引数説明

-o

--output <Destination_Folder>

必須です。.nupkg ファイルを作成する場所を指定できます。

例:

  • UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"

-v <Project_Version>

任意です。.nupkg ファイルのバージョンを指定できます。

例:

  • 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 は既に接続されています。」というメッセージが返されます。

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

引数

説明

connect

Robot を Orchestrator に接続するために使用します。 --url--key、または --clientID --clientSecret 引数と共に使用する必要があります。これらの引数を指定しないと、[Orchestrator の設定] の設定を使用して接続が確立されます。

例:

  • UiRobot.exe connect

マシン キーの例:

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

クライアント ID とクライアント シークレットの例:

  • UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

Disconnect コマンド

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

表 1.
引数説明
UiRobot.exe disconnect

ロボットを Orchestrator から切断します。このコマンドは、ロボット端末で実行中のジョブがない場合にのみ機能します。

robot.exe disconnect --forceロボットを Orchestrator から切断します。マシン上でジョブが実行されている場合、ジョブは強制終了され、その後でのみロボットが切断されます
robot.exe disconnect --waitロボットを Orchestrator から切断します。マシン上でジョブが実行されている場合、ロボットはジョブの完了後にのみ切断されます。

Trace コマンド

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

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

引数

説明

--enableLowLevel

ローレベルのトレースを有効化します。イベント ビューアーで開くことのできる .etl ファイルが生成されます。これはクラッシュやエラーなどの問題を解決するのに役立ちます。これにより、イベント ビューアーで Robot Executor とサービスの詳細トレーシングが可能になります。

例:

  • UiRobot.exe trace --enableLowLevel

--disableLowLevel

ローレベルのトレースを無効化します。トレーシングを停止したあと、.etl ファイルがデスクトップに生成されます。このファイルはイベント ビューアーで開くことができ、クラッシュやエラーなどの問題を解決できるようにします。

例:

  • UiRobot.exe trace --disableLowLevel

PiP コマンド

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

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

コマンド

説明

PiP --enable

マシンのピクチャ イン ピクチャ機能を有効化します。

PiP --disable

マシンのピクチャ イン ピクチャ機能を無効化します。

ENABLE_PIP コマンド

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

コマンド

説明

ENABLE_PIP=1

マシンのピクチャ イン ピクチャ機能を有効化します。

ENABLE_PIP=0

マシンのピクチャ イン ピクチャ機能を有効化しません。

その他のコマンド

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

引数

説明

--version

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

--help

サポートされているコマンドのリスト、および対応する情報と例を表示します。

logs --flush

保留中のすべてのログを Orchestrator に送信します。

Was this page helpful?

サポートを受ける
RPA について学ぶ - オートメーション コース
UiPath コミュニティ フォーラム
UiPath ロゴ (白)
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.