orchestrator
latest
false
UiPath logo, featuring letters U and I in white

Orchestrator 用户指南

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
上次更新日期 2024年11月25日

管理作业

开始作业

在完成以下步骤之前,您需要 创建一个流程

  1. 在流程所在的文件夹中导航到“自动化”>“作业”
  2. 单击“开始”。系统将显示“开始作业”窗口。
  3. 从“流程名称”下拉列表中,选择一个先前已部署到当前文件夹的进程。
  4. 配置必填字段,如下面的部分所述。
  5. 单击“开始”。关闭“开始作业”窗口,如果当前处于活动状态的文件夹中有可用的运行时,则根据您所做的设置在机器人上启动作业。作业的状态实时显示在“作业”页面上。

设置作业优先级

如果您希望执行的作业的优先级与在流程级别设置的优先级不同,请从“ 作业优先级” 下拉列表中选择要执行的作业的 优先 级。 此字段将自动填充继承自包的优先级。

选择执行运行时

从“Runtime 类型”下拉列表中,选择用于执行作业的运行时类型。

下拉列表下方会显示可用和已连接的运行时数量。

  • “_ 可用” - 可用的运行时数量,以运行时总数减去正在运行的作业数计算得出。
  • “_ 已连接”- 运行时总数,以连接到与活动文件夹关联的 Orchestrator 的所有计算机上的运行时总和计算得出。

    Runtime 类型

    描述

    Production (Unattended)

    使用无人值守运行时以无人值守模式执行作业。

    测试

    使用测试运行时以无人值守模式执行作业。

    非生产

    使用非生产运行时以无人值守模式执行作业。

    Cloud - VM 测试

    该作业在配置为在“测试”或“Non-production”环境中运行的 Cloud VM 上以 Unattended 模式执行。运行虚拟机会使用测试环境中的 Robot Units。

    有关更多详细信息,请参阅 Robot Units - 消耗

    Cloud - VM

    该作业在配置为在生产环境中运行的云虚拟机上以 Unattended 模式执行。运行虚拟机会使用生产环境中的 Robot Units。

    有关更多详细信息,请参阅 Robot Units - 消耗

示例:假设计算机模板 A 有 2 个非生产运行时和 1 个无人值守运行时,计算机模板 B 有 3 个非生产运行时和 2 个无人值守运行时。两个模板都与一个文件夹相关联。在每个模板上,您连接一台主机。产生的运行时状态如下:

  • 无人值守:3 Available, 3 Connected
  • 非生产:5 Available, 5 Connected

占用一个运行时的正在运行的作业会从该类型的可用运行时数中减去 1。

备注:

在发布时,Orchestrator 从可用的个人工作区运行时中选择来执行作业。 运行时优先级如下:

  • Production (Unattended)
  • 非生产

例如,如果不存在 Production Runtime,则 Orchestrator 将使用可用的 NonProduction Runtime。如果不存在,则作业将失败。

如果所选运行时在作业执行之间变得不可用,则即将执行的作业将失败,因为 Orchestrator 不会查找下一个可用的作业。

配置执行目标

根据需要在“ 执行目标 ” 选项卡上设置以下选项,以配置执行目标。



动态分配

无需显式选择帐户和计算机的动态分配允许您在首先可用的帐户和计算机下多次执行前台流程。 只要您有足够的运行时,后台流程就可以在任何帐户上执行,无论其是否忙碌。

使用此选项,最多可以在一个作业中执行一个流程 10000 次。

帐户

您可以选择以下方法之一:

  • 指定帐户意味着系统将在该特定用户或机器人帐户下执行流程。
  • 同时指定帐户和计算机意味着作业将在该特定帐户-计算机对上启动。只有有效的帐户-计算机对可供选择。
  • 如果未指定帐户,则 Orchestrator 会动态分配帐户。

计算机

您可以选择以下方法之一:

  • 指定计算机对象意味着在附加到所选计算机模板的其中一台主机上执行该流程。在“已连接的计算机”字段中,从已连接的主机池中选择特定主机。
  • 同时指定帐户和计算机意味着作业将在该特定帐户-计算机对上启动。只有有效的帐户-计算机对可供选择。
  • 如果未指定计算机,则 Orchestrator 会动态分配主机。

确保将与作业类型匹配的运行时分配给关联的计算机模型。仅显示与活动文件夹关联的已连接主机。

选择有效帐户 - 计算机映射

选择将运行作业的特定帐户-计算机对。
docs image
如果要在多个这样的对上运行作业,可以单击“添加帐户-计算机映射”。这样,系统将为每个帐户-计算机对创建一个待定作业。
注意:仅当在租户设置的“常规”选项卡上选择了“启用用户-计算机映射”选项时,这才有效。

在作业恢复时保持帐户/计算机分配

此字段可用于配置是否在相同的帐户-计算机对上执行长时间运行的作业的不同片段。

默认情况下,暂停的作业将在任何可用计算机上的任何可用机器人上恢复。

根据您的许可证或资源要求,您可以选择在启动作业的同一台计算机上和相同的帐户上下文中恢复作业。

假设您需要 SAP 许可证才能执行作业。您可以在单台计算机上安装 SAP 许可证,并使用该计算机来启动和继续作业,而不必在每台可用的计算机上安装 SAP 许可证(这样会增加成本)。相同的策略可能适用于用户许可证。您只能分配一个用户许可证,并使用它来执行作业。

计划结束作业执行

流程执行有时可能会出错,从而导致作业保持挂起状态。 打开切换开关后,您可以(单击以展开):

  • 从下拉菜单中选择“停止”- 这会在作业一直处于“待处理”状态以来经过已定义的时间间隔后尝试正常结束执行(可设置的最短时间为 1 分钟,最长时间为 10 天 23 小时 59 分钟)。


  • 从下拉菜单中选择“终止”- 这会在作业一直处于“待处理”状态以来经过已定义的时间间隔后尝试强制结束执行(可设置的最短时间为 1 分钟,最长时间为 10 天 23 小时 59 分钟)。


  • 从下拉菜单中选择“停止”,并启用“如果作业未停止,则计划自动‘终止’”选项 - 这会在作业一直处于“待处理”状态以来经过已定义的时间间隔后尝试正常结束执行,然后在作业一直处于“正在停止”状态以来经过已定义的时间间隔后尝试强制结束作业(可设置的最短时间为 1 分钟,最长时间为 10 天 23 小时 59 分钟)。


在作业停留在待处理状态或已恢复状态时生成警示

通过打开切换开关,您可以激活有关保持挂起或恢复状态超过指定持续时间的作业的警示。

可配置的持续时间最短为一分钟,最长为十一天。

如果作业时长超过配置的持续时间,则会弹出“错误”严重性警报,并使用以下文本通知您:

"#process {process_number} 的 N 个作业已挂起或恢复超过 X 小时 Y 分钟。", 其中:

  • N - 触发警示的作业编号
  • {process_number} - 流程标识符
  • X - 作业处于挂起或已恢复状态时超出的配置小时数;天将转换为小时。

  • Y - 作业处于挂起或已恢复状态时超过的配置分钟数。

如果作业已开始但尚未完成,则生成警示

通过打开开关,您可以激活有关未在指定持续时间内完成的作业的警示。

可配置的持续时间最短为一分钟,最长为十一天。

如果作业时长超过配置的持续时间,则会弹出“错误”严重性警报,并使用以下文本通知您:

“#process {process_number} 的作业已运行超过 X 小时 Y 分钟”,其中:

  • {process_number} - 流程标识符
  • X - 作业尝试完成时超出的配置小时数。天将转换为小时。

  • Y - 作业尝试完成时超出的配置分钟数。

Orchestrator 会阻止使用无效配置启动作业。尝试在无效的设置中启动作业会导致显示描述性错误消息,为您提供有关如何修复配置的详细信息。



如果使用动态分配(即未指定任何计算机或帐户)和不兼容的文件夹设置启动作业,则会导致错误。请务必更正设置,否则作业将无限期保持待处理状态。例如,当文件夹中只有跨平台模板时,尝试运行 .NET Framework 4.6.1 后台作业将失败,因为在修复配置之前,作业将保持待处理状态。

添加参数

在“参数”选项卡中,提供所选流程的输入参数。此选项卡将自动填充所选过程接受的所有输入参数,以及继承自包的相应值。

通过 API 触发器启动作业

您可以从所选的第三方应用程序中通过 API 触发器启动作业。请执行以下步骤:

  1. 基于要运行的流程创建 API 触发器。这将生成开始作业所需的 URL。请按照创建 API 触发器主题中的说明来实现此目的。
  2. 创建专用的个人访问令牌,并向其授予对必要资源的访问权限。您可以在组织级别从“首选项”>“个人访问令牌”页面中完成此操作。保存后,请确保立即复制个人访问令牌 (PAT),因为系统不会再次显示该令牌。
  3. 将个人访问令牌粘贴到“持有者令牌”字段中,以授权您的请求。
  4. 通过在触发器列表中单击所需租户旁边的“复制完整的 Slug 网址”选项来获取作业 URL,然后将其粘贴到您的工具中。
  5. 根据需要配置参数。

    可以使用以下格式输入参数:

    查询字符串参数

    对于包含 hw-process Slug 以及 filesfolders 参数的作业,可在命令行中使用的 cURL 如下所示:
    curl --location --request POST 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process?argument1=files&argument2=folders' \
    --header 'Cookie: __cf_bm=_5E_r3oulk6zLCr6.CUij.RFN4lCeTgYMR31gradWtI-1697542233-0-AdP+xhO+SE5PQ6wnoEum5qRu4wzUgGgOrezRhHrR4dcVvhsvl9yV/V3KAFhi/TmomqMtmxc426WT83lDMoL1seQ='curl --location --request POST 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process?argument1=files&argument2=folders' \
    --header 'Cookie: __cf_bm=_5E_r3oulk6zLCr6.CUij.RFN4lCeTgYMR31gradWtI-1697542233-0-AdP+xhO+SE5PQ6wnoEum5qRu4wzUgGgOrezRhHrR4dcVvhsvl9yV/V3KAFhi/TmomqMtmxc426WT83lDMoL1seQ='

    表单数据

    对于包含 hw-process Slug 以及 filesfolders 参数的作业,可在命令行中使用的 cURL 如下所示:
    curl --location 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process' \
    --header 'Cookie: __cf_bm=_5E_r3oulk6zLCr6.CUij.RFN4lCeTgYMR31gradWtI-1697542233-0-AdP+xhO+SE5PQ6wnoEum5qRu4wzUgGgOrezRhHrR4dcVvhsvl9yV/V3KAFhi/TmomqMtmxc426WT83lDMoL1seQ=' \
    --form 'argument1="files"' \
    --form 'argument2="folders"'curl --location 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process' \
    --header 'Cookie: __cf_bm=_5E_r3oulk6zLCr6.CUij.RFN4lCeTgYMR31gradWtI-1697542233-0-AdP+xhO+SE5PQ6wnoEum5qRu4wzUgGgOrezRhHrR4dcVvhsvl9yV/V3KAFhi/TmomqMtmxc426WT83lDMoL1seQ=' \
    --form 'argument1="files"' \
    --form 'argument2="folders"'

    JSON 正文文本

    对于包含 hw-process Slug 以及 filesfolders 参数的作业,可在命令行中使用的 cURL 如下所示:
    curl --location 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process' \
    --header 'Content-Type: application/json' \
    --data '{
        "argument1" : "files",
        "argument2" : "folders"
    }
    'curl --location 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process' \
    --header 'Content-Type: application/json' \
    --data '{
        "argument1" : "files",
        "argument2" : "folders"
    }
    '

    也可以通过组合使用上述方法来输入参数。

  6. 运行作业。

    根据您在触发器定义中选择的调用模式,作业将以如下模式运行:

    • 异步轮询

    • 异步触发与忽略

    • 同步 (长轮询)

    请注意,可以在查询字符串或正文中使用 $callMode 参数来覆盖调用模式。

    有关这些选项的详细信息,请参阅调用模式说明部分。

速率限制

对于每个已启动的作业,可向状态端点发出的请求数限制为每 10 秒 10 个。

待定作业限制

通过 API 触发器启动的待处理作业的最大数量为 100 个。您可以在“触发器”>“API 触发器”>“待处理作业数量上限”租户级别设置中更改此限制,此限制的默认值为 10。

停止作业

单击相应的更多操作按钮,然后单击停止。自动化项目将一直执行,直至找到应停止活动。在此期间,作业处于正在停止状态。如果遇到该活动,执行将停止,并且作业的最终状态为成功。如果未找到应停止活动,则作业执行在到达项目末尾时才会停止。在这情况下,最终状态也为成功

备注:
  • 从 Orchestrator 启动的作业只能从 Orchestrator 停止
  • 从 Assistant 启动的作业既可以从 Orchestrator 的“作业”页面停止,也可以使用 UiPath™ Assistant 停止。
  • 作业已停止后,作业结束计划将丢失,您需要在重新启动作业时重新配置“计划结束作业执行”选项。

继续作业

单击相应的“更多操作”按钮,然后单击“继续”

终止作业

单击相应的更多操作按钮,然后单击终止。自动化项目被强制停止,该作业被标记为已停止,并且作业详细信息窗口中显示作业“已取消”。

备注:
  • 从 Orchestrator 启动的作业既可以从 Orchestrator 的“作业”页面终止,也可以使用 UiPath Assistant 终止
  • 从 Assistant 启动的作业既可以从 Orchestrator 的“作业”页面终止,也可以使用 UiPath Assistant 终止
  • 作业被终止后,作业结束计划将丢失,您需要在重新启动作业时重新配置“计划结束作业执行”选项。

重新开始作业

此功能使您可以快速从作业列表运行作业,而无需完成作业配置流程。您可以重新开始任何处于最终状态(已停止发生故障成功)的作业。

备注:
  • 您无法重新启动由代理程序(例如 Assistant)或通过 Studio 远程调试会话触发的作业。
  • 当您重新启动已启用“计划结束作业执行”选项的作业时,您需要重新配置这些选项。

此过程首先假设您先前启动了已达到最终状态的作业

  1. 单击相应的更多操作按钮,然后单击重新启动。系统将显示开始作业窗口,其中包含作业的初始设置。
  2. 进行所需的更改。
  3. 单击“开始”。“开始作业”窗口将关闭,作业会开始执行。作业状态实时显示在“作业”页面上。

查看作业详细信息

备注:
  • 当侧面板打开时,您可以单击列表中的任何作业以显示其面板中包含的所有选项卡的特定详细信息。作业列表网格可以水平滚动,同时根据您的特定屏幕尺寸和分辨率,让“流程”列保持固定。请注意,您可以增加某些列的大小,从而显示滚动条以便于访问。

  • 您可以单击任何选项卡右上角的展开图标,以将其作为完整大小的窗口打开,并在面包屑导航中标明基础流程的名称。同一角落的“折叠”按钮可将窗口恢复到侧面板状态。

  • 作业详细信息不包括失败的作业的许可注意事项。请使用监控功能获取有关许可证的详细信息。

要查看有关特定作业的详细信息,请单击相应的“详细信息”按钮。这将显示一个包含“作业详细信息”部分的侧面板,为您提供各种信息,例如:

  • 基础流程的名称
  • 执行机器人和计算机
  • 作业失败的原因
  • 作业无法开始的原因
  • 用于修复任何问题并触发作业开始的操作

已完成的作业详细信息



待处理的作业详细信息

docs image

在 SAP 租户的上下文中,您可以使用“返回到 SAP 按钮”返回到 SAP Build 流程自动化中的流程。

查看作业日志

要查看特定作业的日志,请单击相应的“详细信息”按钮。这将显示一个侧面板,其中包括“日志”部分,以及有关所选作业的数据。

注意:若作业通过远程调试会话启动,其生成的日志在“作业日志”页面上不可用。您可以在全局“日志”页面上找到它们。

查看作业恢复条件

要查看恢复暂停的作业所需的触发器,请单击相应的“详细信息”按钮。这将显示一个包括“恢复条件”选项卡的侧面板,其中包含为所选作业配置的工作流任务的详细信息。

您可以单击列表以访问其他作业的触发器。

查看视频时间线

要查看作业执行的视频录制以及基础日志,请单击相应的“详细信息”按钮。这将显示一个侧面板,其中包括“视频时间线”选项卡,顶部是视频窗格,底部是日志列表。

您也可以通过单击同一面板的“日志”选项卡上的“打开录制”来访问此选项卡。

有关详细信息,请参阅视频录制专用主题。

下载执行介质

要下载出现故障的作业的记录,请单击“更多选项”>“下载录制”。将下载根据您的设置生成的执行介质。

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。