Orchestrator 内でジョブを実行する

前提条件:

• Orchestrator 内にプロセスを作成します。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。

Orchestrator 内でジョブを実行するには、次の手順に従います。

1. uipcli job を使用して job タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、run サブタスクを実行します。 以下のパラメーターのリストをご覧ください。

パラメーター	説明
-i または --input_path (ワークフローのエントリ ポイントに入力パラメーターがある場合にのみ 必要 )	実行するプロセスに対応する JSON 入力ファイルのフル パスです。 JSON ファイル形式の例: { "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
-P , or --priority	ジョブを実行する優先度です。以下を指定できます。- 低 - 標準 (既定) - 高
-r , or --robots	特定のロボット名をコンマで区切って列挙したリストです。
-j , or --jobscount	プロセスを実行する回数です。プロセスの既定の実行回数は 1 回です。
-U , or --user	ユーザーの名前です。ユーザーは、Orchestrator のユーザーではなくマシンのユーザーである必要があります。ローカル ユーザーの場合、MachineName\UserName の形式を使用してください。
-M , or --machine	プロセスを実行するマシンの名前です。
-R , or --result_path	JSON ファイル、またはジョブの結果を保存するフォルダーのフル パスです。結果は JSON ファイルとして返されます。
-W , or --timeout	ジョブの実行のタイムアウト (秒) です。既定値は 1800 秒です。
-f , or --fail_when_job_fails	1 つのジョブが失敗すると、コマンドは失敗します。既定値は True です。
-w , or --wait	コマンドは、ジョブが完了するまで待機します。既定値は True です。
-b または --job_type (モダン フォルダーのみ)	ジョブのランタイムの種類です。以下を選択できます。- Unattended- NonProduction
-u 、または --username ( 基本認証を使用する場合は必須、ユーザー名とパスワードを使用)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
-p 、または --password ( 基本認証を使用する場合は必須、ユーザー名とパスワードを使用)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
-t 、または--token ( トークンベースの認証 を使用する場合は 必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
-a 、または--accountName ( トークンベースの認証 を使用する場合は 必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
-A , or --accountForApp	Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
-I または--applicationId ( 外部アプリケーション認証 を使用する場合は 必須 )	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
-S または--applicationSecret ( 外部アプリケーション認証 を使用する場合は 必須 )	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
--applicationScope (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
-o , or --organizationUnit	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
-l , --language	Orchestrator の言語です。
-y , --disableTelemetry	テレメトリ データを無効化します。
--traceLevel	イベントのトレースを表示します。
--identityUrl ( PaaS または MSI デプロイに必要)	Identity Server の URL です。
--help	このコマンドのパラメーターと例を表示します。
--version	バージョン情報を表示します。
Process Name (pos.0) (必須)	実行するプロセスの名前です。
Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	プロセスを実行する Orchestrator インスタンスのテナントです。

使用状況:

job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-l <language>]

例:

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Low
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Normal -o MyFolder
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P High -o MyFolder
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -f false -W 0
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w false
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P Low -r robotName -R C:\Temp
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -r robotName -R C:\Temp\status.json