通知を受け取る

UiPath Orchestrator

UiPath Orchestrator ガイド

2022.4

公開日: 2022 年 5 月 23 日

Automation Suite v2022.4.0 が利用できるようになりました。

 

公開日: 2022 年 5 月 9 日

更新内容


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

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

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

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

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

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

Tagging is currently available for several Orchestrator resources and Action Center actions. See the list of taggable objects.

📘

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

既知の問題

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

Installation & upgrade considerations

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

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

As for standalone Orchestrator, if you opt for an Azure App Service installation, there are a couple of additional steps you need to take to make sure you benefit from the goodies brought about by Resource Catalog. We have introduced two new scripts to help you with that: Publish-ResourceCatalog.ps1 and MigrateTo-ResourceCatalog.ps1. For more details, see Azure App Service Installation.

 

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

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

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

1469

既知の問題:

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

 

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

In this release, we ship a new robot authentication mechanism that uses the OAuth 2.0 framework as the basis for its authentication protocol, meaning unattended robots can connect to Orchestrator using a client ID - client secret pair generated via machine template objects. The client ID - client secret pair generates a token that authorizes the connection and provides the robot with access to Orchestrator resources.

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

More on robot authentication.
Instructions for administrators on how to manage client credentials (create new credentials, revoke access).
Instructions for RPA developers and attended users on how to connect their robots to Orchestrator.

 

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

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

 

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

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

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

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

More about how to delete disconnected or unresponsive unattended sessions.

 

新しい資格情報ストア

You can now choose from a wider selection of plugins to store your Orchestrator credentials. Three new credential stores are now integrated with Orchestrator: HashiCorp Vault, BeyondTrust, and Azure Key Vault (read-only).

 

S3 互換ストレージ

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

1020

Learn how to enable S3 compatible providers for creating storage buckets in Orchestrator.
Learn how to create and configure storage buckets.

 

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

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

 

SQL Server の認証に Azure AD を利用できるように

We once again come bearing gifts for those of you who have installed Orchestrator on an Azure VM or Azure App Service: we now offer support for Azure AD. You can use this authentication method to connect Orchestrator to SQL Server. For details, see our documentation.

組織レベルでの SAML 連携

この連携により、Okta や PingOne など、SAML 2.0 標準をサポートするサードパーティの ID プロバイダー (IdP) に Automation Suite を接続できます。
この連携はこれまでもホスト レベルで利用できましたが、今回からは組織レベルでも有効化できるようになりました。

SAML モデルを使用した認証について | Configuring the SAML integration (for organizations)

:warning: Erratum 22 June 2022: A new parameter, -NoAzureAuthentication, has been added to the Orchestrator script, the Identity Server scripts, the Webhooks scripts, and the Resource Catalog scripts. It allows you to publish to the Azure App Service under your own identity, without having to create a service principal.

 

改良点


監視

Monitoring folder resources from a centralized location

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

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

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

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

New filtering options when monitoring processes

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

Persisting filters

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

 

オートメーション

  • Orchestrator では、保留中のジョブが溜まらないように、ジョブの実行を自動的に停止または強制終了するスケジュール設定オプションを利用できます。
    The option to schedule when a job execution ends is now available on the Start job and Queue trigger pages, in addition to the Time trigger page.
    Learn more about the Schedule ending of job execution option in our documentation about managing jobs and queue triggers.

  • You can now filter queue transactions by the robot (that is, user or robot account) that processed them. The dropdown menu of the Robot filter displays the robots present in the corresponding modern folder. To see the available robots, you need View permissions on Users.

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

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

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

 

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

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

 

暗号化

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

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

Database tableEncrypted columnsEncryption method
QueueItemsSpecific Data
Output
Optional via UI
Creating a queue
AssetValuesValueBy default
Tasks
(i.e., actions)
Data
(i.e., action catalogs)
Optional via UI
Adding a new Action Catalog

 

ロールと権限

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

しかし、既定のロールの権限の組み合わせも基準として使えるよう、いつでも利用できるようにしておく必要があると考えました。
このため、特にモダン フォルダーの既定ロールとその権限に対して、いくつかの改良を行いました。

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

Orchestrator の設定画面から既定のロールをテナントに追加することなく、ロールを既定で利用できるようになりました。この変更は、新規のテナント、およびこれまで既定ロールが手動で追加されてこなかった既存のテナントに対して適用されます。
これに伴い、テナント レベルの [設定] ページの [全般] タブから、ロールを追加するオプションを削除しました。

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

既定のロールを編集できなくなりました。ロールに含まれる権限を表示することはできますが、権限の変更はできません。
ロールのカスタマイズが必要な場合は、必要な権限を含むロールを新しく作成する必要があります。

ロール名の変更

ロール名の文字数の増量

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

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

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

RoleOriginCan edit?Can assign?Permissions
Automation UserSystemNYStandard
Automation User - CustomUser definedYYCustom

 

Tenant Administrator ロールの名称変更

To better describe the scope of rights included with this default role, we have renamed the Tenant Administrator role to Orchestrator Administrator. Orchestrator Administrator default role

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

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

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

現在の設定に対する影響

  • 既存のロールの割り当ては影響を受けません。カスタム ロールの名前は新しくなりますが、この変更の影響を受けるロールが割り当てられていたアカウントやグループには、変更後の名前が付いたロールが現在割り当てられています。このため、今回の機能変更に対応するためにユーザー側で必要な操作はなく、すべての機能が問題なく動作しますのでご安心ください。

  • API requests that use role names need to be updated. Details...

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

既存のロールをコピーしてカスタマイズできるオプションを追加しました。このオプションは、既定のロールとカスタマイズされたロールの両方で使用できますが、混合ロールでは使用できません。
既定のロールが読み取り専用になったため、既定のロールを編集して使用したい場合は、今回からはこの方法を使用してロールをカスタマイズします。

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

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

既存のロールを CSV 形式にエクスポートし、そのファイルを Orchestrator にインポートできるようにしました。これにより、編集したロールの組み合わせを複数の組織やテナントで利用できます。
ロールをエクスポートする | ロールをインポートする

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

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

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

既存のアカウントにロールを割り当てる、または割り当てられたロールを上書きすることのできる、新しいエンドポイントを Orchestrator API に追加しました。
POST /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles

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

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

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

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

 

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"
    
  • Prevent queue items data tracing by deleting the value of the SpecificContent key via API. Use the PUT /odata/QueueItem({Id}) endpoint with the type of payload described in our documentation.

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

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

ログ

DeprecatedReplaced with
POST /api/LogsPOST /api/Logs.SubmitLogs

アセット

DeprecatedReplaced with
GET /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='{robotId}',assetName='{assetName}')/odata/Assets/GetRobotAssetByNameForRobotKey

OrganizationUnits

DeprecatedReplaced with
GET /odata/OrganizationUnitsGET /odata/Folders
POST /odata/OrganizationUnitsPOST /odata/Folders
GET /odata/OrganizationUnits({key})GET /odata/Folders({key})
PUT `/odata/OrganizationUnits({key})PUT /odata/Folders({key})
DELETE /odata/OrganizationUnits({key})Replace with: DELETE /odata/Folders({key})
POST /odata/OrganizationUnits({key})/UiPath.Server.Configuration.OData.SetUsersPOST /odata/Folders.AssignUsers
GET /odata/OrganizationUnits/UiPath.Server.Configuration.OData.GetUsersForUnit(key={key})ET /odata/Folders.GetUsersForFolder

設定

DeprecatedReplaced with
GET /odata/Settings/UiPath.Server.Configuration.OData.GetCalendarGET /odata/Calendars
POST /odata/Settings/UiPath.Server.Configuration.OData.SetCalendarPOST /odata/Calendars

Studio Web

DeprecatedReplaced with
GET /api/StudioWeb/TryEnableFirstRunPOST /api/StudioWeb/TryEnableFirstRun

 

セットアップ

  • Identity Server と Orchestrator との連携機能を改良した結果として、UiPath.Orchestrator.dll.config のいくつかのパラメーターを置換/削除しました。

    • we replaced WindowsAuth.GroupMembershipCacheExpireHours with IdentityServer.GroupMembershipCacheExpireHours. Upon upgrading to 2022.4+, WindowsAuth.GroupMembershipCacheExpireHours is removed. To specify the Identity Server group membership cache, use IdentityServer.GroupMembershipCacheExpireHours.
    • we removed the following parameters: 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, and WindowsAuth.Domain. You can now configure external identity providers for the host only after installation, from the host Management portal.
    • we also removed the WINDOWS_AUTHENTICATION and DOMAIN command line parameters. You can now enable Active Directory only after installation, from the host Management portal.
  • The Platform Configuration Tool no longer verifies the certificate host name when upgrading from a version prior to 2020.4. This change is due to the check not being applicable in this upgrade scenario.

  • The UiPathOrchestrator.msi installer now works with ASP.NET Hosting Bundle 6.0.x. ASP.NET Hosting Bundle 5.0.x is no longer supported.

  • We no longer validate the SAN certificate against the machine hostname, as we now use the public load balancer DNS for this purpose. As a result, when running the UiPathOrchestrator.msi installer, you no longer have to specify the Host name in the Orchestrator IIS Settings screen. In addition to that, we have deprecated the WEBSITE_HOST command line parameter.

  • You can now disable public access to newly created Amazon S3 storage buckets by tweaking the UiPath.Orchestrator.dll.config file. To do that, set the BlockPublicAccess property to true in the Amazon S3 storage connection string. Note that this has no impact on existing buckets.
    また、Orchestrator のストレージ プロバイダーとして Amazon S3 を選択した場合に、AccessKeySecretKey の代わりにマシンの IAM ロールを認証に使用できるようになりました。
    For more details, see the Storage.Location parameter.

  • When upgrading Orchestrator, you are now prompted with a warning if an Insights version older than 2021.10 is enabled. This message is meant to remind you that Insights hardware requirements changed significantly starting with version 2021.10. Before an Orchestrator upgrade, you must ensure you meet the new Insights requirements.

  • For consolidation purposes, we have deprecated the following UiPath.Orchestrator.dll.config parameters:

    • ExternalAuth.System.OpenIdConnect.Enabled
    • ExternalAuth.System.OpenIdConnect.Authority
    • IdentityServer.S2SIntegration.Enabled
    • IdentityServer.OAuth.Enabled
  • In addition to that, following a cleanup operation we did for the UiPath.Orchestrator.dll.config file, the following parameters have been removed as well:

    • ActiveDirectory.SearchInputMinimumLength
    • ActiveDirectory.SearchResultsSizeLimit
    • ActiveDirectory.SearchResultsTimeLimitSeconds
    • ActiveDirectory.UseNativeDomainResolver
    • WindowsAuth.Enabled
    • WindowsAuth.Domain
    • WindowsAuth.AutoLogin.Enabled
    • WindowsAuth.ApiAutoLogin.Enabled
    • WindowsAuth.GroupMembershipFetchStrategy
    • WindowsAuth.ConvertUsersAtLogin
  • We no longer require setting the Database.EnableAutomaticMigrations parameter to true for cron jobs changes to take effect.
    Instead, to apply changes related to the schedules of internal jobs, you must follow the instructions in Updating schedules of internal jobs.

  • To prevent unexpected behavior when updating certificates using the Platform Configuration Tool, we have introduced the -KeepOldCertificate parameter.

  • When configuring SMTP for system email notifications, the SMTP Host field failed validation if using a hostname instead of an FQDN.

  • We have deprecated the UseRedis flag in the Identity Server's AppSettings.json configuration file. To turn on Redis for load-balanced scenarios, fill in the RedisConnectionString setting under the LoadBalancerSettings section .
    If you have enabled Redis for a load-balanced scenario, you have the option of using Redis for caching to reduce stress on the SQL database. A new section called RedisSettings controls which caches are enabled. We have moved the UseRedisStoreCache under this section. In addition to that, the section contains a new parameter, UseRedisStoreClientCache. For details, see Redis Settings.
    Azure App Service installations are seeing some similar changes as well. The AppSettings__LoadBalancerSettings__UseRedis setting is no longer used with the Publish-IdentityServer.ps1 script, and AppSettings__UseRedisStoreCache has been renamed to AppSettings__RedisSettings__UseRedisStoreCache. On the other hand, we have introduced a new parameter to enable client caching in Redis, namely AppSettings__RedisSettings__UseRedisStoreClientCache. For details, see Identity Server Scripts.

 

自動更新

The auto update functionality now supports Robot and Assistant on macOS platforms. Also, you can now schedule the update to start at a specific time and date so that you can match other maintenance windows in your company.

 

その他の改良点

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

Erratum 02 November 2022: The payload of the jobs.created webhook for Test Case now displays the specific robot ID and the machine used for the job run.

 

非推奨化のタイムライン


🚧

重要

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

  • Standard machines will be deprecated starting with 2022.10. We recommend using machine templates.
  • Classic folders will be deprecated starting with 2022.10. We recommend migrating to modern folders.
  • API: ロール名のプロパティが v2022.10 以降の Orchestrator API 全体で廃止されます。ロール名ではなくロール ID に依存するように要求を更新することをお勧めします。
  • API: Several API endpoints have been deprecated in this release. We recommend using the replacement endpoints listed here.

More about upcoming deprecations and removals.

 

重大な変更


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

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

API: ロール名を含む要求

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

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

  • 既定ロールをカスタマイズしたロール (新しい名前: Role name - カスタム) に関連する API 呼び出し
    These calls continue to work without making any changes, but the result is not as expected. Namely, the call now assigns the default role instead of the customized version of the role.
  • 以前の Tenant Administrator ロール (新しい名前: Orchestrator Administrator) に関連する API 呼び出し
    指定した名前のロールを見つけることはできないため、この呼び出しを使用するとエラーが発生します。

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

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

修復方法

To address this issue, you can use the new endpoint to assign roles based on the role ID instead of the role name.

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

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

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

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

  1. ユーザー ID と、影響を受ける API 要求によって割り当てられるロール名をメモします。
  2. /odata/Roles に GET 要求を送信し、現在のロールのリストを取得します。
  3. 先ほどメモしたロール名の ID をメモします。
  4. (任意ですが推奨) API 連携内で、影響を受ける要求からロール名プロパティを削除します。
    この変更によって、この要求ではロールが割り当てられなくなります。今後は次の手順で追加する要求によってロールの割り当て処理が行われます。
    割り当て済みのロールは次の手順の要求によって上書きされるため、この要求からロール プロパティを削除しないことも可能です。
  5. 影響を受ける要求の直後に、/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles への POST 要求を追加します。要求の本文にはロール ID を含めます。
    {key} の値は、影響を受ける要求のユーザー ID である必要があります。

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

B. Update role names
より簡単ですが効率的ではない修復方法は、影響を受ける要求を新しいロール名で更新することです。
While this method is easier, we recommend that you consider using the previous method instead because it hardens your integration against any subsequent changes to role names.

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

  1. /odata/Roles に GET 要求を送信し、現在のロールのリストを取得します。
  2. 影響を受ける要求によって割り当てられるロールの、現在の名前をメモします。
  3. 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 など) を使用して、以下の操作を行います。
      retrieve an access token by exchanging your credentials to the /api.Account/Authenticate endpoint, and then
      make a POST request to the /api/Maintenance/End endpoint using the Authorization: Bearer {access_token} header.
  • UiPath のユーザー ライセンス名は、時の経過とともに変化しています。しかし、GET /odata/LicensesNamedUser エンドポイントの robotType パラメーターは、新しい名前と共に古い名前を現在も参照しています。そのため、Swagger には「Development」がオプションとして表示されますが、これは現在「RPA Developer」に名前が変更されているため、「RpaDeveloper」オプションも表示されます。
    ロボット ライセンスについて詳しくは、以下の表でご確認ください。
Year or Orchestrator version2018201920202021.42021.10
AttendedAttendedAttendedAttendedAttended
DevelopmentStudioStudioRPA DeveloperAutomation Developer
+ StudioXStudioXCitizen DeveloperCitizen Developer
+ StudioProRPA Developer ProAutomation Developer
UnattendedUnattendedUnattendedUnattendedUnattended
NonProductionNonProductionNonProductionNonProductionNonProduction
+TestingTestingTesting

 

バグ修正


  • An issue was fixed that would allow an attacker with privileged access to a robot to retrieve the LicenseKey (MachineKey) of other robots within the same tenant by brute forcing API calls to Orchestrator. This would theoretically allow the attacker to access resources restricted only to that robot. Read the security advisory for UiPath - 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 のカルチャに切り替えてからインストールを再度お試しください。
  • Deadlocks would occur where queue item processing took less than a second per queue item. Processes would throw multiple "An error has occurred. Error code: 0" errors before crashing. The issue has been fixed and you are now able to process queue items without running into deadlocks.
  • When the Orchestrator and Identity databases used Turkish-specific collation, upgrades from version 2020.10 to 2021.10 failed.
  • Credential asset retrieval failed for CyberArk credential store when setting Plugins.SecureStores.CyberArk.UsePowerShellCLI to true in Orchestrator's UiPath.Orchestrator.dll.config file.
  • Upon upgrading to 2021.10.1 or later, Orchestrator failed to send email alerts when the Use default credentials option was enabled. Email alerts are now successfully sent.
  • An issue was preventing users from enabling the encryption key per tenant feature on the default tenant after a clean installation.

 

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

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

Activity PackVersion
UiPath.UIAutomation.Activitiesv22.4.4
UiPath.System.Activitiesv22.4.1
UiPath.Mail.Activitiesv1.15.1
UiPath.Excel.Activitiesv2.12.3
UiPath.Testing.Activitiesv22.4.2
UiPath.MobileAutomation.Activitiesv22.4.4
UiPath.Word.Activitiesv1.10.1
UiPath.ComplexScenarios.Activitiesv1.1.6
UiPath.PDF.Activitiesv3.6.0
UiPath.Terminal.Activitiesv2.4.0
UiPath.Web.Activitiesv1.11.1
UiPath.Persistence.Activitiesv1.3.4
UiPath.Form.Activitiesv1.9.4

 


ラベルについて

このバージョンの Orchestrator は、以下の 2 つのデプロイ モデルで使用できます。

  • スタンドアロンの Orchestrator
  • Automation Suite に含まれる Orchestrator サービス

この 2 種類のデプロイの機能は類似しているため、ユーザー ガイドやリリース ノートでは同じドキュメントが共有されています。
ただし、いずれかのデプロイにのみ適用される情報がある場合は、以下のラベルを使用しています。

  • - スタンドアロンの Orchestrator にのみ適用され、Automation Suite の Orchestrator には適用されません。
  • - Automation Suite の Orchestrator にのみ適用され、スタンドアロンの Orchestrator には適用されません。

ラベルがない場合は、その情報は両方の種類のデプロイに適用されます。

約 1 か月前に更新


2022.4


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。