订阅

UiPath Orchestrator

UiPath Orchestrator 指南

Auto updating client components

本文介绍了有关更新功能的一些关键概念,该功能允许管理员一次将多个 UiPath 客户端产品更新到新版本。

About


此功能允许管理员从 Orchestrator 将 Robot、Studio 和 UiPath Assistant 客户端更新到较新版本。这提供了一种从集中位置向大量计算机交付版本更新的简单方法,从而帮助消除用户的烦恼并简化更新过程。

先决条件

  1. Orchestrator Cloud、Studio 和 Robot 2021.10 或更高版本。
  2. 客户端计算机上安装了 Studio 和/或 Robot 2021.10 或更高版本,并且已连接到 Orchestrator。

更新过程中涉及的组件


客户端

  • 客户端应用程序:
    • 机器人
    • Assistant
    • Studio
  • 机器人服务
  • Update Agent - a Windows process responsible for the communication between the user and update service. (only present in the user mode and attended robot installation)
  • 更新服务 - 负责客户端计算机和更新服务器之间的通信的 Windows 服务。

服务器端

  • Orchestrator: provides the user interface for administrators to set auto-update policies and see the version status for client apps.
  • 更新服务器:一个集中式服务,用于管理自动更新策略并通过更新服务维护与客户端计算机的通信。

工作原理


作为管理员,您可以选择要在特定计算机上部署的特定版本。

For this to happen, when Studio and Robot are installed, two executables are also added to the machine: UiPath.UpdateService.Worker.exe and UiPath.UpdateService.Agent.exe.
Depending on the type of Studio/Robot installation, they are installed run in a different way:

  • Unattended Robot: UiPath.UpdateService.Worker.exe is installed as Windows Service and UiPath.UpdateService.Agent.exe is not installed.
  • Attended Robot: UiPath.UpdateService.Worker.exe is installed as Windows Service; UiPath.UpdateService.Agent.exe is installed as LogOn Task in Task Scheduler.
  • Quick Install (user mode): UiPath.UpdateService.Worker.exe and UiPath.UpdateService.Agent.exe are installed as LogOn Tasks in Task Scheduler.

🚧

重要

When installing UiPath Studio and Robot on the machine in attended - user mode, for the update service to connect to the update server, make sure to add the Orchestrator URL during setup. If the Orchestrator URL is not added during installation, a user with administrator rights on the machine has to log on to the machine and connect the robot to Orchestrator.

定义新策略或更改策略后,更新服务器会向客户端计算机上的更新服务发送一个命令,该命令会询问客户端应用程序是否准备好开始更新过程。

要准备好接收更新,产品必须处于中性状态:

  • Studio - 无正在运行的流程或活动会话。
  • Robot - 无正在运行的作业或流程。
  • Assistant - 无正在运行的流程或待处理活动(正在安装或下载流程)。

📘

备注:

在更新过程中,在更新完成之前,机器人不会启动任何作业。

在有人值守场景中,系统会显示更新提示,为用户提供两个选项:

  • Update Now- 停止所有正在运行的作业并关闭该计算机上的所有 Studio 实例,然后继续更新。
  • Later - mutes the notification and the update process can be resumed by going to the UI icon in the system tray and clicking check for updates.
    When the user accepts the prompt, the confirmation is sent to the update service and the update process starts. If no response is provided in 24 hours since the first notification, the update installed automatically.

在无人值守场景中,更新服务会确认客户端应用程序是否处于中性状态(如上所述),然后再将确认发送回更新服务器。

📘

备注:

如果计算机上有任何流程正在运行,系统会提示用户选择要停止该流程,还是等待流程完成再继续更新。如果 Studio 会话已打开,则系统会提示用户保存进度。
如果用户未响应,则 Studio 将关闭,此时流程将保持原样,并且可以在更新完成后恢复,而机器人会等待任何流程完成,然后再开始更新过程。

更新过程步骤

更新过程分为七个阶段:

  1. 正在下载
  • The update service is checking the update server every three hours for an update request. If the update request is received, the update process starts the download process. If the download process has been started successfully, the update request is added to the update server database with the status Downloading.
  1. 已下载
  • Downloaded状态充当标记,以便更新服务可以启动后处理阶段。此状态表示已成功下载更新文件。
  1. 正在处理
  • 此步骤将对下载的文件进行后处理。在此步骤中,将检查文件,如果没有出现错误,则安装过程将启动。
  1. 准备安装
  • The update agent informs the user that an update is awaiting install and asks for approval or checks if the client apps are ready to receive the update.
  1. 已批准安装
  • 一旦更新服务收到批准,便开始实际安装。
  1. 正在安装
  • 新版本将安装到计算机上,并保持与先前版本相同的设置。
  1. 成功/错误
  • Based on the install result, the update status is reported back to the update server and in the Orchestrator interface.

重试机制

During the update process, if the file cannot be retrieved in the first download, the update service retries three more times. The retry intervals are: one hour after the initial attempt, then two hours after the first retry, and four hours after the last retry. Before each retry, the user is informed through the notification system.

For each download attempt, the logs are added to the Orchestrator update logs and locally on the machine in the %localappdata%/Uipath/UpdateService/logs file.

该过程与安装类似,这意味着如果第一次安装失败,更新服务将以相同的频率(首次尝试后一小时,第一次重试后两小时,以及最后一次重试后四个小时)再尝试三次。

The update server waits 72 hours for the update to complete since it started. If the new version is not installed after this interval expires, a detailed error is added to the logs. The update is retried the next time a request is received.

服务模式与用户模式机器人部署


服务模式和用户模式部署在服务器端的技术方面相同,因为它们在更新服务器和更新服务之间使用相同的连接类型。区别在于机器人服务如何与客户端计算机上的更新服务通信,如下所述。

服务模式

在服务模式部署中,机器人服务和更新服务都在本地系统帐户会话中运行。

用户模式

在用户模式部署中,机器人服务在用户会话中运行,而更新服务在本地系统帐户会话中运行。

🚧

重要提示:

在用户模式下部署机器人和 Studio 时,将更新命令发送到计算机上的一个机器人会影响该特定计算机上的所有用户。

❗️

重要

更新过程完成后,必须手动启动 Studio 和机器人。

配置策略


可以为用户、用户组(推荐用于有人值守用例)或计算机(推荐用于无人值守用例)设置策略。

配置用户/用户组的策略

通过为用户或用户组配置更新策略,管理员可以控制特定用户或用户组的 Studio、Robot 和 Assistant 版本。

  • 特定用户 - 精细更新与特定用户相关联的组件。
  • 用户组 - 更新所有组成员的访问权限,而无需单独设置每个用户的访问权限级别。

通过在 Orchestrator 的“管理访问权限”选项卡中编辑特定用户或组来配置策略。

  1. 导航到“租户”>“管理访问权限”。系统将显示“用户”窗口。
  2. 对于所需的用户/用户组,单击“编辑”。系统将显示“编辑用户”窗口。
  3. In the Update policy settings section, change the auto-update policy to one of the following values:

按用户

按组

📘

备注:

如果将应用于用户的策略设置为 None,但用户所属的组也设置了特定策略(例如最新补丁),则应用组策略。如果不希望更新该特定用户的组件,则必须从具有该策略的组中删除该用户,或者将更新策略设置为已安装的当前版本。
如果用户设置了推送特定版本的策略,并且他们也属于具有不同策略的组,则以用户级别策略为准。

配置计算机对象的策略

通过为计算机对象配置更新策略,管理员可以使用该计算机密钥更新连接到 Orchestrator 的所有计算机上的 Robot 版本。配置在计算机对象级别完成:

  1. 导航到“租户”>“计算机”。系统将显示“计算机”窗口。
  2. 对于所需的计算机对象,单击“编辑”。系统将显示“编辑计算机”窗口。
  3. In the Update policy settings section, change the update policy to one of the following values:

策略优先级

如果用户级别策略、组级别策略和计算机级别策略同时应用于同一个机器人,则以用户级别策略为准。

示例:

  • 计算机 1 已安装 Robot 和 Studio 版本 2021.10。
  • On machine_1, the robot is connected to Orchestrator through Interactive Sign In with the [email protected] user.
  • An update policy applies to [email protected] which is set to push the 2021.10.2 version.
  • [email protected] is also part of group_1.
  • 更新策略将应用于组 1,该策略设置为推送版本 2021.10.3。
  • An update policy applies to machine_1 which is set to push the 2022.4 version.
    Result: when the update policies trigger, the components on that machine are updated to 2021.10.2 version.

📘

备注:

When using Robot Accounts please note that the machine-level policy is used in order to handle the update.

策略中的版本可用性

创建更新策略时,可以选择以下选项之一:

最新主要版本

最新补丁

特定补丁

安装在更新服务器上找到的最新可用版本。

安装适用于每个受支持版本的最新补丁。(例如,最新的 2021.10 补丁、最新的 2022.4 补丁)。

安装更新服务器提供的补丁列表中的特定补丁。

更新日志


In the Orchestrator user interface, the update logs are available for failed and successful updates. Complete logs for the update are found on the machine in the %localappdata%/Uipath/UpdateService/logs file.

❗️

重要

在克隆计算机的虚拟环境中部署机器人时,计算机名称、GUID、驱动器 ID 和 MAC 地址相同。这可能会导致冲突,因为 Orchestrator 会从多台具有相同标识符的计算机接收不同的更新状态。
在这种情况下,系统会根据连接的最后一台计算机显示 Orchestrator 中的更新状态。
这也可能会影响 Orchestrator 日志,因为多台计算机具有相同的标识符,因此可能会出现重复的日志。

版本状态


在“版本状态”列中,您可以根据关联的策略检查计算机的 Robot 版本状态。

提供以下值:

  • searchsearch No policy - no policy is defined
  • searchsearch Update in progress - this status is presented when the update process is ongoing on the machine
  • searchsearch Compliant – the robot version on the machine is matching to the update policy.
  • searchsearch 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)
  • searchsearch 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 版本状态。

🚧

备注:

Elastic Robots are not compatible with the Auto-Update feature. For these, the version status shows as N/A with the "Auto-update is not applicable for this type of machine" tooltip.

排除非活动的计算机

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.
To avoid this, access the General section of the Settings menu at the tenant context, select the Client Binaries checkbox and set the preferred inactivity interval. This excludes inactive machines from the update process and no longer takes them into account when the update status is reported.

用户的版本状态

在 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.

安装类型

Robot Deployment

Update Service

Update Agent

Proxy Settings

无人值守的机器人

Windows Service

Windows Service

N/A 1

From the uipath.config file.

有人值守的机器人

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 the robot is installed in unattended mode, the update agent is not added to the machine.

Collecting Error Logs

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.

Error Message

Diagnostic Tool Setup

Updated 2 days ago


Auto updating client components


本文介绍了有关更新功能的一些关键概念,该功能允许管理员一次将多个 UiPath 客户端产品更新到新版本。

建议的编辑仅限用于 API 参考页面

您只能建议对 Markdown 正文内容进行编辑,而不能建议对 API 规范进行编辑。