概要
管理者はこの機能を使用して、Orchestrator から Robot、Studio、UiPath Assistant のクライアントを新しいバージョンに更新できます。この機能により、大規模なマシン ベースのバージョン更新を一元化された場所から容易に実行できるため、ユーザーの負担が解消され、更新プロセスが効率化されます。
前提条件
- Orchestrator Cloud、Studio、Robot 2021.10 以降。
- 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 タスクとしてインストールされます。
重要
UiPath Studio と Robot を Attended ユーザー モードでマシンにインストールする場合、更新サービスが更新サーバーに接続できるよう、設定時に Orchestrator の URL を追加するのを忘れないようにしてください。インストール時に Orchestrator の URL を追加しないと、マシン上の管理者権限を持つユーザーがマシンにログオンしてロボットを Orchestrator に接続しなければなりません。
新しいポリシーが定義または変更されると、更新サーバーはクライアント マシン上の更新サービスにコマンドを送信し、更新プロセスを開始できるかどうかクライアント アプリケーションに確認します。
更新を受け取るには、製品が「中立」ステートである必要があります。
- Studio - 実行中のプロセスやアクティブなセッションがない。
- Robot - 実行中のジョブやプロセスがない。
- Assistant - 実行中のプロセスや保留中のアクティビティ (インストールまたはダウンロード中のプロセス) がない。
注:
更新プロセス中、ロボットは更新が完了するまでジョブを開始しません。
有人シナリオでは更新プロンプトが表示され、以下の 2 つのオプションのいずれかを選択できます。
- 今すぐ更新 - 実行中のジョブをすべて停止し、そのマシン上のすべての Studio インスタンスを閉じてから、更新を続行します。
- 後で - 通知をミュートしておいて、システム トレイで [更新を確認] のアイコンをクリックして更新プロセスを再開することができます。
ユーザーがプロンプトを確認すると、更新サービスに通知され、更新プロセスが開始されます。 最初の通知から 24 時間以内に応答がない場合、更新が自動的にインストールされます。
無人シナリオでは、更新サービスはクライアント アプリケーションのステートが「中立」であることを確認して (前述のとおり)、更新サーバーに通知します。
注:
マシンに実行中のプロセスがある場合は、プロセスを停止するか、終了するまで待機して更新を続行するよう促すメッセージが表示されます。Studio セッションが開いている場合、進行状況を保存するよう促すメッセージが表示されます。
ユーザーが応答しない場合、Studio は閉じられ、プロセスは現状のまま保存されて、更新の完了後に回復することができます。一方、ロボットはプロセスが完了するまで待機し、後から更新プロセスを開始します。
更新プロセスのステップ
更新プロセスは 7 段階に分かれています。
- ダウンロードしています。
- 更新サービスは、更新要求がないかどうかを、更新サーバーに 3 時間ごとに確認します。更新要求を受け取ると、更新プロセスはダウンロード プロセスを開始します。ダウンロード プロセスが正常に開始されると、更新要求は「ダウンロード中」ステータスで更新サーバー データベースに追加されます。
- ダウンロード済み
- 「ダウンロード済み」ステータスはマーカーとして機能するため、更新サービスは後処理フェーズを開始できます。このステータスは、更新ファイルが正常にダウンロードされたことを示します。
- 処理中
- このステップでは、ダウンロードされたファイルの後処理を行います。ファイルが確認され、エラーがなければ、インストール プロセスが開始されます。
- インストールの準備が整う
- 更新エージェントは、更新がインストール待ちであることをユーザーに通知して、インストールの承認を求め、クライアント アプリケーションで更新を受信する準備ができているかどうかを確認します。
- インストールが承認される
- 承認されたことが更新サービスに通知されると、実際のインストールが開始されます。
- インストールしています。
- 前のバージョンと同じ設定を保持したまま、新しいバージョンがマシンにインストールされます。
- 成功/エラー
- インストールの結果に基づいて、更新ステータスが更新サーバーと Orchestrator インターフェイスに報告されます。
リトライ メカニズム
更新プロセスでは、初回のダウンロードでファイルを取得できない場合、更新サービスはあと 3 回リトライします。リトライ間隔は、初回試行の 1 時間後、最初のリトライの 2 時間後、および最後のリトライの 4 時間後です。各リトライの前に、通知システムからユーザーに通知が送信されます。
ダウンロードが試行されるたびに、Orchestrator の更新ログと、ローカルのマシン上の %localappdata%/Uipath/UpdateService/logs ファイルにログが追加されます。
プロセスはインストールの場合も同様です。最初のインストールに失敗すると、更新サービスは同じ頻度で 3 回リトライします (初回試行の 1 時間後、最初のリトライの 2 時間後、および最後のリトライの 4 時間後)。
更新サーバーは、更新を開始してから終了するまで、72 時間待機します。この期間の経過後に新規バージョンがインストールされない場合、詳細なエラーがログに追加されます。更新は、次に要求を受信したときに再試行されます。
サービス モードおよびユーザー モードの Robot のデプロイ
サーバー側の技術的な部分に関しては、サービス モードのデプロイとユーザー モードのデプロイの両方で同じです。更新サーバーと更新サービスとの間で同じ種類の接続を使用するためです。Robot サービスがクライアント マシン上の更新サービスと通信する方法には、以下のような違いがあります。
サービス モード
サービス モードのデプロイでは、Robot サービスと更新サービスの両方がローカル システム アカウント セッションで実行されます。
ユーザー モード
ユーザー モードのデプロイでは、Robot サービスはユーザー セッションで実行され、更新サービスはローカル システム アカウント セッションで実行されます。
重要:
ロボットと Studio がユーザー モードでデプロイされている場合、マシン上の 1 つのロボットに更新コマンドを送信すると、その特定のマシン上のすべてのユーザーに対して実行されます。
重要
更新プロセスが完了したら、Studio と Robot を手動で起動する必要があります。
ポリシーを設定する
ポリシーは、ユーザー、ユーザー グループ (Attended のユースケースに推奨)、またはマシン (Unattended のユースケースに推奨) に設定できます。
ユーザー/ユーザー グループのポリシーを設定する
ユーザーまたはユーザー グループの更新ポリシーを設定すると、管理者は特定のユーザーまたはユーザー グループの Studio、Robot、Assistant のバージョンを管理できます。
- 特定のユーザー - 特定のユーザーに関連付けられているコンポーネントをきめ細かく更新する場合。
- ユーザー グループ - グループのすべてのメンバーのアクセス権を更新して、ユーザーごとにアクセス レベルを設定しなくても済むようにする場合。
Automation Express ライセンスが割り当てられているユーザーの場合、更新ポリシーは編集できず、最新の Enterprise バージョンを提供するように設定されます。
ポリシーを設定するには、Orchestrator の [アクセス権を管理] タブで特定のユーザーまたはグループを編集します。
- [テナント] > [アクセス権を管理] に移動します。[ユーザー] ウィンドウが表示されます。
- 目的のユーザー/ユーザー グループで、[編集] をクリックします。[ユーザーを編集] ウィンドウが表示されます。
- [ポリシーの設定を更新] セクションで、自動更新ポリシーを以下のいずれかの値に変更します。
ユーザーごと
グループごと
注:
ユーザーに適用されるポリシーが [なし] に設定されていても、そのユーザーが特定のポリシー ([最新のパッチ] など) が設定されたグループのメンバーでもある場合は、そのグループのポリシーが適用されます。その特定のユーザーのコンポーネントが更新されないようにする場合は、ポリシーが割り当てられたグループからユーザーを削除するか、インストールされている最新バージョンになるように更新ポリシーを設定します。
ユーザーに特定のバージョンをプッシュするポリシーが設定されていても、そのユーザーが別のポリシーが割り当てられたグループのメンバーでもある場合は、ユーザー レベルのポリシーが優先されます。
マシン オブジェクトごと
マシン オブジェクトの更新ポリシーを設定すると、管理者は特定のマシン キーを使用して、Orchestrator に接続されているすべてのマシン上でロボットのバージョンを更新できます。
マシン オブジェクトの更新ポリシーを設定するには、以下の手順を実行します。
- [テナント] > [マシン] に移動します。[マシン] ウィンドウが表示されます。
- 目的のマシン オブジェクトで、[編集] をクリックします。[マシンを編集] ウィンドウが表示されます。
- [メンテナンス] タブにアクセスします。[自動更新] 設定メニューが表示されます。
- こちらに記載されているオプションを使用して、更新ポリシーを設定します。
自動更新のスケジュール設定
[メンテナンス] タブで、更新を特定の日時に開始するようスケジュール設定し、社内の他のメンテナンス ウィンドウとタイミングを合わせることができます。メンテナンス ウィンドウの期間を設定することもできます。メンテナンス ウィンドウに設定された期間が過ぎても更新が開始されなかった場合は、次に利用可能な期間内にスケジュールされます。
ポリシーの優先度
ユーザー レベルのポリシー、グループ レベルのポリシー、マシン レベルのポリシーが同じロボットに適用されている場合、ユーザー レベルのポリシーが優先されます。
例：
- Machine_1 には、2021.10 バージョンの Robot と Studio がインストールされています。
- Machine_1 では、ロボットは John.Doe@domain.com ユーザーによる対話型サインインを通じて Orchestrator に接続されています。
- 2021.10.2 バージョンをプッシュするように設定されている更新ポリシーが、john.doe@domain.com に適用されます。
- john.doe@domain.com は group_1 にも属しています。
- group_1 には v2021.10.3 をプッシュするように設定されている更新ポリシーが適用されています。
- 2022.4 バージョンをプッシュするように設定されている更新ポリシーが、machine_1 に適用されます。
結果: 更新ポリシーがトリガーされると、そのマシン上のコンポーネントは 2021.10.2 バージョンに更新されます。
注:
ロボット アカウントを使用する場合、更新の処理にはマシンレベルのポリシーが使用されることに注意してください。
ポリシーで利用可能なバージョン
更新ポリシーを作成するときに、以下のいずれかのオプションを選択できます。
| Latest major version | Latest patch | Specific patch |
|---|---|---|
| Installs the latest available version found on the update server. | Installs the latest patch available for each of the supported versions. (e.g. Latest 2021.10 patch, Latest 2022.4 patch). | Installs a specific patch from the list of the ones available in the Update Server. |
更新ログ
Orchestrator のユーザー インターフェイスでは、失敗および成功した更新についての更新ログを利用できます。更新の完全なログは、マシン上の %localappdata%/Uipath/UpdateService/logs ファイルにあります。
重要
マシンが複製されている仮想環境にロボットをデプロイすると、マシン名、GUID、ドライブ ID、mac アドレスは同じになります。これにより、競合が発生することがあります。Orchestrator は同じ ID を持つ複数のマシンから異なる更新ステータスを受け取るためです。
このシナリオでは、Orchestrator の更新ステータスは、接続した最後のマシンに基づいて表示されます。
このことは、Orchestrator のログにも影響を与える場合があります。複数のマシンが同じ ID を持つため、重複するログが表示される可能性があります。
バージョンのステータス
[バージョンのステータス] 列では、マシンの Robot のバージョンのステータスを関連付けられたポリシーと照合できます。
次の値を使用できます。
No policy - no policy is defined
Update in progress - this status is presented when the update process is ongoing on the machine
Compliant – the robot version on the machine is matching to the update policy.
Non-compliant - the robot version on the machine is different than what was setup in the policy. (e.g. robot version is 2021.10.3, the policy is set up as 2021.10.1)
Update failed - this status shows when the update process failed. More details can be found in the update logs.- N/A - this status shows up when the setting to ignore inactive machines is enabled and the robot hasn’t been connected for a while, or when the machine type is not compatible with the auto-update process.
マシンのバージョンのステータス
Orchestrator の [マシン] タブの [バージョンのステータス] 列では、マシンの Robot のバージョンのステータスを関連付けられたポリシーと照合できます。
注:
エラスティック ロボットは、自動更新機能と互換性がありません。これらのロボットについては、バージョンのステータスが
N/Aとなり、ツールチップに「この種類のマシンには、自動更新は適用されません。」と表示されます。
非アクティブなマシンを除外する
If multiple machines are connected to Orchestrator using the same key and one of them is inactive, the version status of the machine template becomes Non compliant. This is happening as the machine template communicates with the update server using the same machine key, and if one of the machines connected is unable to receive an update, the overall status of the machine template is impacted.
これを回避するには、テナントのコンテキストで [設定] メニューの [全般] セクションにアクセスし、クライアント バイナリのチェック ボックスをオンにして非アクティビティ間隔を設定します。これにより、非アクティブなマシンが更新プロセスから除外され、更新ステータスの報告時に考慮されなくなります。
ユーザーのバージョンのステータス
Orchestrator の [ロボット] タブの [バージョンのステータス] 列では、ユーザーのクライアント コンポーネントのバージョンのステータスを、関連付けられたポリシーと照合できます。
プロキシ構成
For scenarios in which the robots are sitting behind a proxy, for the auto-update feature to work, additional configuration might be needed. Based on the installation type, proxy configurations can either be inherited from the user-level proxy settings, or set manually by editing the uipath.config file.
| Installation Type | Robot Deployment | Update Service | Update Agent | Proxy Settings |
|---|---|---|---|---|
| Unattended Robot | Windows Service | Windows Service | N/A 1 | From the uipath.config file. |
| Attended Robot | User-level executable | Windows Service | User-level executable | From the uipath.config file. |
| Quick Install | User-level executable | User-level executable | User-level executable | From the user level proxy settings. |
1 ロボットが無人モードでインストールされている場合、マシンには更新エージェントが追加されません。
エラー ログを収集する
When an update fails, you can use the Diagnostic Tool to collect logs which can be sent to our Support Team which are used for further investigation on the specific error.
エラー メッセージ
診断ツールの設定
4 か月前に更新