orchestrator

latest

false

重要 :

新发布内容的本地化可能需要 1-2 周的时间才能完成。

Orchestrator 用户指南

适用平台：

上次更新日期 2025年4月7日

设置

管理员可以在“设置”页面调整 Orchestrator 租户设置。

常规选项卡

字段	描述
应用程序设置	“时区”- 租户的时区。默认情况下，此字段设置为 UTC。 “显示设置”- 包括“高密度视图”选项，该选项默认处于选中状态。取消选择该选项，即可切换到表格项目的低密度显示。这适用于整个租户。
个人工作区	“在个人工作区中为 Studio Web 用户自动配置 WorkSpace 计算机”- 默认选中该选项，从而允许在 Studio Web 中进行设计或调试的用户在个人工作区中自动配置 Serverless 计算机。取消选择该选项可防止在个人工作区中自动创建 Serverless 计算机，这可能会影响 Studio Web 中的设计或调试流程。备注：取消选择该选项不会从您的个人工作区取消分配 Serverless 计算机。可能需要显式取消分配 Serverless 计算机。在以下时间后自动停止探索个人工作区 - 允许 Orchestrator 管理员强制执行规则，该规则规定在一定时间后自动停止个人工作区探索。可用选项包括“15 分钟”、“1 小时”、“1 天”和“自定义值”。默认情况下，迁移或创建新租户时，不会设置此值。迁移/创建过程完成后，您需要手动配置此值。 “停止所有用于探索个人工作区的活动会话”- 允许 Orchestrator 管理员停止所有当前处于活动状态的个人工作区探索会话。它以活动会话数为后缀，显示在括号中，并且可以通过单击“停止会话探索”来启用。您对探索设置所做的更改不会追溯应用于已探索的会话。 “为当前用户和组批量启用个人工作区”- 为租户中使用特定有人值守许可配置文件的所有用户创建个人工作区，同时选择要用于这些用户的用户界面配置文件。此操作无法撤消，一旦启用了个人工作区功能，就无法禁用。
标准角色	为文件夹创建标准角色。这些角色使您能够利用用户组的优势。单击想要创建的每个角色旁边的“创建角色”。
客户端二进制文件（Robot、Studio、Assistant）自动更新设置	“忽略离线超过 ___ 天的机器人计算机的自动更新状态”- 从更新过程中排除不活动的计算机，并且在报告更新状态时不再考虑它们。
文件夹	“启用帐户-计算机映射 ” - 启用“ 帐户-计算机映射”功能。

“执行设置”部分

注意：在本节中，与触发器相关的设置将应用于所有流程类型。但是，与队列和作业相关的设置不适用于代理和代理流程。

字段/默认值	描述
触发器 - 作业计数策略 (`Triggers.JobsCountStrategy`) 默认值：每个流程	为通过触发器启动的作业选择作业计数策略。请注意，该操作不考虑可能已提供的任何参数。可用的选项如下：每个流程 - 触发器启动指定数量的作业，同时考虑到指定流程的所有待处理作业。例如，为同一流程定义的两个触发器分别启动 3 个和 5 个作业。如果第一个触发器在给定的时间点启动了 3 个作业，则当第二个触发器触发时，将启动 2 个作业，以达到 5 个所需的作业。每个触发器 - 触发器启动指定数量的作业，同时考虑到该触发器先前启动的任何现有作业。例如，定义了一个触发器以在给定的时间点启动 5 个作业。如果再次触发此触发器之前已成功完成 3 个作业，则 Orchestrator 将启动另外 2 个作业，以达到 5 个所需的作业。
触发器 - 队列触发器 - 启用待处理作业策略 (`Features.QueueTriggers.PendingJobsStrategy`) 默认值：True	选择将新项目添加到队列时要触发的其他作业数量的计算方法。这是通过从要创建的最大目标作业数中减去处于特定状态的作业数来完成的。可用的选项如下： True - 此选项最适合您希望 Orchestrator 假定所有正在运行的作业已将队列项目移出状态“新建”的情况。该数字的计算方式如下：根据新可用的队列项目创建的最大附加作业数 = 允许同时挂起和运行的最大作业数减去处于“挂起”状态的作业数。 False - 此选项最适合您希望 Orchestrator 假定所有正在运行的作业尚未将队列项目移出状态“新建”的情况。该数字的计算方式如下：根据新可用的队列项目创建的最大附加作业数 = 允许同时挂起和运行的最大作业数减去处于以下状态之一的作业数：“ 待定”、“已恢复”、“正在运行”、“正在停止”、“正在终止”。
触发器 - 任务创建计数失败时禁用 (`Triggers.DisableWhenFailedCount`) 默认值：10	将触发器配置为在特定数量的启动失败并且在特定天数内没有成功运行后自动禁用。此选项可与“触发器 - 任务创建计数持续失败的宽限期（天）”结合使用，如下所示：“触发器 - 任务创建计数失败时禁用”允许您调整失败的运行次数，而“触发器 - 持续失败时禁用计数（天）”可让您更改天数。默认情况下，“触发器 - 任务创建计数失败时禁用”值为 10，“触发器 - 任务创建计数持续失败的宽限期（天）”值为 1，这意味着如果在过去一天中没有成功运行，则在尝试启动 10 次失败后，将禁用触发器。此选项的设置范围为 10 到 100。
触发器 - 任务创建计数持续失败的宽限期 (天) (`Triggers.DisableWhenFailingSinceDays`) 默认值：1	将触发器配置为在特定数量的启动失败并且在特定天数内没有成功运行后自动禁用。如上所述，此选项与“触发器 - 计数失败时禁用”结合使用。设置范围为 1 到 30。
触发器 - 已连接的触发器 - 任务执行计数失败时禁用默认值：5	备注：这仅针对已发布到个人工作区的已连接触发器（即在 Studio Web 中创建的触发器）。在达到您为此设置选择的失败执行次数后，触发器将被禁用。该值的设置范围为 0 到 100，其中 0 表示从不禁用触发器。如果选择 0，则“触发器 - 已连接的触发器 - 任务执行计数持续失败的宽限期（天）”将变得不相关，并且其字段将被禁用。此设置仅对新创建的已连接触发器有效。更改不会追溯应用于现有的已连接触发器。
触发器 - 已连接的触发器 - 任务执行计数持续失败的宽限期 (天) 默认值：0	备注：这仅针对已发布到个人工作区的已连接触发器（即在 Studio Web 中创建的触发器）。此设置指定作业第一次失败后禁用触发器之前要等待的天数。设置范围为 0 到 30。如果将“触发器 - 已连接的触发器 - 作业执行计数失败时禁用”设置为 0，则系统会禁用此字段。
触发器 - API 触发器 - 待处理作业数量上限默认值：10	设置 API 触发器可以创建的待处理作业的最大数量。支持的范围是 1 到 100。
队列 - 超过阈值 (小时) 后放弃正在进行的队列项目 (`inProgressMaxNumberOfMinutes`) 默认值：24	队列项目可以处于“进行中”状态的最大时间。在此时间之后，队列项目的状态将更改为“已放弃”。默认值为 24 小时，这意味着无法将队列项目标记为“已放弃”，除非它们处于“正在进行”状态至少一天。该操作由每小时运行一次的后台作业处理。因此，您最多可以在选定值后一小时内进行转换。
队列 - 未处理的队列项目检查频率 (分钟) (`Queue.ProcessActivationSchedule`) 默认值：30	检查未处理的队列项目之间的时间间隔。要调整检查间隔，您可以在 10、15、20、30 或 60 分钟之间进行选择。对于您创建的每个队列触发器，我们会生成一个后台时间触发器，该触发器用于处理在加入队列时无法处理的队列项目。此后台时间触发器用于计算设置规定的频率。现有队列触发器：首次更改默认值时会应用该设置，并且无法还原。新队列触发器：系统始终应用该设置。重要提示：使用的参考时间戳基于创建队列触发器的时间。例如，如果在 14:22:43 创建队列触发器，并且此选项的设置为 10 分钟，则系统会生成以下重复周期：14:32:43、14:42:43、14:52:43 并以此类推。执行此设置所触发的更改的后台任务最多可能需要 10 分钟才能生效。
作业 - 终止超时 (小时) (`Jobs.TerminatingJobsTimeout`) 默认值：24	设置在“终止”作业适合标记为“失败”之前经过的时间（以小时为单位）。默认值为 24，这意味着无法将作业标记为“失败”，除非它们处于“正在终止”状态至少一天。该操作由每小时运行一次的后台作业处理。因此，您最多可以在选定值后一小时内进行转换。

“API 设置”部分

设置	描述
API 触发器的 CORS 允许列表	用于输入允许输入流量的域。使用逗号或按 Enter 键分隔不同的域。
同步 API 触发器重定向需要身份验证标头	默认情况下启用此选项，并且在为 API 触发器选择同步（长轮询）调用模式时，会强制使用身份验证标头。
精确 API	如果启用，某些 API 字段将变为不可筛选和/或不可排序，从而有助于防止出现性能问题。您可以在专用页面上查看这些字段的列表。此设置默认为新租户启用，但现有租户需要手动选择加入。建议在 API 集成中始终启用此选项。

部署选项卡

使您能够配置和保护包和库的订阅源。您可以使用 Automation Ops 从集中位置管理所有租户的订阅源。有关更多信息，请参阅 Automation Ops 指南中的订阅源管理。

此处的设置仅影响租户订阅源；文件夹订阅源和个人工作区订阅源始终是内部的，并且仅在相应文件夹或个人工作区的上下文中可用。

包

使您能够设置内部或外部订阅源，用以维护自动化包。默认情况下，使用内部订阅源。可以通过定义基本身份验证凭据或使用 API 密钥来保护订阅源。

字段	描述
内部	使用内部订阅源。可以使用“安全部署”选项或 API 密钥来保护订阅源： “安全部署”- 确保通过安全的 NuGet 订阅源下载自动化包。 API 密钥 - 用于保护您的订阅源，使其免受写入操作（例如删除或上传）影响。仅当要使用外部客户端将包直接上传到 NuGet 订阅源时，才需要执行此操作。重要提示：您只能使用“API 密钥”选项对上传的包进行身份验证。要对下载的包进行身份验证，请使用“安全部署”选项。
外部	使用外部订阅源。可以使用 API 密钥或基本身份验证凭据来保护订阅源： “部署 URL*”- NuGet 订阅源所在的地址。 “API 密钥”- 用于保护您的订阅源，使其免受写入操作（例如删除或上传）影响。 “身份验证”- 使您能够为基本经过身份验证的订阅源指定凭据。请记住，在这种情况下，也应使用“API 密钥”选项所用的用户名和密码。

字段

描述

内部

使用内部订阅源。可以使用“安全部署”选项或 API 密钥来保护订阅源：

“安全部署”- 确保通过安全的 NuGet 订阅源下载自动化包。
API 密钥 - 用于保护您的订阅源，使其免受写入操作（例如删除或上传）影响。仅当要使用外部客户端将包直接上传到 NuGet 订阅源时，才需要执行此操作。

重要提示：您只能使用“API 密钥”选项对上传的包进行身份验证。要对下载的包进行身份验证，请使用“安全部署”选项。

外部

使用外部订阅源。可以使用 API 密钥或基本身份验证凭据来保护订阅源：

“部署 URL*”- NuGet 订阅源所在的地址。
“API 密钥”- 用于保护您的订阅源，使其免受写入操作（例如删除或上传）影响。
“身份验证”- 使您能够为基本经过身份验证的订阅源指定凭据。

请记住，在这种情况下，也应使用“API 密钥”选项所用的用户名和密码。

重要提示：我们不支持上传到外部订阅源的跨平台包。只有将这些包的元数据直接上传到 Orchestrator 时，才能读取这些元数据。

Authenticating feeds using JWT bearer tokens through basic authorization

You can specify personal access tokens and other JWT bearer tokens for authenticating your feeds, as shown in the following example:

 curl https://:@cloud.uipath.com/myorg/DefaultTenant/orchestrator_/nuget/v3/5830878b-1a38-47d9-9689-4fb543e2e227/index.jsoncurl https://:<rt_my-reference-token>@cloud.uipath.com/myorg/DefaultTenant/orchestrator_/nuget/v3/5830878b-1a38-47d9-9689-4fb543e2e227/index.json

The common approach across all major NuGet feed provides is to use the basic authorization password for sending the personal access token. This allows you to use the built-in NuGet mechanisms for authentication, as shown in the following example:

 
  
    
  
  
    
      
      
    
  
<configuration>
  <packageSources>
    <add key="myfeed" value="cloud.uipath.com/myorg/DefaultTenant/orchestrator_/nuget/v3/5830878b-1a38-47d9-9689-4fb543e2e227/index.json" />
  </packageSources>
  <packageSourceCredentials>
    <myfeed>
      <add key="Username" value="" />
      <add key="ClearTextPassword" value="%UIPATH_PAT%" />
    </myfeed>
  </packageSourceCredentials>
</configuration>

Additionally, you can integrate the feeds using secure credential providers. For further information, refer to the Microsoft documentation.

库

使您能够配置要用于库和活动包的订阅源。

字段	描述
仅主机订阅源	库存储在主机订阅源中，并且对所有使用主机订阅源的租户可用。“库”页面在整个 Orchestrator 实例中都相同，这意味着库在租户级别不是孤立的：每个租户都可以访问其他租户的活动。如果选择此选项，则无法从 Orchestrator 上传库。此选项仅向机器人授予主机订阅源的访问权限。
仅限租户订阅源	库在租户级别隔离，这意味着数据在租户之间分离。您可以设置用于维护库的内部或外部订阅源。默认情况下，使用内部订阅源。此选项仅向机器人授予租户订阅源的访问权限。
主机和租户订阅源	库在租户级别隔离，这意味着数据在租户之间分离。您可以设置用于维护库的内部或外部订阅源。默认情况下，使用内部订阅源。此选项向机器人授予主机订阅源和租户订阅源的访问权限。
内部	在选择“仅租户订阅源”或“主机订阅源和租户订阅源”时显示。为您的库使用内部订阅源。可以使用“安全部署”选项或 API 密钥来保护订阅源： “安全部署”- 确保通过安全的 NuGet 订阅源下载自动化包。 “API 密钥”- 用于保护您的订阅源，使其免受写入操作（例如删除或上传）影响。
外部	在选择“仅租户订阅源”或“主机订阅源和租户订阅源”时显示。为您的库使用外部订阅源。可以使用 API 密钥或基本身份验证凭据来保护订阅源： “部署 URL”- NuGet 订阅源所在的地址。 “API 密钥”- 用于保护您的订阅源，使其免受写入操作（例如删除或上传）影响。身份验证* - 使您能够为基本经过身份验证的订阅源指定凭据（用户名和密码）。请记住，在这种情况下，也应使用“API 密钥”选项所用的用户名和密码。

有关更多详细信息，请仔细阅读“库订阅源”页面。

机器人安全选项卡

安全性

字段	描述
不进行许可证验证的情况下，机器人可离线运行的总小时数	指定机器人可以离线运行的小时数，而 Orchestrator 不检查其许可证。默认情况下设置为 0。最大接受值为 168 小时。

机器人身份验证

字段	描述
无人值守机器人身份验证	“客户端凭据 (推荐)”- 此选项仅允许使用会过期的令牌进行连接。它使用 OAuth 2.0 框架作为其身份验证协议的基础，这意味着无人值守机器人可以使用通过计算机模板对象生成的客户端 ID - 客户端密码对连接到 Orchestrator。客户端 ID - 客户端密码对生成一个令牌，用于授权机器人和 Orchestrator 之间的连接，并向机器人提供对 Orchestrator 资源的访问权限。 “混合式”- 此选项允许使用未过期的令牌（计算机密钥）进行连接，也支持使用过期的令牌（客户端凭据）进行连接。
有人值守的机器人身份验证	“交互式登录 SSO (推荐)”- 此选项仅允许使用会过期的令牌进行机器人连接。用户只能通过在 Assistant 中使用其凭据登录来对其机器人进行身份验证。需要用户登录才能运行有人值守的机器人、发出 Orchestrator HTTP 请求或在 Assistant 中查看流程。使用交互式登录时，无需在 Orchestrator 中创建计算机对象。 “混合”- 此选项允许使用未过期的令牌（计算机密钥）进行连接，也支持使用过期的令牌（交互式登录或客户端凭据）进行连接。用户可以选择使用其凭据登录以对其机器人进行身份验证，这反过来又允许他们将 Studio 和 Assistant 连接到 Orchestrator，但这不是必需的。

字段

描述

无人值守机器人身份验证

“客户端凭据 (推荐)”- 此选项仅允许使用会过期的令牌进行连接。它使用 OAuth 2.0 框架作为其身份验证协议的基础，这意味着无人值守机器人可以使用通过计算机模板对象生成的客户端 ID - 客户端密码对连接到 Orchestrator。客户端 ID - 客户端密码对生成一个令牌，用于授权机器人和 Orchestrator 之间的连接，并向机器人提供对 Orchestrator 资源的访问权限。

“混合式”- 此选项允许使用未过期的令牌（计算机密钥）进行连接，也支持使用过期的令牌（客户端凭据）进行连接。

有人值守的机器人身份验证

“交互式登录 SSO (推荐)”- 此选项仅允许使用会过期的令牌进行机器人连接。用户只能通过在 Assistant 中使用其凭据登录来对其机器人进行身份验证。

需要用户登录才能运行有人值守的机器人、发出 Orchestrator HTTP 请求或在 Assistant 中查看流程。使用交互式登录时，无需在 Orchestrator 中创建计算机对象。

“混合”- 此选项允许使用未过期的令牌（计算机密钥）进行连接，也支持使用过期的令牌（交互式登录或客户端凭据）进行连接。用户可以选择使用其凭据登录以对其机器人进行身份验证，这反过来又允许他们将 Studio 和 Assistant 连接到 Orchestrator，但这不是必需的。

可扩展性选项卡

指定机器人服务是否应订阅 Orchestrator 的 SignalR 通道，并配置最适合您的传输协议。

SignalR (机器人)

字段	描述
已启用	此开关用于指定机器人服务是否订阅 Orchestrator 的 SignalR 通道。默认情况下，此设置处于启用状态，并且选择所有可用通道： WebSocket 服务器发送事件 (SSE) 长轮询启用所有传输通道后，将按照以下优先级顺序自动选择最佳的可用传输：WebSocket > 服务器发送的事件 > 长轮询。如果第一个协议由于某种原因不可用，则使用下一个协议（如果启用）来促进 Orchestrator 和机器人之间的通信。
WebSocket	如果选择此选项，将使用 WebSocket 传输协议将机器人连接到 Orchestrator 的 SignalR 通道。这是优先级最高的协议，因为其性能出色，并且支持机器人服务与 Orchestrator 的双向同步通信。如果未启用 SignalR（机器人）功能，则 WebSocket 将成为唯一可用的传输协议。
服务器发送事件 (SSE)	如果选择此选项，将使用“服务器发送事件 (SSE)”推送技术将机器人连接到 Orchestrator 的 SignalR 通道。这是 WebSocket 由于任何原因不可用时的首选备用传输协议。如果未启用“SignalR（机器人）”功能，则无法使用此选项。
长轮询	如果选择此选项，将使用长轮询传输协议将机器人连接到 Orchestrator 的 SignalR 通道。如果 WebSocket 和 SSE 都不可用，则使用此协议。如果未启用“SignalR（机器人）”功能，则无法使用此选项。