orchestrator

2022.4

false

リリースノート

重要 :

このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。

Orchestrator リリースノート

デリバリー:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated 2024年10月17日

2022.4

公開日: 2022 年 5 月 23 日

更新内容

タグを使用してリソースを整理する

リソースの分類には手間がかかります。企業内のすべてのユーザーに対してリソース間の依存関係を確認しやすくし、それらのリソースの使い方を理解しやすくすることは重要です。たとえば、アセットを変更したりキューを削除したりすると、実行中のプロセスが影響を受け、気づかないうちにプロセスがクラッシュする可能性があります。

利用するロボットの台数が増えると、消費・管理するリソースの数も増えます。その結果、ビジネスにおいて以下のような重要な課題に直面することがあります。

様々なオブジェクトが互いにどう作用するのかを把握することが難しい
手作業の負荷が増える。たとえば、Excel スプレッドシートのようなオブジェクト間の依存関係を分類・追跡するために、面倒な作業を手動で行う必要が出てくる
プロセスの実行などの操作が、他のリソースにどう影響するのかを可視化できない
特定のアプリがどのプロセスによって自動化されているのか確認しづらいため、自動化対象のアプリケーションをアップグレードすることで発生するダウンタイムを可視化できない

このため、以下のような領域でタグの機能が役立ちます。

開発者の生産性の向上: 開発者が自身の開発業務に関連するリソースを特定しやすくなります。このため、開発の影響を受けるプロセスの部分的なリソースを時間をかけて探す必要がなくなり、価値の高い作業に集中できます。
管理者の生産性の向上: 組織全体で一貫性のあるタグ構造を採用することで、統一的な分類方法を導入できます。これにより、すべてのユーザーがすばやくリソースを見つけられるようになります。

タグ付けは、現在は Orchestrator の複数のリソースと Action Center のアクションで利用できます。タグ付けできるオブジェクトのリストはこちらからご確認ください。

注: この機能には v2022.4 以降の Studio が対応しています。

既知の問題

v2021.4 以前の [アセットを設定] および [資格情報を設定] アクティビティを使用すると、アセットからタグが削除されます。

インストールとアップグレードに関する考慮事項

この機能は、オンプレミスのどちらの提供形態 (Automation Suite/スタンドアロン) でもリソースカタログの一部として利用できます。

Automation Suite の場合、この新しいサービスの設定はすべてシステムの裏側で行われるため、インストールや構成のことを考慮する必要はありません。

スタンドアロンの Orchestrator の場合、Azure App Service のインストールを有効化するのであれば、リソースカタログが提供する機能のメリットを確実に享受するために、いくつかの追加手順を踏む必要があります。この時に役立つ 2 つの新しいスクリプト (Publish-ResourceCatalog.ps1 と MigrateTo-ResourceCatalog.ps1) を導入しました。詳しくは、「Azure App Service のインストール」をご覧ください。

テナントのグローバル検索

テナント内のリソースを検索できるグローバル検索機能を追加しました。この機能では、テナント内のフォルダー/テナント両方の範囲のリソースを検索できます。検索機能は現在、キュー、アセット、バケット、マシンオブジェクト、プロセス、トリガー、アクションカタログに対して使用できます。

検索機能にアクセスするには、任意のページの右上隅にある検索アイコンを選択します。

既知の問題:

グローバルな検索ページからオブジェクトを編集しようとすると、フォルダーの表示権限またはサブフォルダーの表示権限が不適切に要求されます。

OAuth 2.0 ベースのフレームワークを使用したロボットの認証

今回のリリースでは、OAuth 2.0 フレームワークを認証プロトコルの基盤として使用する、新しいロボット認証メカニズムを実装しました。Unattended ロボットが Orchestrator に接続する際に、マシンテンプレートオブジェクトを介して生成されたクライアント ID とクライアントシークレットのペアを使用することができます。クライアント ID とクライアントシークレットのペアで生成したトークンによって接続が認可され、Orchestrator リソースへのアクセス権がロボットに付与されます。

クライアント資格情報を使用すると、ロボットはユーザーを偽装することなく、自身の資格情報を用いてリソースにアクセスできます。ロボットが Orchestrator からリソースを要求する際は、認証にユーザーが関与しないため、操作を実行するための認可がロボット自体に付与されている必要があります。

ロボットの認証について詳しくは、こちらをご覧ください。

管理者向けの、クライアント資格情報の管理方法 (新しい資格情報の作成、アクセス権の取り消し) については、こちらをご覧ください。

RPA 開発者および有人オートメーションを使用するユーザー向けの、Robot を Orchestrator に接続する手順について詳しくは、こちらをご覧ください。

個人用ワークスペーステンプレートのマシンキーが非表示に

個人用ワークスペースのマシンテンプレートのマシンキーが、API 経由と Orchestrator のユーザーインターフェイス経由で表示されないようにしました。つまり、ロボットを Orchestrator に接続するにはサインインする必要があります。

[切断] および [応答なし] ステータスの無人セッションを削除する

[切断] および [応答なし] ステータスの無人セッションを削除できるようになりました。未使用のセッションをクリーンアップして接続中のセッションのみを表示できるため、管理者はセッションに関して必要な情報を把握しやすくなります。

無人セッションを 1 つずつ削除するには、[テナント] > [ロボット] > [無人セッション] に移動し、削除したい未接続状態のセッションの [その他のアクション] > [削除] をクリックします。一度に複数のセッションを削除するには、削除対象のセッションを選択して [削除] アイコンをクリックします。

60 日を超える無人セッションを Sessions テーブルからすべて削除するには、公式ドキュメントに記載されたデータベースメンテナンス用のスクリプトを使用できます。

[切断] および [応答なし] ステータスの無人セッションを削除する方法について詳しくは、こちらをご覧ください。

新しい資格情報ストア

Orchestrator の資格情報を保存できるプラグインの選択肢を増やしました。今回 Orchestrator と連携した資格情報ストアは次の 3 つです。「HashiCorp Vault」、「BeyondTrust」、「Azure Key Vault (読み取り専用)」

S3 互換ストレージ

Orchestrator で S3 互換ストレージをプラグアンドプレイで利用できるようになりました。優れたスケーラビリティ、低コスト、高い信頼性といった S3 のメリットを享受できます。

S3 互換ストレージプロバイダーを有効化し、Orchestrator でストレージバケットを作成する方法について詳しくは、こちらをご覧ください。

ストレージバケットを作成・設定する方法について詳しくは、こちらをご覧ください。

AIM Web サービス名のカスタマイズ

Central Credential Provider Web サービスにカスタム名を付けられるようになりました。カスタム名は、CyberArk CCP 資格情報ストアを設定する際に利用できる新しいフィールド [Web サービス名] で設定できます。このフィールドを空のままにすると、既定の名前 (AIMWebService) が使用されます。

組織レベルでの SAML 連携

この連携により、Okta や PingOne など、SAML 2.0 標準をサポートするサードパーティの ID プロバイダー (IdP) に Automation Suite を接続できます。

この連携はこれまでもホストレベルで利用できましたが、今回からは組織レベルでも有効化できるようになりました。

SAML モデルを使用した認証について | SAML 連携を設定する (組織向け)

重要: リリースノートの誤記について (2022 年 6 月 22 日): 新しいパラメーター -NoAzureAuthentication が、Orchestrator のスクリプト、Identity Server のスクリプト、Webhook のスクリプト、リソースカタログのスクリプトに追加されています。このパラメーターを使用すると、サービスプリンシパルを作成することなくユーザー自身の ID で Azure App Service にパブリッシュを行えます。

改良点

監視

フォルダーのリソースを一元化された場所から監視

テナントレベルの一元化された場所から、すべてのフォルダーのリソースの状態を監視できるようになりました。新しくなった [監視] ページには、特定のディメンション (例: マシン) ごとにグループ化されたダッシュボードのセットが表示されます。このため、システム内のデータを可視化できます。

テナントレベルの監視ダッシュボードには、ユーザーがアクセス権を持つすべてのフォルダーおよび個人用ワークスペースのデータが集約されて表示されます。このため、この新機能のデザインや挙動は、これまでフォルダーレベルで提供されていた監視機能を元に開発されています。

また、すべての監視機能を 1 か所にまとめるために、Orchestrator の UI に変更を数点加える必要がありました。このため、以下のページやウィジェットをテナントレベルの新しい監視ページに移動しました。

[無人セッション] ページと [ユーザーセッション] ページ (以前は [テナント] > [ロボット] に存在)
[ロボットの使用状況] ウィジェット (以前は [テナント] > [ライセンス] に存在)

プロセスを監視する際の新しいフィルターオプション

プロセスの監視ダッシュボードで、より長い期間のデータを絞り込めるようにしました。具体的には、1 か月 (過去 30 日) と 1 週間 (過去 7 日間) です。以前のオプションは、過去 1 時間または過去 1 日のみでした。

フィルター設定の保持

以前は、[監視] ページのダッシュボードで選択したフィルターの設定が保持されませんでした。このため、タブを切り替えるたびに設定をし直す必要がありました。今回のリリースからは、一度ダッシュボードから離れて戻って来ても、フィルター設定が保持されます。

自動化

Orchestrator では、保留中のジョブが溜まらないように、ジョブの実行を自動的に停止または強制終了するスケジュール設定オプションを利用できます。今回のリリースでは、このオプションを、[タイムトリガー] ページに加え [ジョブを開始] ページおよび [キュートリガー] ページでも利用できるようにしました。

ジョブの実行の終了をスケジュール設定するオプションについて詳しくは、「ジョブを管理する」ページおよび「トリガーを管理する」ページの「キュートリガーを作成する」セクションをご覧ください。
キューのトランザクションを、トランザクションを処理したロボット (ユーザーアカウントまたはロボットアカウント) で絞り込めるようになりました。ロボット フィルターのドロップダウンメニューを展開すると、該当するモダンフォルダーに存在するロボットが表示されます。フォルダー内のロボットを表示するには、ユーザーに対する [表示] 権限が必要です。

トリガーでのホスト名のマッピング

最近トリガーに導入された、アカウント/マシン/ホスト名のマッピング機能では、ジョブの実行をスケジュールする際にテンプレートから特定のマシンを選択できるようになりました。ジョブをスムーズに実行するために、特定のホスト名 (ワークステーション) に備わっているリソース (ライセンス、ソフトウェア、ユーザー設定、権限) が必要な場合は、ホスト名を選択する必要があります。ホスト名はトリガーの実行ターゲットの一部として選択でき、動的に割り当てるか、有効なアカウントとマシンのマッピングに手動で追加することができます。これは、ジョブに対してホスト名を選択する方法と全く同じです。

ただし、トリガーに対してホスト名を選択する場合はジョブの作成時と比較して以下のような相違点があります。

ジョブでは接続済みのマシンのみが選択できますが、トリガーでは利用可能なテンプレートのホスト名をすべて選択できます。
既存のトリガーを複製してホスト名を追加することで、実行のキューで待機するジョブをもう一つ追加できます。

プロセスの作成完了フローの変更

これまで、新しく作成したプロセスを実行するには [ジョブ] ページまたは [プロセス] ページに移動する必要がありました。また、プロセスのトリガーをスケジュールするには、[トリガー] ページに移動する必要がありました。

今回のリリースでは、単一の操作フローでプロセスの作成を完了できるオプションを追加しました。具体的には、プロセスの作成後に、同じページ上で 1 クリックでジョブを開始したり、トリガーを作成したりできるようになりました。このため、[オートメーション] ページ内を移動する必要がなくなりました。

暗号化

今回のリリースからは、新しく作成されるすべての種類のアセットが既定で暗号化されるようになりました。このため、データを安全に保つことができます。また、新しく作成するキューや、新しく作成するアクションカタログにリンクされたアクションを暗号化できるオプションも追加しました。ただし、暗号化の設定は過去にさかのぼっては適用されません。

以下の列が、それに対応するデータベーステーブルで暗号化されます。

データベーステーブル	暗号化される列	暗号化の方法
QueueItems	固有データ出力	任意 (UI から設定) キューを作成する
AssetValues	値 (Value)	既定
タスク (アクションのこと)	データ (アクションカタログのこと)	任意 (UI から設定) 新しいアクションカタログを追加する

ロールと権限

Orchestrator では既定のロールが数種類用意されています。既定ロールによって、主なユースケースに対応したアクセス権の割り当てを簡単に行うことができ、Orchestrator の環境を利用し始めたばかりの新規ユーザーにとっては機能の基盤としての役割を果たします。ユーザーはまずエコシステムに慣れ、自動化の特定のユースケースを理解し、その後で既定のロールを編集したり、ニーズに合わせて新しいロールを作成したりできます。

しかし、既定のロールの権限の組み合わせも基準として使えるよう、いつでも利用できるようにしておく必要があると考えました。

このため、特にモダンフォルダーの既定ロールとその権限に対して、いくつかの改良を行いました。

既定のロールの追加作業が不要に

Orchestrator の設定画面から既定のロールをテナントに追加することなく、ロールを既定で利用できるようになりました。この変更は、新規のテナント、およびこれまで既定ロールが手動で追加されてこなかった既存のテナントに対して適用されます。

これに伴い、テナントレベルの [設定] ページの [全般] タブから、ロールを追加するオプションを削除しました。

既定のロールが読み取り専用に

既定のロールを編集できなくなりました。ロールに含まれる権限を表示することはできますが、権限の変更はできません。

ロールのカスタマイズが必要な場合は、必要な権限を含むロールを新しく作成する必要があります。

ロール名の変更

ロール名の文字数の増量

ロール名に使用できる文字数の上限を 32 文字から 64 文字に増やしました。

既定のロールをカスタマイズすると、ロール名の末尾に「Custom」が追加されます。

過去に既定のロールの権限をカスタマイズした場合でも、そのロールの利用を続けることができますので、ご安心ください。カスタマイズ済みのロールの名前は「ロール名 - Custom」に変更されているため、既定のロールと、カスタマイズ済みの既定ロールを見分けることができます。

たとえば、既定ロール「Automation User」の権限をカスタマイズすると、ロール名は以下のようになります。

ロール	作成元	編集可能	割り当て可能	権限
Automation User	システム	n	Y	標準
Automation User - Custom	ユーザー定義	Y	Y	カスタム

Tenant Administrator ロールの名称変更

既定のロールに含まれる権限の範囲をより的確に説明するため、Tenant Administrator ロールの名称を Orchestrator Administrator に変更しました。

また、このロールも、既定ロールをカスタマイズした場合の名称変更の影響を受けます。

Orchestrator Administrator: 読み取り専用の既定ロール (以前の Tenant Administrator) です。
Orchestrator Administrator - Custom: 以前の Tenant Administrator ロールをカスタマイズしたものです。Orchestrator Administrator の権限を何らかの方法で変更した場合にこの名前が使用されます。

注: この変更の前から Orchestrator Administrator という名前のカスタムロールを使用していた場合、そのロールの名前は「Orchestrator Administrator - Custom」に変更されます。

現在の設定に対する影響

既存のロールの割り当ては影響を受けません。カスタムロールの名前は新しくなりますが、この変更の影響を受けるロールが割り当てられていたアカウントやグループには、変更後の名前が付いたロールが現在割り当てられています。このため、今回の機能変更に対応するためにユーザー側で必要な操作はなく、すべての機能が問題なく動作しますのでご安心ください。
ロール名を使用する API 要求を更新する必要があります。以下の「重大な変更」セクションの「API: ロール名を含む要求」をご覧ください。

ロールの複製とカスタマイズ

既存のロールをコピーしてカスタマイズできるオプションを追加しました。このオプションは、既定のロールとカスタマイズされたロールの両方で使用できますが、混合ロールでは使用できません。

既定のロールが読み取り専用になったため、既定のロールを編集して使用したい場合は、今回からはこの方法を使用してロールをカスタマイズします。

このオプションを使用するには、[テナント] > [アクセス権を管理] > [ロール] に移動し、行の右側にある [その他のオプション] をクリックして、[複製してカスタマイズ] を選択します。

ロールのエクスポートとインポート

既存のロールを CSV 形式にエクスポートし、そのファイルを Orchestrator にインポートできるようにしました。これにより、編集したロールの組み合わせを複数の組織やテナントで利用できます。ロールのエクスポート方法やインポート方法について詳しくは、こちらをご覧ください。

効果を持たない権限を未選択状態の灰色表示に

ロールを編集する際に、[ログ] - [編集] などの、効果を持たない権限のチェックボックスをオン/オフできないようにしました。効果を持たない権限は、インターフェイス上では既定で未選択の状態となり、灰色表示されます。

API: ロールを割り当てるための新しいエンドポイント

既存のアカウントにロールを割り当てる、または割り当てられたロールを上書きすることのできる、新しいエンドポイントを Orchestrator API に追加しました。

POST /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles

新しいエンドポイントではロール名ではなくロール ID に基づいてロールが割り当てられるため、既存のユーザーエンドポイントと比較すると信頼性が向上しています。

新しいエンドポイントは、Orchestrator API の Swagger (<OrchestratorURL>/swagger) で確認できます。

アクションとアクションカタログの権限

個人用ワークスペースの管理者ロールに対して、アクションとアクションカタログに対するすべての権限が既定で有効化されるようになりました。このため、個人用ワークスペースのフォルダーから長期実行のワークフロー (オーケストレーションプロセス) を実行できるようになりました。

API

監査データに必要なプロパティをいくつかのリソースの DTO に追加しました。したがって、エンドポイントの応答本文が以下のように変更されます。
- /odata/Users
  
  "LastModificationTime": "2021-10-12T07:29:25.914Z", "LastModifierUserId": 0, "CreatorUserId": 0
- odata/Robots
  
  "LastModificationTime": "2021-10-12T07:32:24.940Z", "LastModifierUserId": 0, "CreationTime": "2021-10-12T07:32:24.940Z", "CreatorUserId": 0
- odata/Releases
  
  "LastModificationTime": "2021-10-12T07:29:25.914Z", "LastModifierUserId": 0, "CreatorUserId": 0
- odata/Assets
  
  "LastModificationTime": "2021-10-12T07:57:15.145Z", "LastModifierUserId": 0, "CreationTime": "2021-10-12T07:57:15.145Z", "CreatorUserId": 0
- odata/Libraries
  
  "Created": "2021-10-12T07:59:04.182Z", "LastUpdated": "2021-10-12T07:59:04.182Z", "Owners": "string", "IconUrl": "string", "Summary": "string", "PackageSize": 0, "IsPrerelease": true, "LicenseUrl": "string", "ProjectUrl": "string"
キューアイテムのデータが追跡されないよう、API を使用して SpecificContent キーの値を削除できるようになりました。この操作には、エンドポイント PUT /odata/QueueItem({Id}) を使用します。ペイロードの種類は、こちらからご確認ください。

エンドポイントの非推奨化

いくつかのエンドポイントを非推奨とし、それらに取って代わる新しいエンドポイントを公開しました。新しいエンドポイントを確認するには Swagger の説明をご覧ください。エラーが発生しないよう、クライアントの非推奨エンドポイントも置換するようにしてください。非推奨の API と、それに代わる新しい API のリストは次のとおりです。

ログ

非推奨	置換対象の API
POST `/api/Logs`	POST `/api/Logs.SubmitLogs`

アセット

非推奨	置換対象の API
GET `/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='{robotId}`	`/odata/Assets/GetRobotAssetByNameForRobotKey`

OrganizationUnits

非推奨	置換対象の API
GET `/odata/OrganizationUnits`	GET `/odata/Folders`
POST `/odata/OrganizationUnits`	POST `/odata/Folders`
GET `/odata/OrganizationUnits({key})`	GET `/odata/Folders({key})`
PUT `/odata/OrganizationUnits({key})`	PUT `/odata/Folders({key})`
DELETE `/odata/OrganizationUnits({key})`	DELETE `/odata/Folders({key})` に置換
POST `/odata/OrganizationUnits({key})`	POST `/odata/Folders.AssignUsers`
GET `/odata/OrganizationUnits/UiPath.Server.Configuration.OData.GetUsersForUnit(key={key})`	GET `/odata/Folders.GetUsersForFolder`

設定

非推奨	置換対象の API
GET `/odata/Settings/UiPath.Server.Configuration.OData.GetCalendar`	GET `/odata/Calendars`
POST `/odata/Settings/UiPath.Server.Configuration.OData.SetCalendar`	POST `/odata/Calendars`

Studio Web

非推奨	置換対象の API
GET `/api/StudioWeb/TryEnableFirstRun`	POST `/api/StudioWeb/TryEnableFirstRun`

セットアップ

Identity Server と Orchestrator との連携機能を改良した結果として、UiPath.Orchestrator.dll.config のいくつかのパラメーターを置換/削除しました。
- WindowsAuth.GroupMembershipCacheExpireHours を IdentityServer.GroupMembershipCacheExpireHours に置き換えました。v2022.4 以降にアップグレードすると、WindowsAuth.GroupMembershipCacheExpireHours は削除されます。Identity Server のグループメンバーシップのキャッシュについて設定するには、IdentityServer.GroupMembershipCacheExpireHours を使用します。
- 次のパラメーターを削除しました: ExternalAuth.AzureAD.Enabled、ExternalAuth.AzureAD.ApplicationId、ExternalAuth.AzureAD.RedirectUri、ExternalAuth.Saml2.Enabled、ExternalAuth.UserMappingStrategy、ExternalAuth.UserIdentifierClaim 、ExternalAuth.Google.Enabled、ExternalAuth.Google.ClientId、ExternalAuth.Google.ClientSecret、WindowsAuth.Enabled、WindowsAuth.Domain。今後のホストの外部 ID プロバイダーの設定は、インストール後にホスト管理ポータルからのみ行えます。
- また、コマンドラインパラメーターの WINDOWS_AUTHENTICATION および DOMAIN を削除しました。今後の Active Directory の有効化は、インストール後にホスト管理ポータルからのみ行えます。

自動更新

自動更新機能が macOS プラットフォーム上の Robot と Assistant をサポートするようになりました。また、更新を特定の日時に開始するようスケジュール設定できるようになったため、社内の他のメンテナンスウィンドウとタイミングを合わせることができます。

追記 (2023 年 4 月 28 日)

この機能を有効化するには、UiPath.Orchestrator.dll.config ファイルに Features.MachineMaintenanceSchedule.Enabled パラメーターを追加して、true に設定する必要があります。

その他の改良点

フォルダーコンテキストの [オートメーション] > [ログ] ページで、現在のフォルダーに関連付けられているマシンでログをフィルター処理できるようになりました。以前は [マシン] フィルターを使用すると、テナント内の利用可能なすべてのマシンが表示されていました。
[新規作成] メニューから新しいオブジェクトを作成すると、元のページにリダイレクトされるようになりました。これまでは、そのオブジェクトのリストページにリダイレクトされていました。
[監査] ページの [コンポーネント] ドロップダウンから無人セッションを選択できるようになりました。

追記 2022 年 11 月 2 日: テストケースの jobs.created Webhook のペイロードに、ジョブの実行に使用された特定のロボット ID とマシンが表示されるようになりました。

非推奨化のタイムライン

重要: 非推奨の機能は完全にサポートされており、 UiPath が実質的に機能を削除するまでは引き続き動作します。

標準マシンは v2022.10 より非推奨となります。マシンテンプレートの使用をお勧めします。
クラシックフォルダーは v2022.10 より非推奨となります。モダンフォルダーへの移行をお勧めします。
API: ロール名のプロパティが v2022.10 以降の Orchestrator API 全体で廃止されます。ロール名ではなくロール ID に依存するように要求を更新することをお勧めします。
API: 一部の API エンドポイントは、今回のリリースで非推奨となりました。前述のセクションに記載されている新しいエンドポイントを使用することをお勧めします。

今後の非推奨化と削除の予定について詳しくは、こちらをご覧ください。

重大な変更

API: トークンのエンドポイント

/connect/token エンドポイントは、multipart/form-data のコンテンツタイプを受け入れなくなりました。

v2022.4 へのアップグレード後、このエンドポイントに送信する該当の API 要求はすべて、application/x-www-form-urlencoded のコンテンツタイプを使用するよう更新する必要があります。

API: ロール名を含む要求

ロール機能を改良したことで一部のロールの名前が変更されたため、名前が変更されたロール名を参照する API 呼び出しは、新しい名前を使用するよう更新する必要があります。

この変更により、次の API 呼び出しに影響があります。

既定ロールをカスタマイズしたロール (新しい名前: Role name - カスタム) に関連する API 呼び出し

重要: こういった呼び出しは変更作業を行わなくても動作し続けますが、期待どおりの結果は得られません。現在この呼び出しを使用すると、カスタマイズされたロールではなく既定のロールが割り当てられます。
以前の Tenant Administrator ロール (新しい名前: Orchestrator Administrator) に関連する API 呼び出し

指定した名前のロールを見つけることはできないため、この呼び出しを使用するとエラーが発生します。

影響を受けるエンドポイント

ロール名に基づいてロールを割り当てることができる API 要求は、以下のとおりです。

POST /odata/Users
PUT /odata/Users({key})
PATCH /odata/Users({key})
POST /odata/Users({key})/UiPath.Server.Configuration.OData.ToggleRole

修復方法

この問題に対処するため、ロール名ではなくロール ID に基づいてロールを割り当てることのできる新しいエンドポイントを使用できます。

この変更の影響を受ける API 連携を更新し、期待どおりに動作させる方法には、以下の 2 種類があります。

A. 2 つ目の API 呼び出しを追加する (推奨)

既存の API 要求をそのまま残すことができます。ロールを割り当てる各呼び出しの後ろに新しいエンドポイントに対する呼び出しを追加することで、一度割り当てられたロールを正しいロールで上書きします。

たとえば、/odata/Users に POST 要求を送信してテナントの管理者アカウントを作成するとします。この場合、アカウント作成処理の一環として、この要求では Tenant Administrator ロールを割り当てようとします。しかし、このロールは Orchestrator Administrator ロールに名前が変更されています。そこで、この要求の後に /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles に送信する新しい POST 要求を追加します。このエンドポイントによって Orchestrator Administrator ロールのロール ID が渡されるため、ロールが正しく割り当てられます。

この修復方法では、お使いの API 連携内で今回の変更の影響を受ける要求を特定し、特定された要求ごとに以下の手順に従います。

ユーザー ID と、影響を受ける API 要求によって割り当てられるロール名をメモします。
/odata/Roles に GET 要求を送信し、現在のロールのリストを取得します。
先ほどメモしたロール名の ID をメモします。
(任意ですが推奨) API 連携内で、影響を受ける要求からロール名プロパティを削除します。

この変更によって、この要求ではロールが割り当てられなくなります。今後は次の手順で追加する要求によってロールの割り当て処理が行われます。

割り当て済みのロールは次の手順の要求によって上書きされるため、この要求からロールプロパティを削除しないことも可能です。
影響を受ける要求の直後に、/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles への POST 要求を追加します。要求の本文にはロール ID を含めます。

{key} の値は、影響を受ける要求のユーザー ID である必要があります。

これによって、先ほど特定した影響を受ける要求によって割り当てられるロールは、正しいロールで即座に上書きされます。

B. ロール名を更新する

より簡単ですが効率的ではない修復方法は、影響を受ける要求を新しいロール名で更新することです。

注: この方法は A よりも簡単ですが、今後ロール名が変更された場合にも対処できる堅牢な API 連携を実現するため、A の方法を検討することをお勧めします。

この修復方法では、お使いの API 連携内で今回の変更の影響を受ける要求を特定し、特定された要求ごとに以下の手順に従います。

/odata/Roles に GET 要求を送信し、現在のロールのリストを取得します。
影響を受ける要求によって割り当てられるロールの、現在の名前をメモします。
API 連携内で、影響を受ける要求のロール名プロパティの値を、新しいロール名で更新します。

既知の問題

[アセット] ページでアセットを名前で並べ替える機能が動作しません。
v2020.4 から v2020.10 以降にアップグレードすると、Robot ロールのプロセスの表示権限が更新されません。この権限は手動で追加する必要があります。
キューの成功したトランザクションを延期すると、トランザクションの出力データが削除されます。この問題を解決するには、新しいキューアイテムを作成して現在のトランザクションの出力データを格納します。
GET /odata/Releases エンドポイントの応答本文が、IsLatestVersion の値を誤って False として返す可能性があります。IsLatestVersion キーの正しい戻り値を取得するには、次のように $expand または $select のクエリパラメーターを使用します。
- /odata/Releases/$expand=CurrentVersion
- /odata/Releases/$select=IsLatestVersion
ホストとして Swagger UI 経由でメンテナンスウィンドウを終了しようとすると、失敗する場合があります。これは、Swagger UI が認証に Cookie を使用しており、Cookie の情報はブラウザーを閉じると失われるためです。 API 経由でメンテナンスモードを終了するには、以下の回避策のいずれかをご利用ください。
- ブラウザーを閉じず、Swagger UI から /api/Maintenance/End に POST 要求を送信します。
- API テストアプリケーション (Postman など) を使用して、以下の操作を行います。
  - 資格情報を提供して /api.Account/Authenticate エンドポイントへのアクセストークンを取得します。
  - Authorization: Bearer {access_token} ヘッダーを使用して、/api/Maintenance/End エンドポイントに POST 要求を送信します。
- 以下の PowerShell スクリプトを実行します。
```
$orchestratorUrl="https://localhost:6234"
$hostTenant="host"
$hostUser="admin"
$hostPassword=""
$tenantId="" #number

# Authenticate
$body=@{
    "tenancyName"="$hostTenant";
    "usernameOrEmailAddress"="$hostUser";
    "password"="$hostPassword"
}

$response = Invoke-WebRequest -Uri "$orchestratorUrl/api/account/authenticate" -Method Post -Body ($body | ConvertTo-Json) -ContentType "application/json"
$token = "Bearer " + ($response | ConvertFrom-Json).result

# End maintenance mode

$headers=@{
    "Authorization"="$token"
}

$res = Invoke-WebRequest -Uri "$orchestratorUrl/api/maintenance/end?tenantId=$tenantId" -Headers $headers -Method Post -ContentType "application/json" -ErrorAction Stop

if ($res -and ($res.StatusCode -eq 200)) {
    Write-Host "Maintenance mode ended successfully for tenant $tenantId"
}$orchestratorUrl="https://localhost:6234"
$hostTenant="host"
$hostUser="admin"
$hostPassword=""
$tenantId="" #number

# Authenticate
$body=@{
    "tenancyName"="$hostTenant";
    "usernameOrEmailAddress"="$hostUser";
    "password"="$hostPassword"
}

$response = Invoke-WebRequest -Uri "$orchestratorUrl/api/account/authenticate" -Method Post -Body ($body | ConvertTo-Json) -ContentType "application/json"
$token = "Bearer " + ($response | ConvertFrom-Json).result

# End maintenance mode

$headers=@{
    "Authorization"="$token"
}

$res = Invoke-WebRequest -Uri "$orchestratorUrl/api/maintenance/end?tenantId=$tenantId" -Headers $headers -Method Post -ContentType "application/json" -ErrorAction Stop

if ($res -and ($res.StatusCode -eq 200)) {
    Write-Host "Maintenance mode ended successfully for tenant $tenantId"
}
```
UiPath のユーザーライセンス名は、時の経過とともに変化しています。しかし、GET /odata/LicensesNamedUser エンドポイントの robotType パラメーターは、新しい名前と共に古い名前を現在も参照しています。そのため、Swagger には「Development」がオプションとして表示されますが、これは現在「RPA Developer」に名前が変更されているため、「RpaDeveloper」オプションも表示されます。ロボットライセンスについて詳しくは、以下の表でご確認ください。

2018	2019	2020 年	2021.4	2021.10
Attended	Attended	Attended	Attended	Attended
Development	Studio	Studio	RPA 開発者 (RPA Developer)	Automation Developer
	+ StudioX	StudioX	Citizen Developer	Citizen Developer
		+ StudioPro	RPA Developer Pro	Automation Developer
Unattended	Unattended	Unattended	Unattended	Unattended
NonProduction	NonProduction	NonProduction	NonProduction	NonProduction
		+Testing	テスト	テスト

バグ修正

攻撃者がロボットへの特権アクセスを持つ場合に、Orchestrator への API 呼び出しにブルートフォース攻撃を行うことによって、同一テナント内の他のロボットのライセンスキー (マシンキー) を取得できてしまう問題を修正しました。理論的には、この問題で攻撃者がアクセスできる対象は、アクセス権を持つロボットのリソースに限られていました。セキュリティのサポート技術情報について詳しくは、「UiPath Orchestrator - Robot Account Takeover」をご覧ください。
フォルダーレベルからテナントレベルに移動する直前にクラシックフォルダーを選択していた場合、ロボットアカウントをフォルダーに割り当てることができませんでした。具体的には、割り当てるロボットアカウントを検索しても、存在するはずのアカウントが表示されませんでした。
モダンフォルダーでジョブを開始または作成する要件として、ロボットの表示権限を追加しました。このため、ジョブの [開始] ボタンは、必要な権限がユーザーに割り当てられるまでは非アクティブ状態となります。必要な権限は、ボタンのツールチップに表示されます。以前は、モダンフォルダーでジョブを開始または作成すると、「現在の権限ではこのアクションを実行できません。」(#0)」というエラーメッセージが表示されていました。
GenerateReportsJob ([キュー] ページの統計値を計算するバックグラウンドジョブ) の背後のメカニズムを「増分」から「パーティションスワップ」に変更したことが原因で、次のようなエラーが発生していました。「The 'LastQueueItemEventProcessed' property on 'UiQueueProcessingRecordBase' could not be set to a 'null' value ('UiQueueProcessingRecordBase' の 'LastQueueItemEventProcessed' プロパティに 'null' の値を設定できませんでした。)」この問題は、現在は修正されました。
実行ターゲットを [動的割り当て] から [すべてのロボット] に変更しても、[トリガーを編集] ウィンドウの [更新] ボタンが有効化されませんでした。この問題はクラシックフォルダーでのみ発生していました。現在は、クラシックフォルダーでトリガーの実行ターゲットを変更すると、[更新] をクリックして変更を保存できます。
手動でアップロードされたパッケージの名前が [監査] ページの詳細情報に表示されませんでした。この問題は、パッケージを個別または一括でアップロードした際に発生していました。現在は、アップロードされたすべてのパッケージの名前が [監査] ページの詳細情報に正しくログ記録されるようになりました。
セッションの非アクティブタイムアウトの後、Orchestrator で「認証トークンが無効です。」(エラーコード - 1431) というエラーが発生し、ブラウザーでエラーの無限ループが生じていました。この問題は、現在は修正されました。
[ロールをロボットアカウントに割り当て] ウィンドウの誤記 (英語 UI) を修正しました。具体的には、[Search for a robot account] フィールドが [Seach for a robot account] と表示されていました。現在、フィールド名のスペルは正しいものに修正されています。
Orchestrator の言語を日本語、中国語、または韓国語に設定すると、[ログ] ページの時刻が正しくレンダリングされませんでした。具体的には、0 にスラッシュが入って表示され、その 0 の直後の単位 (時/分/秒) が表示されませんでした。たとえば、11時20分03秒 と表示されるべき箇所で 11時2Ø03秒 と表示されていました。
また Latin1 ベースの SQL 照合方法を選択している場合は、アプリケーションサーバーでトルコ語 (tr-tr) のカルチャが使用されている際に同様の問題が発生していました。この問題を修正するには、en-us のカルチャに切り替えてからインストールを再度お試しください。

アクティビティパッケージのバージョン

以下のバージョンのアクティビティパッケージが Orchestrator に含まれています。

アクティビティパッケージ	バージョン
UiPath.UIAutomation.Activities	v22.4.4
UiPath.System.Activities	v22.4.1
UiPath.Mail.Activities	v1.15.1
UiPath.Excel.Activities	v2.12.3
UiPath.Testing.Activities	v22.4.2
UiPath.MobileAutomation.Activities	v22.4.4
UiPath.Word.Activities	v1.10.1
UiPath.ComplexScenarios.Activities	v1.1.6
UiPath.PDF.Activities	v3.6.0
UiPath.Terminal.Activities	v2.4.0
UiPath.Web.Activities	v1.11.1
UiPath.Persistence.Activities	v1.3.4
UiPath.Form.Activities	v1.9.4