タスクを実行する

Windows デバイス用に設計された UiPath CLI (UiPath.CLI.Windows) 内でタスクを実行するには、必要な作業がいくつかあります。

UiPath.CLI.Windows の手順と UiPath.CLI (Linux デバイス用に設計された UiPath CLI) の手順の主な違いは、CLI を実行するデバイスの種類に固有のタスクで渡すことができる追加の引数にあります。

API アクセスのアプリケーション スコープ

以下の表は、CLI タスクを実行するために必要な Orchestrator API アクセスのアプリケーション スコープを示しています。

アプリケーション スコープ	説明
OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

UiPath.CLI.Windows を実行する

前提条件: Windows 用の UiPath CLI を使用してタスクを実行するには、.NET 6.0.7 をインストールします。これには、6.0.302 SDK に付属する .NET 6.0.7 Desktop Runtime が含まれている必要があります。

タスクを実行するには、uipcli.exe を、対応するパラメーターを含めて呼び出します。サブタスクを実行するには、コマンドが uipcli.exe <task name> <sub-task name> の形式である必要があります。CLI を実行するには、以下の手順を実行します。

1. コマンド プロンプトを開き、NUPKG ファイルから展開したフォルダーに移動します。
2. 「uipcli.exe」と入力し、Enter キーを押します。

UiPath.CLI を実行する

前提条件: クロスプラットフォーム用の UiPath CLI を使用してジョブ タスクを実行するには、6.0.302 SDK に付属する .NET 6.0.7 をインストールします。

タスクを実行するには、uipcli.exe を、対応するパラメーターを含めて呼び出します。サブタスクを実行するには、コマンドが dotnet uipcli.dll <task name> <sub-task name> の形式である必要があります。CLI を実行するには、以下の手順を実行します。

1. コマンド プロンプトを開き、NUPKG ファイルから展開したフォルダーに移動します。
2. 「dotnet uipcli.dll」と入力し、Enter キーを押します。

CLI のバージョンを表示する

uipcli --version コマンドを実行します。

Orchestrator からアセットを削除する

前提条件:

• Orchestrator 内にアセットを作成します。
• 削除するアセットを含む CSV ファイルを作成します。CSV ファイルには、name、type、value の 3 つの列が必要です。type 列と value 列の下のデータ セルは空のままで構いません。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

CSV ファイルについて詳しくは、以下の表の例をご覧ください。

name	type	value
asset1_name	N/A	N/A
asset2_name	Bool	true
asset3_name	integer	N/A
asset4_name	Credential	username:password

Orchestrator からアセットを削除するには、以下の手順を実行します。

1. uipcli asset を使用して asset タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、delete サブタスクを実行します。

   以下のパラメーターのリストをご覧ください。

   パラメーター	説明
   Assets File (pos. 0) (必須)	削除するアセットが含まれる CSV ファイルの名前です。
   Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	アセットを管理する Orchestrator インスタンスのテナントです。
   -u, または --username (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
   -p または --password (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
   -t または --token (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
   -a または --accountName (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
   -A または --accountForApp	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -I または --applicationID (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -S または --applicationSecret (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
   --applicationScope (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
   -o または --organizationUnit	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   -y または --disableTelemetry	テレメトリ データを無効化します。
   --traceLevel	イベントのトレースを表示します。
   --identityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。

例:

• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US
• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization
• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount
• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"

Orchestrator にアセットをデプロイする

前提条件:

• Orchestrator にデプロイするアセットを含む CSV ファイルを作成します。
  CSV ファイルには、name、type、value、description の 4 つの列が必要です。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

CSV ファイルについて詳しくは、以下の例をご覧ください。

name	type	value	説明
asset_1_name	text	"i have a comment"	asset_1_description
asset_2_name	integer	1	asset_2_description
asset_3_name	Bool	false	asset_3_description
asset_4_name	Credential	username:password	asset_4_description

Orchestrator にアセットをデプロイするには、以下の手順を実行します。

1. uipcli asset を使用して asset タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、deploy サブタスクを実行します。

   以下のパラメーターのリストをご覧ください。

   パラメーター	説明
   Assets File (pos. 0) (必須)	削除するアセットが含まれる CSV ファイルの名前です。
   Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	アセットを管理する Orchestrator インスタンスのテナントです。
   -u または --username (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
   -p または --password (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
   -t または --token (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
   -a または --accountName (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
   -A または --accountForApp	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -I または --applicationID (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -S または --applicationSecret (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
   --applicationScope (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
   -o または --organizationUnit	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   -y または --disableTelemetry	テレメトリ データを無効化します。
   --traceLevel	イベントのトレースを表示します。
   --identityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。

例:

• asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US です。
• asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization です。
• asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount です。
• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" です。

Orchestrator 内でジョブを実行する

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

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

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

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

• 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 -P High -j 3 -w false
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json

プロジェクトを分析する

前提条件:

• プロジェクトを作成します。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

1. uipcli package を使用して package タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、analyze サブタスクを実行します。

   以下のパラメーターのリストをご覧ください。

凡例: (*) - 任意。追加のパッケージ フィードを使用する場合は推奨。

パラメーター	説明
Project(s) Path (pos.0) (必須)	project.json ファイルのパス、または複数の project.json ファイルを含むフォルダーのパスです。
--analyzerTraceLevel	分析後に出力するメッセージの種類を選択します。 Off = メッセージを表示しません。 Error -Warning -Info -Verbose.
-stopOnRuleViolation	ルールに違反した場合、ジョブは失敗します。
--treatWarningsAsErrors	警告をエラーとして扱います。
--resultPath	結果を保存する JSON ファイルのフル パスです。 これを引数として追加しない場合、結果は標準コンソールにのみ出力されます。
--ignoredRules	分析時に無視するルールをコンマで区切って列挙したリストです。
--orchestratorUsername (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
--orchestratorPassword (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
-orchestratorAuthToken (*) (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
--orchestratorAccountName (*) (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
--orchestratorAccountForApp (*)	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
--orchestratorApplicationId (*) ( 外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。**アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
--orchestratorApplicationSecret (*) ( 外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
--orchestratorApplicationScope (*) ( 外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
--orchestratorFolder (*)	対象の Orchestrator フォルダーの名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
--orchestratorUrl (*)	Orchestrator インスタンスの URL です。
--orchestratorTenant (*)	マシンを削除する Orchestrator インスタンスのテナントです。
--help	このコマンドのパラメーターと例を表示します。

例:

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"
• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"
• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" --orchestratorUrl "https://orchestratorurl.com" --orchestratorTenant "default" --orchestratorUsername "username" --orchestratorPassword "\_ye5zG9(x" --orchestratorAuthToken "AuthToken" --orchestratorAccountName "AccountName" --orchestratorFolder "OrchestratorFolder"

パッケージを削除する

前提条件:

• パッケージを Orchestrator にパブリッシュします。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

1. uipcli package を使用して package タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、delete サブタスクを実行します。

   以下のパラメーターのリストをご覧ください。

   パラメーター	説明
   Package name (pos. 0) (必須)	削除するパッケージの名前です。
   Orchestrator URL (pos. 1)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos. 2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	マシンを削除する Orchestrator インスタンスのテナントです。
   -u または --username (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
   -p または --password (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
   -t または --token (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
   -a または --accountName (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
   -A または --accountForApp	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -I または --applicationId (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -S または --applicationSecret (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
   --applicationScope (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
   -o または --organizationUnit	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   -y または --disableTelemetry	テレメトリ データを無効化します。
   --traceLevel	イベントのトレースを表示します。
   --identityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
   --help	このコマンドのパラメーターと例を表示します。

例:

• package delete PackageName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US です。
• package delete PackageName "https://uipath-orchestrator.myorg.com" default -t refreshToken -a accountName です。
• package delete PackageName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" です。

Orchestrator にパッケージをデプロイする

前提条件:

• パッケージを作成します。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

1. uipcli package を使用して package タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、deploy サブタスクを実行します。

   以下のパラメーターのリストをご覧ください。

   パラメーター	説明
   Package(s) Path (pos. 0) (必須)	1 つのパッケージ ファイルのパス、または複数のパッケージを含むフォルダーのパスです。
   Orchestrator URL (pos. 1) (必須)	Orchestrator インスタンスの URL です。
   `Orchestrator テナント (位置 2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。`	マシンを削除する Orchestrator インスタンスのテナントです。
   -u または --username (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
   -p または --password (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
   -t または --token (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
   -a または --accountName (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
   -A または --accountForApp	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -I または --applicationId (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -S または --applicationSecret (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
   --applicationScope (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
   -c または --createProcess	true に設定すると、コマンドで渡したプロセスが Orchestrator フォルダー内に作成されます。既定値は True です。 false に設定すると、Orchestrator フォルダー内にプロセスが作成されません。例: --createProcess false.
   -e または --environments (クラシック フォルダーの場合)	パッケージのデプロイ先のロボット グループをコンマで区切って列挙したリストです。 ロボット グループが既定のフォルダー (組織単位) に属していない場合は、ロボット グループの名前にプレフィックスとしてフォルダー名を付ける必要があります。たとえば、ロボット グループが TestEnvironment で、フォルダー名が AccountingTeam である場合は、ロボット グループを AccountingTeam\TestEnvironment として記述します。
   -h または --entryPointsPath	プロセスを作成または更新するために使用するエントリ ポイントを定義します。この値は、プロジェクトのルートから始まるエントリ ポイントのファイル パスです。 クラシック フォルダーで指定できるエントリ ポイントはロボット グループごとに 1 つだけです。
   -o または --organizationUnit	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam/TeamJohn
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   -y または --disableTelemetry	テレメトリ データを無効化します。
   --traceLevel	イベントのトレースを表示します。
   --identityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
   --help	このコマンドのパラメーターと例を表示します。

例:

• package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US です。
• package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" です。
• package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US -h EntryPoint1,EntryPoint2 です。

プロジェクトをパッケージ化する

前提条件:

• プロジェクトを作成します。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

1. uipcli package を使用して package タスクを実行します。利用可能なサブタスクのリストが表示されます。
2. 必要なパラメーターを指定し、pack サブタスクを実行します。

   以下のパラメーターのリストをご覧ください。

凡例: (*) - 任意です。Orchestrator のライブラリとの依存関係がある場合にのみ有効です。

パラメーター	説明
Project(s) Path (pos. 0) (必須)	project.json ファイルのパス、または project.json ファイルを含むフォルダーのパスです。
-o, or --output (Required)	プロジェクトのパッケージ化先の Orchestrator フォルダーです。
-v, or --version	パッケージのバージョンを設定します。
--autoVersion	パッケージのバージョンを自動生成します。
--outputType	特定の種類に出力を強制します。
--libraryOrchestratorUsername (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorPassword (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorAuthToken (*) (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorAccountName (*) (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorAccountForApp (*)	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorApplicationId (*) ( 外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorApplicationSecret (*) ( 外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorApplicationScope (*) ( 外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorFolder (*)	対象の Orchestrator フォルダーの名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
--libraryOrchestratorUrl (*)	Orchestrator インスタンスの URL です。
--libraryOrchestratorTenant (*)	マシンを削除する Orchestrator インスタンスのテナントです。
-y, or --disableTelemetry	テレメトリ データを無効化します。
--traceLevel	イベントのトレースを表示します。
-l, or --language	Orchestrator のユーザー インターフェイスで使用する言語です。
--help	このコマンドのパラメーターと例を表示します。

例:

• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" -v 1.0.6820.22047 です。
• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --autoVersion です。
• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --outputType Tests -l en-US です。

パッケージをテストする/テスト セットを実行する

前提条件:

• パッケージまたはテスト セットを作成する。
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 以下の、Orchestrator API アクセスのアプリケーション スコープを追加します。

  アプリケーション スコープ	説明
  OR.Assets	Orchestrator でのアセットの読み取り/書き込みアクセス権
  OR.BackgroundTasks	Orchestrator でのバックグラウンド タスクの読み取り/書き込みアクセス権
  OR.Execution	Orchestrator での実行の読み取り/書き込みアクセス権
  OR.Folders	Orchestrator でのフォルダーの読み取り/書き込みアクセス権
  OR.Jobs	Orchestrator でのジョブの読み取り/書き込みアクセス権
  OR.Machines.Read	Orchestrator でのマシンの読み取りアクセス権
  OR.Monitoring	Orchestrator での監視の読み取り/書き込みアクセス権
  OR.Robots.Read	Orchestrator での Robot の読み取りアクセス権
  OR.Settings.Read	Orchestrator での設定の読み取りアクセス権
  OR.TestSets	Orchestrator でのテスト セットの読み取り/書き込みアクセス権
  OR.TestSetExecutions	Orchestrator でのテスト セット実行の読み取り/書き込みアクセス権
  OR.TestSetSchedules	Orchestrator でのテスト セットのスケジュールの読み取り/書き込みアクセス権
  OR.Users.Read	Orchestrator でのユーザーの読み取りアクセス権

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

   以下のパラメーターのリストをご覧ください。

   パラメーター	説明
   Orchestrator URL (pos. 0) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos. 1) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	パッケージまたはテスト セットが存在するテナントです。
   -u または --username (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
   -p または --password (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
   -t または --token (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
   -a または --accountName (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
   -A、--accountForApp	Orchestrator Cloud RPA のアカウント名です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -I または --applicationId (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
   -S または --applicationSecret (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
   --applicationScope (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
   -P または --project-path	テストする Testing パッケージ ファイルのパスです。
   -s または --testset	実行するテスト セットに表示される名前です。テスト セットにテスト ケースの最新バージョンが含まれるようにします。 テスト セットが既定のフォルダーに含まれていない場合は、前に適切なフォルダー名を含めてください。例: AccountingTeam\TestSet
   --out	結果を返すファイルの種類です。
   -r または --result_path	結果を保存するファイルの保存先パスです。
   -e または --environment (クラシック フォルダーの場合は必須)	パッケージをデプロイするロボット グループです。project path と組み合わせて使用する必要があります。
   -w または --timeout	テスト セットが実行されるまで待機する時間 (秒) です。既定値は 7200 秒です。
   -i または --input_path (エントリ ポイント ワークフローに、コマンド ラインを介して渡す入力パラメーターがある場合は必須)	JSON 入力ファイルのフル パスです。
   --attachRobotLogs	実行された各テスト ケースのロボット ログと JUnit テスト レポートを添付します。
   -o または --organizationUnit	テスト セットを実行する Orchestrator フォルダーです。
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   -y または --disableTelemetry	テレメトリ データを無効化します。
   --traceLevel	イベントのトレースを表示します。
   --identityURL (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
   --help	このコマンドのパラメーターと例を表示します。

例:

• test run "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -s "MyRobotTests" です。
• test run "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P "C:\UiPath\Project\project.json" -e TestingEnv -r "C:\results.json" --out uipath -l en-US です。
• test run "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P "C:\UiPath\Project\project.json" -e TestingEnv -r "C:\results.json" -i "C:\UiPath\Project\input-params.json" --out uipath -l en-US --attachRobotLogs "true" です。