自动更新客户端组件

关于

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

注意： 自动更新客户端组件功能仅适用于将已安装的机器人、Studio 和 UiPath Assistant 产品更新到较新版本。 如果需要降级版本，则必须手动或使用独立于 UiPath 的工具完成降级过程。

先决条件

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

更新过程中涉及的组件

客户端

• 客户端应用程序：

  • 机器人
  • Assistant
  • Studio
• 机器人服务
• 更新代理 - 一个 Windows 进程，负责用户和更新服务之间的通信。 （仅在用户模式和有人值守的机器人安装中存在）
• 更新服务 - 负责客户端计算机和更新服务器之间的通信的 Windows 服务。

服务器端

• Orchestrator：为管理员提供用户界面，以设置自动更新策略并查看客户端应用程序的版本状态。
• 更新服务器：一个集中式服务，用于管理自动更新策略并通过更新服务维护与客户端计算机的通信。

工作原理

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

为此，在安装 Studio 和 Robot 时，还会将两个可执行文件添加到计算机中：UiPath.UpdateService.Worker.exe 和 UiPath.UpdateService.Agent.exe。

根据 Studio/Robot 安装的类型，它们的安装方式不同：

• Unattended Robot：UiPath.UpdateService.Worker.exe 已安装为 Windows 服务，但未安装 UiPath.UpdateService.Agent.exe。
• Attended Robot：UiPath.UpdateService.Worker.exe 已安装为 Windows 服务，而 UiPath.UpdateService.Agent.exe 在任务计划程序中作为登录任务安装。
• 快速安装（用户模式）：UiPath.UpdateService.Worker.exe 和 UiPath.UpdateService.Agent.exe 在任务计划程序中作为登录任务安装。
  重要提示： 在有人值守的用户模式下按计算机安装 Studio 和机器人时，为了使更新服务连接到更新服务器，请确保在安装过程中添加 Orchestrator URL。 如果在安装期间未添加 Orchestrator URL，则在计算机上具有管理员权限的用户必须登录到计算机并将机器人连接到 Orchestrator。

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

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

• Studio - 无正在运行的流程或活动会话。
• Robot - 无正在运行的作业或流程。
• Assistant - 无正在运行的流程或待处理活动（正在安装或下载流程）。
  注意：在更新过程中，在更新完成之前，机器人不会启动任何作业。

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

• Update Now- 停止所有正在运行的作业并关闭该计算机上的所有 Studio 实例，然后继续更新。
• Later- 使通知静音，可以通过转到系统托盘中的用户界面图标并单击“检查更新”来继续更新过程。

  当用户接受提示时，系统会将确认消息发送到更新服务，并启动更新流程。 如果自首次通知后 24 小时内未提供响应，则系统将自动安装更新。

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

备注：

如果计算机上有任何流程正在运行，系统会提示用户选择要停止该流程，还是等待流程完成再继续更新。如果 Studio 会话已打开，则系统会提示用户保存进度。

如果用户未响应，则 Studio 将关闭，此时流程将保持原样，并且可以在更新完成后恢复，而机器人会等待任何流程完成，然后再开始更新过程。

更新过程步骤

更新过程分为七个阶段：

1. 正在下载
   • 更新服务每三个小时检查一次更新服务器是否有更新请求。 如果收到更新请求，则更新流程将启动下载流程。 如果下载过程已成功启动，则更新请求将添加到更新服务器数据库中，状态为Downloading 。
2. 已下载
   • Downloaded状态充当标记，以便更新服务可以启动后处理阶段。此状态表示已成功下载更新文件。
3. 正在处理
   • 此步骤将对下载的文件进行后处理。在此步骤中，将检查文件，如果没有出现错误，则安装过程将启动。
4. 准备安装
   • 更新代理会通知用户正在等待安装更新，并请求批准或检查客户端应用程序是否已准备好接收更新。
5. 已批准安装
   • 一旦更新服务收到批准，便开始实际安装。
6. 正在安装
   • 新版本将安装到计算机上，并保持与先前版本相同的设置。
7. 成功/错误
   根据安装结果，更新状态会重新报告给更新服务器。

   注意： 如果机器人计算机上已安装 Chrome 扩展 程序，则自动更新功能也会对其进行更新。 否则，必须手动安装扩展程序。

重试机制

在更新过程中，如果在首次下载中无法检索到文件，则更新服务将再重试三次。重试间隔为：首次尝试后一小时，然后在第一次重试后两个小时，以及最后一次重试后四个小时。在每次重试之前，都会通过通知系统通知用户。

每次尝试下载时，系统会将日志添加到 Orchestrator 更新日志中，并添加到计算机本地的 %localappdata%/Uipath/UpdateService/logs 文件中。

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

自启动后，更新服务器会等待 72 小时让更新完成。如果在此间隔后仍未安装新版本，则系统会将详细错误添加到日志中。下次收到请求时，将重试更新。

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

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

服务模式

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

用户模式

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

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

警告：更新过程完成后，必须手动启动 Studio 和机器人。

配置策略

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

配置用户/用户组的策略

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

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

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

1. 导航到“租户”>“管理访问权限”。系统将显示“用户”窗口。
2. 对于所需的用户/用户组，单击“编辑”。系统将显示“编辑用户”窗口。
3. 在“ 更新策略设置 ”部分中，将自动更新策略更改为以下 值之一：

按用户

按组

备注：

如果将应用于用户的策略设置为 None，但用户所属的组也设置了特定策略（例如最新补丁），则应用组策略。如果不希望更新该特定用户的组件，则必须从具有该策略的组中删除该用户，或者将更新策略设置为已安装的当前版本。

如果用户设置了推送特定版本的策略，并且他们也属于具有不同策略的组，则以用户级别策略为准。

每台计算机对象

通过为计算机对象配置更新策略，管理员可以使用特定的计算机密钥更新连接到 Orchestrator 的所有计算机上的机器人版本。

要为计算机对象配置更新策略，请按照以下步骤操作：

1. 导航到“租户”>“计算机”。系统将显示“计算机”窗口
2. 对于所需的计算机对象，单击“编辑”。系统将显示“编辑计算机”窗口。
3. 访问“维护”选项卡。系统将显示“自动更新”配置菜单。
4. 使用此处描述的选项配置更新策略。
   

自动更新计划

在“维护”选项卡中，您还可以安排更新在特定时间和日期开始，以配合公司的其他维护窗口。您还可以设置维护窗口的持续时间。如果为维护窗口设置的时间已过，但更新未开始，则会在下一个可用的时间间隔内安排更新。

策略优先级

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

示例：

• 计算机 1 已安装 Robot 和 Studio 版本 2021.10。
• 在计算机 1 上，机器人以 [e-mail] 用户身份通过交互式登录连接到 Orchestrator。
• 更新策略将应用于 [e-mail]，该策略设置为推送版本 2021.10.2。
• [e-mail] 也属于组 1。
• 更新策略将应用于组 1，该策略设置为推送版本 2021.10.3。

• 更新策略将应用于计算机 1，该策略设置为推送版本 2022.4。

  结果：触发更新策略时，该计算机上的组件将更新到版本 2021.10.2。

  注意：使用机器人帐户时，系统将使用计算机级别策略来处理更新。

策略中的版本可用性

创建更新策略时，可以选择以下选项之一：

最新主要版本	最新补丁	特定补丁
安装在更新服务器上找到的最新可用版本。	安装适用于每个受支持版本的最新补丁。（例如，最新的 2021.10 补丁、最新的 2022.4 补丁）。	安装更新服务器提供的补丁列表中的特定补丁。

更新日志

在 Orchestrator 用户界面中，更新日志可用于失败和成功的更新。 可在计算机上的%localappdata%/Uipath/UpdateService/logs文件中找到更新的完整日志。

警告：

在克隆计算机的虚拟环境中部署机器人时，计算机名称、GUID、驱动器 ID 和 MAC 地址相同。这可能会导致冲突，因为 Orchestrator 会从多台具有相同标识符的计算机接收不同的更新状态。

在这种情况下，系统会根据连接的最后一台计算机显示 Orchestrator 中的更新状态。

这也可能会影响 Orchestrator 日志，因为多台计算机具有相同的标识符，因此可能会出现重复的日志。

版本状态

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

提供以下值：

• “无策略”- 未定义策略
• “正在进行更新”- 计算机上正在进行更新过程时，将显示此状态
• 合规 – 计算机上的机器人版本与更新策略匹配。
• “不合规”- 计算机上的 Robot 版本不同于策略中设置的版本。（例如，Robot 版本为 2021.10.3，而策略设置为 2021.10.1）
• “更新失败”- 更新过程失败时，将显示此状态。有关更多详细信息，请参阅更新日志。
• “不适用”- 当启用忽略非活动计算机的设置，并且机器人有一段时间未连接时，或者当计算机类型与自动更新流程不兼容时，会显示此状态。

计算机的版本状态

在 Orchestrator“计算机”选项卡上的“版本状态”列中，您可以根据关联的策略检查计算机的 Robot 版本状态。

重要提示： Linux 机器人 与自动更新功能不兼容。 对于这些，版本状态显示为 N/A ，并带有“自动更新不适用于此类计算机”工具提示。

排除非活动的计算机

如果多台计算机使用同一个密钥连接到 Orchestrator，但其中一台计算机处于非活动状态，则计算机模板的版本状态将变为 Non compliant。这是因为计算机模板使用同一个计算机密钥与更新服务器通信，如果连接的一台计算机无法接收更新，则计算机模板的整体状态会受到影响。

为避免这种情况，请在租户上下文中访问“设置”菜单的“常规”部分，选中“客户端二进制文件”复选框并设置首选的非活动间隔。这会将非活动的计算机排除在更新过程之外，并且在报告更新状态时不再考虑它们。

用户的版本状态

在 Orchestrator 的“机器人”选项卡上的“版本状态”列中，您可以根据关联的策略检查用户的客户端组件版本状态。

管理更新版本

如果您的 Orchestrator 实例可以访问互联网，则默认情况下，版本管理由 UiPath 完成，并且策略中的可用版本列表将自动填充。如果要手动管理版本，请在主机级别转到“设置”，选择“常规”，然后清除“自动填充可用产品版本”复选框。

如果您选择不让 UiPath 完成版本管理，或者您的 Orchestrator 实例无法访问互联网，则必须从 UiPath Customer Portal - 产品下载页面 手动下载客户端组件的安装程序，并使用步骤如下：

1. 在您以主机管理员身份登录到主机租户/组织，打开一个新选项卡并转到 https://baseURL/identity_/api/Account/ClientAccessToken 后，将获得安装令牌。
2. 要设置 ClientId 和 ClientSecret 的值，请运行以下脚本：
   备注：

   可以从 Customer Portal 的“产品下载”部分下载 UiPath 更新服务器脚本，以检索以下命令所需的脚本。

   要在脚本中使用的受支持产品版本可在 产品生命周期文档 页面中找到。 对于更新脚本，使用版本的短格式（例如 22.4.3 而不是 2022.4.3）。

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

   稍后在调用 Product-Versions.ps1 脚本时应使用为 ClientId 和 ClientSecret 设置的值

获取可用版本

.\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：

产品 ID	产品
FD97813F-44F7-45A0-BB55-0DAF0088F568	适用于 Mac (x64) 的 UiPath Assistant
46C978F2-A5FE-4F71-AD88-D6A07118F790	适用于 Mac (arm64) 的 UiPath Assistant
B69FDACF-6DD0-46FB-88C7-AF2D87CAF5AA	UiPath Automation 捆绑包 (UiPathStudio.msi)

代理配置

对于机器人位于代理后面的场景，要使自动更新功能正常工作，可能需要进行其他配置。 根据安装类型，代理配置可以从用户级代理设置继承，也可以通过 编辑配置文件手动设置。

安装类型	机器人部署	更新服务	更新代理	代理设置
无人值守的机器人	Windows 服务	Windows 服务	不适用1	来自uipath.config文件。
有人值守的机器人	用户级可执行文件	Windows 服务	用户级可执行文件	来自uipath.config文件。
快速安装	用户级可执行文件	用户级可执行文件	用户级可执行文件	从用户级别代理设置。

1当机器人以无人值守模式安装时，更新代理不会添加到计算机中。

收集错误日志

当更新失败时，您可以使用 诊断工具 收集日志，这些日志可以发送给我们的支持团队，用于进一步调查特定错误。

错误消息

诊断工具设置