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 です。

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

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

1. テナントに管理者としてログインします。
2. [テナント] > [アクセス権を管理] > [ロールを割り当て] に移動して、[アカウントおよびグループを管理] をクリックします。

   テナント レベルが開きます。

3. 左側の [外部アプリケーション] を選択します。

   現在のテナントに登録されている、すべての既存外部アプリケーションのリストが [外部アプリケーション] ページに表示されます。

   
   

   

   
   
4. 表の上で、右側にある [アプリケーションを追加] をクリックします。
5. [アプリケーション名] フィールドに入力します。
6. [アプリケーションの種類] のオプションを選択します。

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

7. [リソース] で [スコープを追加] をクリックします。

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

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

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

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

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

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

11. [保存] をクリックします。

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

12. 外部アプリケーションが対応している場合、[リダイレクト URL] フィールドに URL を追加すると、認可応答がその URL に送信され、アプリケーションがその URL を使用して UiPath リソースにアクセスできるようになります。
13. [追加] をクリックして登録を作成します。

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