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

CLI を使用して Orchestrator に UiPath パッケージをデプロイするための前提条件と手順。

前提条件

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

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

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

パラメーター	説明
-c, or --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 (クラシック フォルダーの場合)	パッケージをデプロイする環境をコンマで区切ったリスト。 環境が既定のフォルダーに属していない場合は、環境の前にフォルダー名を付けます。例: AccountingTeam\\TestEnvironment
-h, or --entryPointsPath	プロセスを作成または更新するための特定のエントリ ポイントを定義します。これは、プロジェクトのルートから開始するエントリ ポイントのファイル パスです。 クラシック フォルダーの場合、1 つの環境につき 1 つのエントリ ポイントのみ指定できます。
-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、または --organizationUnit (プロセス パッケージの場合は必須 )	Orchestrator フォルダー (組織単位) の名前です。 サブフォルダーを入力するには、親フォルダー名とサブフォルダー名の両方を含めます。例: AccountingTeam/TeamJohn。
-l, or --language	Orchestrator のユーザー インターフェイスで使用する言語です。
-y, or --disableTelemetry	テレメトリ データを無効化します。
--traceLevel	イベントのトレースを表示します。
--identityUrl (PaaS または MSI デプロイに必要 )	Identity Server の URL です。
Package(s) Path (pos. 0) (必須)	1 つのパッケージ ファイルのパス、または複数のパッケージを含むフォルダーのパスです。
Orchestrator URL (pos. 1) (必須)	Orchestrator インスタンスの URL です。
Orchestrator テナント (位置 2) (必須) SaaS デプロイの場合。 (任意) PaaS デプロイの場合。	マシンを削除する Orchestrator インスタンスのテナントです。

注:

-o / --organizationUnit is required only when you deploy a process package with process creation enabled, which is the default. Omit it to target the tenant feed, which is the expected form for library packages and for any package deployed with --createProcess false. If you omit it for a process package, the CLI uploads the package to the tenant feed and then fails with Can not create process(es) in Orchestrator: no folder specified.

エントリ ポイントを指定しない場合、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"