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

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

前提条件

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

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

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

パラメーター	説明
Package(s) Path (pos. 0) (必須)	1 つのパッケージ ファイルのパス、または複数のパッケージを含むフォルダーのパスです。
Orchestrator URL (pos. 1) (必須)	Orchestrator インスタンスの URL です。
Orchestrator Tenant (pos. 2)	The tenant of the Orchestrator instance where you want to deploy the package. Required when targeting Automation Cloud. Optional for Automation Suite and standalone Orchestrator (on-premises MSI), where the tenant is part of the URL.
-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	必要に応じて、更新/作成するプロセスのカスタム名を指定します。
--processDescription	[プロセスの説明] を指定した値に設定します。他のどの説明ソースよりも優先されます。
--use-package-description	パッケージの説明をプロセスの説明として使用してください。作成時は、これが既定の動作です。更新時に、既存のプロセスの説明がパッケージの説明で上書きされます。
--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	The URL of your identity server. Required when the Orchestrator runs on UiPath Automation Suite or standalone Orchestrator (on-premises MSI). Not needed for Automation Cloud — the CLI resolves the identity server from the cloud URL.
--ca-cert	Orchestrator と Identity Server の TLS 証明書を検証する際に使用される、1 つ以上の信頼されたルート CA 証明書ファイル (PEM、DER、または PKCS#7)。フラグを繰り返すか、複数のパスをコンマで区切ります。詳細については、「 カスタム証明書を信頼する 」をご覧ください。
--pinnedpubkey	サーバー リーフ証明書の公開キーをピン留めします。形式: sha256//<base64>です。標準の証明書検証に加えてチェックされます。詳細については、「 カスタム証明書を信頼する 」をご覧ください。

ヒント:

プライベート証明機関 (UiPath Automation Suite など) によって署名された Orchestrator インスタンスの場合、このコマンドは --ca-cert パラメーターと --pinnedpubkey パラメーターも受け付けます。シナリオと例については、「 カスタム証明書を信頼する 」をご覧ください。

注:

--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 package deploy "C:\packages\MyPackage.nupkg" "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S 'mySecret$123' -o "MyFolder"

# Incorrect - double quotes allow variable expansion
uipcli package deploy "C:\packages\MyPackage.nupkg" "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S "mySecret$123" -o "MyFolder"

エントリ ポイントを指定しない場合、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>] [--processDescription <description>] [--use-package-description] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Minimal command examples

• 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"