タスクを実行する

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

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

重要:

UiPath CLI を使用する場合は、Studio でプロジェクトが閉じられていることを確認する必要があります。そうしないと、競合が発生し、CLI に「The action could not be performed because the project is already opened in another Studio instance. Please close it and try again. (操作を実行できませんでした。このプロジェクトは別の Studio インスタンスですでに開かれています。プロジェクトを閉じてから、もう一度お試しください。)」というエラー メッセージが表示されます。

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 でのユーザーの読み取りアクセス権

表に示したスコープに加えて、強調すべき重要なスコープは OR です。デフォルト。OR.既定のスコープはワイルドカードとして機能します。組織レベルとフォルダー レベルの両方で、ロール固有のきめ細かいアクセス権が付与されます。これにより、定義済みの組織全体のスコープを超えて、アプリケーションの権限を柔軟に制御できます。詳細については、「 スコープを宣言する」をご覧ください。

外部アプリケーションを追加する

外部アプリケーションを登録し、そのアプリケーションが OAuth を使用して UiPath リソースにアクセスできるようにするには、以下の手順を実行します。

1. [管理] に移動し、左側のパネルの上部にある組織を選択します。
2. [外部アプリケーション] を選択します。
3. 右上にある [アプリケーションを追加] を選択します。
4. [ アプリケーション名 ] フィールドに入力します
5. [アプリケーションの種類] のオプションを選択します。

   [機密アプリケーション] を選択した場合、最後にアプリケーション シークレットが提供されるので、使用しているアプリケーションでそのシークレットを安全に保存できることを確認してください。それが不可能な場合は [非機密アプリケーション] を選択します。

6. [リソース] で [スコープを追加] を選択します。

   右側に [リソースを編集] パネルが開きます。このパネルでは、アプリケーションにアクセス権を与える必要があるリソースを選択できます。

7. [リソース] ドロップダウン リストから、アプリケーションが使用できる UiPath API を選択します。
   注: スコープは一度に 1 つのリソースに対してのみ追加できます。複数のリソースへのアクセスを許可するには、このプロセスを繰り返して各リソースにスコープを追加します。
8. [ユーザー スコープ] タブで、必要に応じて、付与する論理 API 権限のチェック ボックスを選択します。

   ユーザー スコープに基づく権限付与とは、外部アプリケーションがそれらのリソースにユーザー コンテキスト内でアクセス可能であり、適切な権限を持つユーザーがログインする必要があることを意味します。

9. 機密アプリケーションの場合は、[アプリケーション スコープ] タブに切り替え、必要に応じて、選択したリソースに対するアプリケーション レベルでの権限も付与できます。

   アプリケーション スコープに基づく権限を持つ外部アプリケーションは、ユーザーの操作なしで、選択したスコープのすべてのアプリケーションのデータにアクセスできます。

   非機密アプリケーションは、アプリケーション スコープにアクセスできません。

10. [保存] を選択します。

    パネルが閉じ、フォームの [リソース] の表に、選択したリソースとスコープが追加されます。

11. 外部アプリケーションがユーザー スコープで登録されている場合、その外部アプリケーションが承認応答を受信する [リダイレクト URL] を追加する必要があります。

    アプリケーション スコープだけが選択されている場合、[リダイレクト URL] の指定は任意です。

12. [追加] を選択して登録を作成します。

    確認メッセージが表示されます。機密アプリケーションの場合、確認メッセージには登録済み外部アプリケーションが認可を要求するときに使用できるアプリケーション シークレットが含まれます。アプリケーション シークレットは、その後はもう参照できないので、必ず安全な場所に保存しておいてください。

Running 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 アクセスのアプリケーション スコープを追加します。

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 サブタスクを実行します。

   次の表で、必要なパラメーターについて説明します。

   パラメーター	説明
   -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	このコマンドのパラメーターと例を表示します。
   --version	バージョン情報を表示します。
   Assets File (pos. 0) (必須)	削除するアセットが含まれる CSV ファイルの名前です。
   Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	アセットを管理する Orchestrator インスタンスのテナントです。

使用状況:

 uipcli asset delete <assets_file> <orchestrator_url> <orchestrator_tenant> [-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>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]

最小限のコマンドの例:

• uipcli asset delete "C:\userprofile\assets.csv" 「https://orch-23-10-paas.cloudapp.azure.com/」 "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli asset delete "C:\userprofile\assets.csv" 「https://orch-23-10-paas.cloudapp.azure.com/」 TenantName -I "76000552-3e4f-4590-9317-cdb420001f1d" -s "********" --applicationScope "OR.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "フォルダ名" --traceLevel "情報"
• uipcli asset delete "C:\userprofile\assets.csv" 「https://automation-suite.base.url.com/」 TenantName -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。Monitoring" -o "FolderName" --traceLevel "Information"
• uipcli asset delete "C:\userprofile\assets.csv" 「https://cloud.uipath.com/」 TenantName -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。Monitoring" -o "FolderName" --traceLevel "Information"

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

前提条件:

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

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 サブタスクを実行します。

   次の表で、必要なパラメーターについて説明します。

   パラメーター	説明
   -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 のユーザー インターフェイスで使用する言語です。
   --traceLevel	イベントのトレースを表示します。
   --identityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
   --help	このコマンドのパラメーターと例を表示します。
   --version	バージョン情報を表示します。
   Assets File (pos. 0) (必須)	削除するアセットが含まれる CSV ファイルの名前です。
   Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	アセットを管理する Orchestrator インスタンスのテナントです。

使用状況:

 uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-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>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]

最小限のコマンドの例:

• uipcli asset deploy "C:\userprofile\assets.csv" 「https://orch-23-10-paas.cloudapp.azure.com/」 "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli asset deploy "C:\userprofile\assets.csv" 「https://orch-23-10-paas.cloudapp.azure.com/」 "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -s "********" --applicationScope "OR.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "フォルダ名" --traceLevel "情報"
• uipcli asset deploy "C:\userprofile\assets.csv" 「https://automation-suite.base.url.com/」 "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。Monitoring" -o "FolderName" --traceLevel "Information
• uipcli asset deploy "C:\userprofile\assets.csv" 「https://cloud.uipath.com/」 "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。Monitoring" -o "FolderName" --traceLevel "Information"

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 または --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
   -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 です。
   Process Name (pos.0) (必須)	実行するプロセスの名前です。
   Orchestrator URL (pos.1) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos.2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	プロセスを実行する Orchestrator インスタンスのテナントです。

使用状況:

 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 <Unattended|NonProduction>] [--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.フォルダーまたは。BackgroundTasks またはTestSets またはTestSetExecutions またはTestSetSchedules またはSettings.Read または です。Robots.Read または です。Machines.Read または です。実行 OR.資産 OR.Users.Read OR.Jobs または です。Monitoring" -o "FolderName" --traceLevel "Information"

プロジェクトを分析する

前提条件:

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

プロジェクトを分析するには、次の手順を実行します。

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

   次の表で、必要なパラメーターについて説明します。

注:

プロジェクトの検証は、UiPath CLI のパック タスクや分析タスクでは実行されません。

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

パラメーター	説明
--analyzerTraceLevel	分析後に出力するメッセージの種類を選択します。 Off = メッセージを表示しません。 Error -Warning -Info -Verbose.
-stopOnRuleViolation	ルールに違反した場合、ジョブは失敗します。
--treatWarningsAsErrors	警告をエラーとして扱います。
--resultPath	結果を保存する JSON ファイルのフル パスです。 これを引数として追加しない場合、結果は標準コンソールにのみ出力されます。
--governanceFilePath	ワークフロー アナライザーのルールを含むガバナンス ポリシーを渡します。 ポリシーは Automation Ops ガバナンスからダウンロードするか、 Studio からエクスポートされた圧縮 zip ファイルから抽出できます。 注: ポリシーの使用を指定しても、ポリシー ファイルが上記のパスにない場合、タスクは失敗します。
--ignoredRules	分析時に無視するルールをコンマで区切って列挙したリストです。
-u、 --orchestratorUsername (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。
-p、 --orchestratorPassword (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。
-t、 -orchestratorAuthToken (*) (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。
-a、 --orchestratorAccountName (*) (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。
-A、 --orchestratorAccountForApp (*)	Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
-I、 --orchestratorApplicationId (*) (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。**アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。
-S、 --orchestratorApplicationSecret (*) (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。
--orchestratorApplicationScope (*) (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。
--orchestratorFolder (*)	対象の Orchestrator フォルダーの名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
--orchestratorUrl (*)	Orchestrator インスタンスの URL です。
--orchestratorTenant (*)	マシンを削除する Orchestrator インスタンスのテナントです。
-l、--language	オーケストレーターの言語です。
--traceLevel	イベントのトレースを表示します。
-identityUrl (PaaS デプロイの場合のみ必須 )	Identity Server の URL です。
--disableBuiltInNugetFeeds	組み込みの NuGet フィードを無効化します。
Project(s) Path (pos.0) (必須)	project.json ファイルのパス、または複数の project.json ファイルを含むフォルダーのパスです。

使用状況:

 uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]

最小限のコマンドの例:

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://automation-suite.base.url.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://cloud.uipath.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName"

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

前提条件:

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

パッケージを Orchestrator にデプロイするには、次の手順に従います。

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

   次の表で、必要なパラメーターについて説明します。

   パラメーター	説明
   -c または --createProcess	の既定値は trueです。 true に設定すると、コマンドで渡したプロセスが Orchestrator フォルダー内に作成されます。 false に設定すると、Orchestrator フォルダー内にプロセスが作成されません。例: --createProcess false.
   --processNames	必要に応じて、 を指定します.csv 作成/更新するプロセスのカスタム名を含むファイル。 次に、.csv 構造は次のようになります。 列名/ヘッダーは、 PackageName、EntryPointName 、 ProcessName です。 PackageName EntryPointName プロセス名 マイパッケージ Main.xaml マイ プロセス YetAnotherPackage (まだ別のパッケージ) CustomEntryPoint.xaml YetAnotherProcess (まだ別のプロセス)
   --processName	必要に応じて、更新/作成するプロセスのカスタム名を指定します。
   --ignoreLibraryDeployConflict	既存のバージョンと同じバージョンのライブラリ パッケージをデプロイする場合は、競合を無視してください。 既定では、同じバージョンのライブラリが Orchestrator インスタンスに既に存在する場合、デプロイは失敗します。
   -e または --environments (クラシック フォルダーの場合)	パッケージのデプロイ先のロボット グループをコンマで区切って列挙したリストです。 ロボット グループが既定のフォルダー (組織単位) に属していない場合は、ロボット グループの名前にプレフィックスとしてフォルダー名を付ける必要があります。たとえば、ロボット グループが TestEnvironment で、フォルダー名が AccountingTeam である場合は、ロボット グループを AccountingTeam\TestEnvironment として記述します。
   -h または --entryPointsPath	プロセスを作成または更新するために使用するエントリ ポイントを定義します。この値は、プロジェクトのルートから始まるエントリ ポイントのファイル パスです。 クラシック フォルダーで指定できるエントリ ポイントはロボット グループごとに 1 つだけです。
   -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, or --organizationUnit (Required)	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam/TeamJohn
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   -y または --disableTelemetry	テレメトリ データを無効化します。
   --traceLevel	イベントのトレースを表示します。
   --identityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
   Package(s) Path (pos. 0) (必須)	1 つのパッケージ ファイルのパス、または複数のパッケージを含むフォルダーのパスです。
   Orchestrator URL (pos. 1) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator テナント (位置 2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	マシンを削除する Orchestrator インスタンスのテナントです。

エントリ ポイントを指定しない場合、uipcli により、default エントリ ポイントを持つプロセスが作成されます。エントリ ポイントを指定した場合は、そのエントリ ポイントを持つプロセスが作成され、プロセス名に _{entryPoint} が付加されます。さらに、プロセスが手動で作成されたか、パイプラインから作成されたかにかかわらず、package.Id に関連付けられているすべてのプロセスが最新バージョンに更新されます。

使用状況:

 uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-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>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

最小限のコマンドの例:

• uipcli package deploy "C:\userprofile\AutomationPackages" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml"n

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --processNames "C:\userprofile\processNames.csv"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml" --processName "MyProcessName"

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

前提条件:

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

プロジェクトをパッケージにまとめるには、次の手順を実行します。

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

   次の表で、必要なパラメーターについて説明します。

注:

プロジェクトの検証は、UiPath CLI のパック タスクや分析タスクでは実行されません。

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

パラメーター	説明
-o または --output (必須)	プロジェクトのパッケージ化先の Orchestrator フォルダーです。
-v または --version	パッケージのバージョンを設定します。
--autoVersion	パッケージのバージョンを自動生成します。
--outputType	特定の種類に出力を強制します。
--splitOutput	ランタイムライブラリとデザインライブラリへの出力分割を可能にします。
--repositoryUrl	プロジェクトのバージョン管理が行われるリポジトリ URL です。
--repositoryCommit	プロジェクトのビルド元のリポジトリ コミット。
--repositoryBranch	プロジェクトの構築元のリポジトリブランチ。
--repositoryType	VCS システム リポジトリの種類。
--projectUrl	Automation Hub のアイデアの URL
--releaseNotes	リリース ノートを追加する
-u、 --libraryOrchestratorUsername (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するユーザー名です。対応するパスワードと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
-p、 --libraryOrchestratorPassword (*) (ユーザー名とパスワードによる基本認証を使用する場合は必須)	Orchestrator への認証に使用するパスワードです。対応するユーザー名と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
-t、 --libraryOrchestratorAuthToken (*) (トークンベースの認証を使用する場合は必須)	Orchestrator への認証に使用する OAuth2 更新トークンです。アカウント名およびクライアント ID と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
-a、 --libraryOrchestratorAccountName (*) (トークンベースの認証を使用する場合は必須)	Orchestrator Cloud RPA のアカウント名です。OAuth2 更新トークンおよびクライアント ID と組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
-A、 --libraryOrchestratorAccountForApp (*)	Orchestrator Cloud RPA のアカウント名 (組織名) です。外部アプリケーションのアプリケーション ID、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
-I 、--libraryOrchestratorApplicationId (*) (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション ID です。アプリケーション アカウント、アプリケーション シークレット、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
-S、 --libraryOrchestratorApplicationSecret (*) (外部アプリケーション認証を使用する場合は必須)	外部アプリケーション シークレットです。アプリケーション アカウント、アプリケーション ID、アプリケーション スコープと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorApplicationScope (*) (外部アプリケーション認証を使用する場合は必須)	アプリケーション スコープを単一のスペースで区切って列挙したリストです。外部アプリケーションのアプリケーション アカウント、アプリケーション ID、アプリケーション シークレットと組み合わせて使用する必要があります。 パッケージで Orchestrator フィードのライブラリを参照する場合、必須です。
--libraryOrchestratorFolder (*)	対象の Orchestrator フォルダーの名前です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
--libraryOrchestratorUrl (*)	Orchestrator インスタンスの URL です。
--libraryOrchestratorTenant (*)	マシンを削除する Orchestrator インスタンスのテナントです。
--libraryIdentityUrl (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
--traceLevel	イベントのトレースを表示します。
-l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
--disableBuiltInNugetFeeds	組み込みの NuGet フィードを無効にします。
Project(s) Path (pos. 0) (必須)	project.json ファイルのパス、または project.json ファイルを含むフォルダーのパスです。

使用状況:

 uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]

例:

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

オートメーションの依存関係を復元する

前提条件:

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

依存関係を復元するには、次の手順を実行します。

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

   次の表で、必要なパラメーターについて説明します。

   パラメーター	説明
   --restoreFolder	必須。 復元先のフォルダパス。
   --nugetConfigFilePath	随意。 フィードを含む NuGet.Config ファイルへのパスです。
   -u、--libraryOrchestratorUsername	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 認証に使用する Orchestrator のユーザー名。 パスワードと一緒に使用する必要があります。
   -p、--libraryOrchestratorPassword	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 認証に使用する Orchestrator のパスワードです。 ユーザー名と一緒に使用する必要があります。
   -t、--libraryOrchestratorAuthToken	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 認証に使用される Orchestrator 更新トークンです。 組織名およびクライアント ID と一緒に使用する必要があります。
   -a、--libraryOrchestratorAccountName	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 Orchestrator の組織名。 更新トークンおよびクライアント ID と一緒に使用する必要があります。
   -A、--libraryOrchestratorAccountForApp	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 Orchestrator の組織名。 外部アプリケーションの ID、シークレット、スコープと共に使用する必要があります。
   -I、--libraryOrchestratorApplicationId	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 外部アプリケーション ID です。 外部アプリケーションの組織名、シークレット、スコープと共に使用する必要があります。
   -S、--libraryOrchestratorApplicationSecret	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 外部アプリケーションのシークレットです。 外部アプリケーションの組織名、ID、およびスコープと共に使用する必要があります。
   --libraryOrchestratorApplicationScope	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 スペースで区切られたアプリケーション スコープのリストです。 外部アプリケーションで、組織名、ID、シークレットと一緒に使用する必要があります。
   --libraryOrchestratorUrl	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 Orchestrator の URL です。
   --libraryOrchestratorTenant	任意です。Orchestrator のライブラリからの依存関係がある場合にのみ便利です。 Orchestrator テナントです。
   --libraryIdentityUrl	Identity Server の URL です。 これは、PaaS のデプロイでのみ必要です。
   --traceLevel	出力するログ メッセージの種類を指定します。[None]、[Critical]、[Error]、[Warning]、[Information]、[Verbose] のいずれかの値を指定できます。 既定値は Information です。
   -l、--language	翻訳されたログの言語。
   --disableBuiltInNugetFeeds	組み込みの NuGet フィードを無効にします。
   Project(s) Path (pos. 0)	必須。project.json ファイルのパス、または project.json ファイルを含むフォルダーのパスです。

使用状況:

 uipcli package restore <project_path> --restoreFolder <restore_directory> --nugetConfigFilePath <nuget_config_path> [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]

最小限のコマンドの例:

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder ""C:\userprofile\DependencyPackages" --nugetConfigFilePath "C:\userprofile\Package\NuGet.Config"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

• uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"

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

前提条件:

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

パッケージをテストするには、次の手順を実行します。

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

   次の表で、必要なパラメーターについて説明します。

   パラメーター	説明
   -P または --project-path	テストする Testing パッケージ ファイルのパスです。
   -s または --testset	実行するテスト セットに表示される名前です。 テスト セットにテスト ケースの最新バージョンが含まれるようにします。テスト セットが既定のフォルダーに含まれていない場合は、前に適切なフォルダー名を含めてください。 例: AccountingTeam\TestSet
   --out	結果ファイルの種類 <junit|uipath> です。
   -r または --result_path	結果を保存するファイルの保存先パスです。
   -e または --environment (クラシック フォルダーの場合は必須)	パッケージをデプロイするロボット グループです。project path と組み合わせて使用する必要があります。
   -w または --timeout	テスト セットが実行されるまで待機する時間 (秒) です。既定値は 7200 秒です。
   -i または --input_path (エントリ ポイント ワークフローに、コマンド ラインを介して渡す入力パラメーターがある場合は必須)	JSON 入力ファイルのフル パスです。
   --attachRobotLogs	実行された各テスト ケースのロボット ログと JUnit テスト レポートを添付します。
   --repositoryUrl	プロジェクトのバージョン管理が行われるリポジトリ URL です。
   --repositoryCommit	プロジェクトのビルド元のリポジトリ コミット。
   --repositoryBranch	プロジェクトの構築元のリポジトリブランチ。
   --repositoryType	VCS システム リポジトリの種類。
   --projectUrl	Automation Hub のアイデアの URL
   --releaseNotes	リリース ノートを追加する
   --disableBuiltInNugetFeeds	組み込みの NuGet フィードを無効化します。
   --retryCount	失敗したテスト ケースのリトライ回数 (既定では、リトライは設定されていません)。
   -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 フォルダーです。
   -l または --language	Orchestrator のユーザー インターフェイスで使用する言語です。
   --traceLevel	イベントのトレースを表示します。
   --identityURL (PaaS デプロイの場合のみ必須)	Identity Server の URL です。
   Orchestrator URL (pos. 0) (必須)	Orchestrator インスタンスの URL です。
   Orchestrator Tenant (pos. 1) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	パッケージまたはテスト セットが存在するテナントです。

使用状況:

 uipcli test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <project_json_path>] [-s <testset_name>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-e <environment>] [-o <folder_name>] [-l <language>] [--out <junit|uipath>] [--result_path <result_path>] [--timeout <seconds>] [--attachRobotLogs true] repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--retryCount <number>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

例:

• uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

Testing multiple packages

前提条件:

• Create multiple packages or test sets.
• CLI の exe ファイル (Windows の場合) または dll ファイル (Linux の場合) を実行します。
• 必要な Orchestrator API アクセスのアプリケーション スコープを追加します。

To test multiple packages, take the following steps:

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

   次の表で、必要なパラメーターについて説明します。

   パラメーター	説明
   --testsConfigurationFilePath	Required. Path to file with test projects configurations. This configuration outlines the list of projects that you want to package and then execute in parallel, with certain execution options. Each project can be configured with the following options: ProjectPath: The path to the project on the agent running the task. This can be a relative or absolute path. AttachRobotLogs: If set to true, the robot logs will be included in the test report file. ContinueOnError: Determines if the pipeline task should fail in the event of associated test failures. RetryCount: The number of retry attempts per test project. Timeout: Timeout per test project in seconds (default is 7200). ParametersFilePath: The path to a JSON file that contains input parameters for the test. This is similar to the parameters file used for the UiPathTest task. Test package metadata: ReleaseNotes RepositoryUrl RepositoryCommit RepositoryBranch RepositoryType ProjectUrl This configuration can also be formatted in JSON or CSV. JSON schema example: [ { "ProjectPath": "path/to/project", "AttachRobotLogs": true, "ContinueOnError": false, "RetryCount": 3, "Timeout": 7200, "ParametersFilePath": "path/to/parameters.json", "ReleaseNotes": "release notes for the test project", "RepositoryUrl": "http://repositoryurl.com", "RepositoryCommit": "commit hash", "RepositoryBranch": "branch name", "RepositoryType": "git", "ProjectUrl": "http://projecturl.com" }, { "ProjectPath": "path/to/project2" }, { "ProjectPath": "path/to/project3", "ParametersFilePath": "path/to/parameters3.json", } ] CSV example: ProjectPath,AttachRobotLogs,ContinueOnError,RetryCount,Timeout,ParametersFilePath,ReleaseNotes,RepositoryUrl,RepositoryCommit,RepositoryBranch,RepositoryType,ProjectUrl path/to/project,true,false,3,7200,path/to/parameters.json,release notes for the test project,http://repositoryurl.com,commit hash,branch name,git,http://projecturl.com path/to/project2,,,,,,,,,,, path/to/project3,,,,,path/to/parameters3.json,,,,,,
   --projectsRootDirectoryPath	Path to the root directory of projects to be tested. Required when projectPaths from the testsConfigurationFile are relative.
   --executionArtifactsDirectoryPath	Directory path where to publish test execution artifacts.
   --cliDirectoryPath	Path to the CLI directory or uipcli.dll. Required if executing CLI through the dotnet executable, optional when executing uipcli.exe.
   --out	Required. Type of the result file <junit|uipath>.
   --disableBuiltInNugetFeeds	Disable built in nuget feeds used at test projects packing.
   -u, --username	Required. The Orchestrator username used for authentication. Must be used together with the password.
   -p, --password	Required. The Orchestrator password used for authentication. Must be used together with the username.
   -t, --token	Required. The Orchestrator refresh token used for authentication. Must be used together with the account name and client id.
   -a, --accountName	Required. The Orchestrator organization name. Must be used together with the refresh token and client id.
   -A, --accountForApp	The Orchestrator organization name. Must be used together with id, secret and scope(s) for external application.
   -I, --applicationId	Required. The external application id. Must be used together with organization name, secret and scope(s) for external application.
   -S, --applicationSecret	Required. The external application secret. Must be used together with organization name, id and scope(s) for external application.
   --applicationScope	Required. The space-separated list of application scopes. Must be used together with organization name, id and secret for external application.
   -o, --organizationUnit	The Orchestrator folder name.
   -l, --language	翻訳されたログの言語。
   --traceLevel	Specifies what types of log messages to output One of the following values: None, Critical, Error, Warning, Information, Verbose. (default is Information).
   --identityUrl	Identity Server の URL です。 これは、PaaS のデプロイでのみ必要です。
   Orchestrator URL(pos. 0)	Required. The URL of the Orchestrator instance.
   Orchestrator Tenant(pos. 1)	The tenant of the Orchestrator instance.

使用状況:

 ./uipcli.exe test parallel <orchestrator_url> <orchestrator_tenant> [--testsConfigurationFilePath <tests_config_file_path>] [--projectsRootDirectoryPath <test_projects_root_directory_path>] [--executionArtifactsDirectoryPath <execution_artifacts_directory_path>] [--cliDirectoryPath <uipcli_dll_path>] [-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>] [--out <junit|uipath>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

例:

• ./uipcli.exe test parallel "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --testsConfigurationFilePath "C:\userprofile\pipeline-repo-folder\test-configuration.json" --projectsRootDirectoryPath "C:\userprofile\test-projects-repo-folder" --executionArtifactsDirectoryPath "C:\userprofile\pipeline-execution-folder" --cliDirectoryPath "C:\userprofile\cli-download-path\UiPath.CLI.Windows\tools\uipcli.dll" --out "junit"

• ./uipcli.exe test parallel "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --testsConfigurationFilePath "C:\userprofile\pipeline-repo-folder\test-configuration.json" --projectsRootDirectoryPath "C:\userprofile\test-projects-repo-folder" --executionArtifactsDirectoryPath "C:\userprofile\pipeline-execution-folder" --cliDirectoryPath "C:\userprofile\cli-download-path\UiPath.CLI.Windows\tools\uipcli.dll" --out "junit" "C:\userprofile\AutomationProjectWithTestCases\project.json"

• ./uipcli.exe test parallel "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 --testsConfigurationFilePath "C:\userprofile\pipeline-repo-folder\test-configuration.json" --projectsRootDirectoryPath "C:\userprofile\test-projects-repo-folder" --executionArtifactsDirectoryPath "C:\userprofile\pipeline-execution-folder" --cliDirectoryPath "C:\userprofile\cli-download-path\UiPath.CLI.Windows\tools\uipcli.dll" --out "junit"

• ./uipcli.exe test parallel "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 --testsConfigurationFilePath "C:\userprofile\pipeline-repo-folder\test-configuration.json" --projectsRootDirectoryPath "C:\userprofile\test-projects-repo-folder" --executionArtifactsDirectoryPath "C:\userprofile\pipeline-execution-folder" --cliDirectoryPath "C:\userprofile\cli-download-path\UiPath.CLI.Windows\tools\uipcli.dll" --out "junit"