Orchestrator 内でジョブを実行する

Orchestrator 内でジョブを実行する

前提条件:

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

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

1. uipcli jobを使用して、job タスクを実行します。これで、利用可能なサブタスクのリストを確認できます。
2. 必要なパラメーターを指定し、[ run ] サブタスクを実行します。次の表で、必要なパラメーターについて説明します。

パラメーター	説明
-i または --input_path (ワークフローのエントリ ポイントに入力パラメーターがある場合にのみ 必要 )	実行するプロセスに対応する JSON 入力ファイルへのフル パスです。ファイル構造について詳しくは、「 入力パラメーター JSON 形式 」をご覧ください。
-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 です。 サポートされている値: 無人オートメーションのランタイム: Unattended、 NonProduction、 TestAutomation、 Development、 Headless 有人オートメーション ランタイム: Attended、 AssistantWeb 開発者用ライセンス: RpaDeveloper、 RpaDeveloperPro、 CitizenDeveloper Studio ライセンス: Studio、 StudioX、 StudioPro、 AttendedStudioWeb クラウド/サーバーレス ランタイム: AutomationCloud、 Serverless、 AutomationKit、 ServerlessTestAutomation、 AutomationCloudTestAutomation テスト中: AppTest、 PerformanceTest その他:AgentService、Hosting、ProcessOrchestration
-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 です。
Process Name (pos.0) (必須)	実行するプロセスの名前です。
Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	プロセスを実行する Orchestrator インスタンスのテナントです。

注:

--applicationScope パラメーターを指定せずに外部アプリケーション認証を使用すると、CLI は以下の既定の Orchestrator スコープを自動的に適用します。

OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read

警告:

PowerShell スクリプトで --applicationSecret パラメーターを使用する場合、 $ などの特殊文字を使用すると、二重引用符で囲まれた文字列で PowerShell の変数が展開されるため、予期しない動作が発生する可能性があります。

--applicationSecret パラメーターを渡すときは、二重引用符 ( の"") の代わりに一重引用符 ('') を使用して、PowerShell で特殊文字が解釈されないようにします。

# Correct - single quotes treat the string literally
uipcli job run ProcessName "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S 'mySecret$123' -o "MyFolder"

# Incorrect - double quotes allow variable expansion
uipcli job run ProcessName "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S "mySecret$123" -o "MyFolder"

使用状況:

uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <RuntimeType>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

最小限のコマンドの例:

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"