クライアント コンポーネントを自動更新する

概要

管理者はこの機能を使用して、Orchestrator から Robot、Studio、UiPath® Assistant のクライアントを新しいバージョンに更新できます。この機能により、大規模なマシン ベースのバージョン更新を一元化された場所から容易に実行できるため、ユーザーの負担が解消され、更新プロセスが効率化されます。

注: クライアント コンポーネントの自動更新機能は、インストール済みの Robot、Studio、UiPath Assistant の製品を新しいバージョンに更新する場合にのみ機能します。バージョンのダウングレードが必要な場合は、ダウングレード処理を手動で行うか、UiPath と無関係のツールを使用する必要があります。

前提条件

1. Orchestrator、Studio、Robot 2021.10 以降。
2. Studio または Robot 2021.10 以降 (あるいはその両方) がクライアント マシンにインストールされ、Orchestrator に接続されていること。

更新プロセスに含まれるコンポーネント

クライアント側

• クライアント アプリケーション:

  • Robot
  • Assistant
  • Studio
• Robot サービス
• 更新エージェント - ユーザーと更新サービス間の通信を担当する Windows プロセスです。(ユーザー モードおよび Attended ロボットのインストールの場合にのみ存在します。)
• 更新サービス - クライアント マシンと更新サーバー間の通信を提供する Windows サービスです。

サーバー側

• Orchestrator: 管理者が自動更新ポリシーを設定し、クライアント アプリケーションのバージョン ステータスを確認するための、ユーザー インターフェイスを提供します。
• 更新サーバー: 自動更新ポリシーを管理し、更新サービスを使用してクライアント マシンとの通信を維持するための、一元化されたサービスです。

動作の仕組み

管理者は、特定のマシンにデプロイする特定のバージョンを選択できます。

そのために、Studio と Robot のインストール時に、2 つの実行可能ファイル UiPath.UpdateService.Worker.exe と UiPath.UpdateService.Agent.exe もマシンに追加されます。

Studio/Robot のインストールの種類に応じて、異なる方法でインストールされます。

• Unattended ロボット: UiPath.UpdateService.Worker.exe が Windows サービスとしてインストールされ、UiPath.UpdateService.Agent.exe はインストールされません。
• Attended ロボット: UiPath.UpdateService.Worker.exe が Windows サービスとしてインストールされ、UiPath.UpdateService.Agent.exe がタスク スケジューラで LogOn タスクとしてインストールされます。
• クイック インストール (ユーザー モード): UiPath.UpdateService.Worker.exe および UiPath.UpdateService.Agent.exe が、タスク スケジューラで LogOn タスクとしてインストールされます。
  重要: Studio と Robot を Attended ユーザー モードでマシン単位でインストールする場合、更新サービスが更新サーバーに接続できるよう、設定時に Orchestrator の URL を追加するのを忘れないようにしてください。インストール時に Orchestrator の URL を追加しないと、マシン上の管理者権限を持つユーザーがマシンにログオンしてロボットを Orchestrator に接続しなければなりません。

新しいポリシーが定義または変更されると、更新サーバーはクライアント マシン上の更新サービスにコマンドを送信し、更新プロセスを開始できるかどうかクライアント アプリケーションに確認します。

更新を受け取るには、製品が「中立」ステートである必要があります。

• Studio - 実行中のプロセスやアクティブなセッションがない。
• Robot - 実行中のジョブやプロセスがない。
• Assistant - 実行中のプロセスや保留中のアクティビティ (インストールまたはダウンロード中のプロセス) がない。
  注: 更新プロセス中、ロボットは更新が完了するまでジョブを開始しません。

有人シナリオでは更新プロンプトが表示され、以下の 2 つのオプションのいずれかを選択できます。

• 今すぐ更新 - 実行中のジョブをすべて停止し、そのマシン上のすべての Studio インスタンスを閉じてから、更新を続行します。

• 後で - 通知をミュートしておいて、システム トレイで [更新を確認] のアイコンをクリックして更新プロセスを再開することができます。

  ユーザーがプロンプトを確認すると、更新サービスに通知され、更新プロセスが開始されます。 最初の通知から 24 時間以内に応答がない場合、更新が自動的にインストールされます。

無人シナリオでは、更新サービスはクライアント アプリケーションのステートが「中立」であることを確認して (前述のとおり)、更新サーバーに通知します。

注:

マシンに実行中のプロセスがある場合は、プロセスを停止するか、終了するまで待機して更新を続行するよう促すメッセージが表示されます。Studio セッションが開いている場合、進行状況を保存するよう促すメッセージが表示されます。

ユーザーが応答しない場合、Studio は閉じられ、プロセスは現状のまま保存されて、更新の完了後に回復することができます。一方、ロボットはプロセスが完了するまで待機し、後から更新プロセスを開始します。

更新プロセスのステップ

更新プロセスは 7 段階に分かれています。

1. ダウンロードしています。
   • 更新サービスは、更新要求がないかどうかを、更新サーバーに 3 時間ごとに確認します。更新要求を受け取ると、更新プロセスはダウンロード プロセスを開始します。ダウンロード プロセスが正常に開始されると、更新要求は「ダウンロード中」ステータスで更新サーバー データベースに追加されます。
2. ダウンロード済み
   • 「ダウンロード済み」ステータスはマーカーとして機能するため、更新サービスは後処理フェーズを開始できます。このステータスは、更新ファイルが正常にダウンロードされたことを示します。
3. 処理中
   • このステップでは、ダウンロードされたファイルの後処理を行います。ファイルが確認され、エラーがなければ、インストール プロセスが開始されます。
4. インストールの準備が整う
   • 更新エージェントは、更新がインストール待ちであることをユーザーに通知して、インストールの承認を求め、クライアント アプリケーションで更新を受信する準備ができているかどうかを確認します。
5. インストールが承認される
   • 承認されたことが更新サービスに通知されると、実際のインストールが開始されます。
6. インストールしています。
   • 前のバージョンと同じ設定を保持したまま、新しいバージョンがマシンにインストールされます。
7. 成功/エラー
   インストールの結果に基づいて、更新ステータスが更新サーバーに報告されます。

   注: Chrome 拡張機能がロボット端末に既にインストールされている場合、自動更新機能によって拡張機能も更新されます。そうでない場合は、拡張機能を手動でインストールする必要があります。

リトライ メカニズム

更新プロセスでは、初回のダウンロードでファイルを取得できない場合、更新サービスはあと 3 回リトライします。リトライ間隔は、初回試行の 1 時間後、最初のリトライの 2 時間後、および最後のリトライの 4 時間後です。各リトライの前に、通知システムからユーザーに通知が送信されます。

ダウンロードが試行されるたびに、Orchestrator の更新ログと、ローカルのマシン上の %localappdata%/Uipath/UpdateService/logs ファイルにログが追加されます。

プロセスはインストールの場合も同様です。最初のインストールに失敗すると、更新サービスは同じ頻度で 3 回リトライします (初回試行の 1 時間後、最初のリトライの 2 時間後、および最後のリトライの 4 時間後)。

更新サーバーは、更新を開始してから終了するまで、72 時間待機します。この期間の経過後に新規バージョンがインストールされない場合、詳細なエラーがログに追加されます。更新は、次に要求を受信したときに再試行されます。

サービス モードおよびユーザー モードの Robot のデプロイ

サーバー側の技術的な部分に関しては、サービス モードのデプロイとユーザー モードのデプロイの両方で同じです。更新サーバーと更新サービスとの間で同じ種類の接続を使用するためです。Robot サービスがクライアント マシン上の更新サービスと通信する方法には、以下のような違いがあります。

サービス モード

サービス モードのデプロイでは、Robot サービスと更新サービスの両方がローカル システム アカウント セッションで実行されます。

ユーザー モード

ユーザー モードのデプロイでは、Robot サービスはユーザー セッションで実行され、更新サービスはローカル システム アカウント セッションで実行されます。

重要: Robot と Studio がユーザー モードでデプロイされている場合、マシン上の 1 つのロボットに更新コマンドを送信すると、その特定のマシン上のすべてのユーザーに対して実行されます。

警告: 更新プロセスが完了したら、Studio と Robot を手動で起動する必要があります。

ポリシーを設定する

ポリシーは、ユーザー、ユーザー グループ (Attended のユースケースに推奨)、またはマシン (Unattended のユースケースに推奨) に設定できます。

ユーザー/ユーザー グループのポリシーを設定する

ユーザーまたはユーザー グループの更新ポリシーを設定すると、管理者は特定のユーザーまたはユーザー グループの Studio、Robot、Assistant のバージョンを管理できます。

• 特定のユーザー - 特定のユーザーに関連付けられているコンポーネントをきめ細かく更新する場合。
• ユーザー グループ - グループのすべてのメンバーのアクセス権を更新して、ユーザーごとにアクセス レベルを設定しなくても済むようにする場合。

ポリシーを設定するには、Orchestrator の [アクセス権を管理] タブで特定のユーザーまたはグループを編集します。

1. [テナント] > [アクセス権を管理] に移動します。[ユーザー] ウィンドウが表示されます。
2. 目的のユーザー/ユーザー グループで、[編集] をクリックします。[ユーザーを編集] ウィンドウが表示されます。
3. [ポリシーの設定を更新] セクションで、自動更新ポリシーを以下のいずれかの値に変更します。

ユーザーごと

グループごと

注:

ユーザーに適用されるポリシーが [なし] に設定されていても、そのユーザーが特定のポリシー ([最新のパッチ] など) が設定されたグループのメンバーでもある場合は、そのグループのポリシーが適用されます。その特定のユーザーのコンポーネントが更新されないようにする場合は、ポリシーが割り当てられたグループからユーザーを削除するか、インストール済みの現在のバージョンを更新ポリシーに設定します。

ユーザーに特定のバージョンをプッシュするポリシーが設定されていても、そのユーザーが別のポリシーが割り当てられたグループのメンバーでもある場合は、ユーザー レベルのポリシーが優先されます。

マシン オブジェクトごと

マシン オブジェクトの更新ポリシーを設定すると、管理者は特定のマシン キーを使用して、Orchestrator に接続されているすべてのマシン上でロボットのバージョンを更新できます。

マシン オブジェクトの更新ポリシーを設定するには、以下の手順を実行します。

1. [テナント] > [マシン] に移動します。[マシン] ウィンドウが表示されます。
2. 目的のマシン オブジェクトで、[編集] をクリックします。[マシンを編集] ウィンドウが表示されます。
3. [メンテナンス] タブにアクセスします。[自動更新] 設定メニューが表示されます。
4. こちらに記載されているオプションを使用して、更新ポリシーを設定します。
   

自動更新のスケジュール設定

[メンテナンス] タブで、更新を特定の日時に開始するようスケジュール設定し、社内の他のメンテナンス ウィンドウとタイミングを合わせることができます。メンテナンス ウィンドウの期間を設定することもできます。メンテナンス ウィンドウに設定された期間が過ぎても更新が開始されなかった場合は、次に利用可能な期間内にスケジュールされます。

ポリシーの優先度

ユーザー レベルのポリシー、グループ レベルのポリシー、マシン レベルのポリシーが同じロボットに適用されている場合、ユーザー レベルのポリシーが優先されます。

例：

• Machine_1 には、2021.10 バージョンの Robot と Studio がインストールされています。
• Machine_1 では、ロボットは [e-mail] ユーザーによる対話型サインインを通じて Orchestrator に接続されています。
• 2021.10.2 バージョンをプッシュするように設定されている更新ポリシーが、[e-mail] に適用されます。
• [e-mail] は group_1 にも属しています。
• 2021.10.3 バージョンをプッシュするように設定されている更新ポリシーが、group_1 に適用されます。

• 2022.4 バージョンをプッシュするように設定されている更新ポリシーが、machine_1 に適用されます。

  結果: 更新ポリシーがトリガーされると、そのマシン上のコンポーネントは 2021.10.2 バージョンに更新されます。

  注: ロボット アカウントを使用する場合、更新の処理にはマシンレベルのポリシーが使用されることに注意してください。

ポリシーで利用可能なバージョン

更新ポリシーを作成するときに、以下のいずれかのオプションを選択できます。

最新のメジャー バージョン	最新のパッチ	特定のパッチ
更新サーバーで見つかった利用可能な最新バージョンをインストールします。	サポートされているバージョンごとに利用可能な最新パッチをインストールします (最新の 2021.10 パッチ、最新の 2022.4 パッチなど)。	更新サーバーで利用可能なパッチのリストから、特定のパッチをインストールします。

更新ログ

Orchestrator のユーザー インターフェイスでは、失敗および成功した更新についての更新ログを利用できます。更新の完全なログは、マシン上の %localappdata%/Uipath/UpdateService/logs ファイルにあります。

警告:

マシンが複製されている仮想環境にロボットをデプロイすると、マシン名、GUID、ドライブ ID、mac アドレスは同じになります。これにより、競合が発生することがあります。Orchestrator は同じ ID を持つ複数のマシンから異なる更新ステータスを受け取るためです。

このシナリオでは、Orchestrator の更新ステータスは、接続した最後のマシンに基づいて表示されます。

このことは、Orchestrator のログにも影響を与える場合があります。複数のマシンが同じ ID を持つため、重複するログが表示される可能性があります。

バージョンのステータス

[バージョンのステータス] 列では、マシンの Robot のバージョンのステータスを関連付けられたポリシーと照合できます。

次の値を使用できます。

• ポリシーなし - ポリシーが定義されていません。
• 更新が進行中 - マシン上で更新プロセスが進行中の場合、このステータスが表示されます。
• 準拠 – マシン上の Robot のバージョンが更新ポリシーと一致しています。
• 非準拠 - マシン上の Robot のバージョンが、ポリシーで設定されたバージョンと異なっています (例: Robot のバージョンが 2021.10.3 で、ポリシーでは 2021.10.1 に設定されている)。
• 更新に失敗 - このステータスは、更新プロセスが失敗した場合に表示されます。詳しくは、更新ログをご覧ください。
• N/A - このステータスは、非アクティブなマシンを無視する設定がオンになっていて、ロボットがしばらくの間接続されていない場合、またはマシンの種類が自動更新プロセスに対応していない場合に表示されます。

マシンのバージョンのステータス

Orchestrator の [マシン] タブの [バージョンのステータス] 列では、マシンの Robot のバージョンのステータスを関連付けられたポリシーと照合できます。

重要: Linux ロボットは、自動更新機能と互換性がありません。これらのロボットについては、バージョンのステータスが N/A となり、ツールチップに「この種類のマシンには、自動更新は適用されません。」と表示されます。

非アクティブなマシンを除外する

複数のマシンが同じキーを使用して Orchestrator に接続されており、その 1 つが非アクティブな場合、マシン テンプレートのバージョンのステータスは「非準拠」になります。こうした状況は、マシン テンプレートが同じマシン キーを使用して更新サーバーと通信しているときに、接続されているマシンの 1 つが更新を受信できず、マシン テンプレートの全体的なステータスに影響する場合に発生します。

これを回避するには、テナントのコンテキストで [設定] メニューの [全般] セクションにアクセスし、クライアント バイナリのチェック ボックスをオンにして非アクティビティ間隔を設定します。これにより、非アクティブなマシンが更新プロセスから除外され、更新ステータスの報告時に考慮されなくなります。

ユーザーのバージョンのステータス

Orchestrator の [ロボット] タブの [バージョンのステータス] 列では、ユーザーのクライアント コンポーネントのバージョンのステータスを、関連付けられたポリシーと照合できます。

更新バージョンを管理する

Orchestrator のインスタンスがインターネットにアクセスできる場合、既定ではバージョン管理が UiPath によって行われ、ポリシー内の利用可能なバージョンのリストが自動的に入力されます。バージョンを手動で管理する必要がある場合は、ホスト レベルの [設定] に移動して [全般] を選択し、[利用可能な製品バージョンを自動入力] チェックボックスをオフにします。

UiPath でバージョン管理を行わない場合、または使用している Orchestrator インスタンスがインターネットにアクセスできない場合は、以下の手順を使用して、UiPath Customer Portal の製品ダウンロード ページからクライアント コンポーネントのインストーラーを手動でダウンロードし、更新サーバーにアップロードする必要があります。

1. ホスト管理者としてホスト テナント/組織にログインし、新しいタブを開いて https://baseURL/identity_/api/Account/ClientAccessToken に移動した後、インストール トークンが取得されます。
2. ClientId と ClientSecret の値を設定するには、以下のスクリプトを実行します。
   注:

   以下のコマンドに必要なスクリプトは、Customer Portal の [製品ダウンロード] セクションから UiPath Update Server Scripts をダウンロードして取得できます。

   スクリプトで使用するサポート対象の製品バージョンについては、プロダクト ライフサイクルのドキュメントのページをご覧ください。更新スクリプトでは、バージョンの短い形式 (例: 2022.4.3 ではなく 22.4.3) が使用されます。

   .\Provision-IdentityClient.ps1 -IdentityUri "<IDENTITY_URL>" -InstallationToken "<INSTALLATION_TOKEN>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>"

   ClientId と ClientSecret に設定した値は、後で Product-Versions.ps1 スクリプトを呼び出すときに使用する必要があります。

利用可能なバージョンを取得

.\Product-Versions.ps1 get -ApiBaseUri "<ORCHESTRATOR_URL>" -IdentityUri "<IDENTITY_URL>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>"

更新サーバーで新しいバージョンを公開

.\Product-Versions.ps1 register -ApiBaseUri "<ORCHESTRATOR_URL>" -IdentityUri "<IDENTITY_URL>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>" -ProductId "b69fdacf-6dd0-46fb-88c7-af2d87caf5aa" -Version "<NEW_VERSION>" -DownloadUri "<DOWNLOAD_URL>".\Product-Versions.ps1 register -ApiBaseUri "https://intranet/orchestrator_" -IdentityUri "https://intranet/identity_" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>" -ProductId "b69fdacf-6dd0-46fb-88c7-af2d87caf5aa" -Version "22.4.3" -DownloadUri "https://download.uipath.com/versions/22.10.3/UiPathStudio.msi"

更新サーバーから特定のバージョンを削除

DELETE
.\Product-Versions.ps1 delete -ApiBaseUri "<ORCHESTRATOR_URL>" -IdentityUri "<IDENTITY_URL>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>" -ProductId "b69fdacf-6dd0-46fb-88c7-af2d87caf5aa" -Version "<NEW_VERSION>"

クライアント マシンで新しいバージョンを公開

.\Provision-IdentityClient.ps1 -IdentityUri "<IDENTITY_URL>" -InstallationToken "<INSTALLATION_TOKEN>" -ClientId "<CLIENT_ID>" -ClientSecret "<CLIENT_SECRET>"

要件に応じて、以下の製品 ID をスクリプトで使用できます。

Productid	製品
FD97813F-44F7-45A0-BB55-0DAF0088F568	Mac 用の UiPath Assistant (x64)
46C978F2-A5FE-4F71-AD88-D6A07118F790	Mac 用の UiPath Assistant (arm64)
B69FDACF-6DD0-46FB-88C7-AF2D87CAF5AA	UiPath オートメーション バンドル (UiPathStudio.msi)

プロキシ構成

ロボットがプロキシの背後にある場合、自動更新機能を動作させるには、さらに設定が必要になる場合があります。インストールの種類に応じて、プロキシの設定はユーザー レベルのプロキシ設定から継承できる場合と、構成ファイルを編集して手動で設定できる場合があります。

インストールの種類	ロボットのデプロイ	更新サービス	エージェントを更新	プロキシ設定
Unattended ロボット	Windows サービス	Windows サービス	N/A 1	uipath.config ファイルより
Attended ロボット	ユーザー レベルの実行可能ファイル	Windows サービス	ユーザー レベルの実行可能ファイル	uipath.config ファイルより
クイック インストール	ユーザー レベルの実行可能ファイル	ユーザー レベルの実行可能ファイル	ユーザー レベルの実行可能ファイル	ユーザー レベルのプロキシ設定より

1 ロボットが無人モードでインストールされている場合、マシンには更新エージェントが追加されません。

エラー ログを収集する

更新に失敗した場合は、診断ツールを使用してログを収集できます。このログは、サポート チームに送付して、特定のエラーについての詳細な調査に使用できます。

エラー メッセージ

診断ツールの設定