获取作业

UiPath.Core.Activities.GetJobs

描述

使用 Orchestrator API 根据自定义筛选器检索 Orchestrator 作业 列表。 您还可以指定要跳过的作业数和/或要检索的最大作业数。 请注意，为了在 Studio 中执行此活动，必须将机器人连接到 Orchestrator，并且 机器人角色 需要具有作业、流程和环境的 查看 权限。 该活动在执行它的 Robot 下运行。

项目兼容性

Windows - 旧版 | Windows | 跨平台

跨平台配置

• “Orchestrator 文件夹路径”- 应在此检索作业的文件夹路径（可能与运行流程的文件夹不同）。此字段仅支持字符串值，并使用 / 作为分隔符来表示子文件夹。例如 "Finance/Accounts Payable"。
  备注：

  Folder Path参数不适用于机器人在传统文件夹中执行的流程。只有新式文件夹中的机器人才能将数据传递到其文件夹之外。

  X-UIPATH-FolderPath-Encoded 参数支持相对文件夹路径，如下所示：

  -right: 以 / 开头的路径 - 从环境文件夹所在的树的 root 文件夹开始。

  -right: 以 . 开头的路径 - 从环境文件夹开始。

  -right: 以 .. 开头的路径 - 对于路径中的每个 ..，在环境文件夹的层次结构中向上启动一个级别（例如../ 表示上一级，../../ 表示上两级）。

  请注意，不应包含尾随斜杠。

• 筛选器 - 指定用于获取作业的 OData 筛选器（即 CreationTime GT 2017-01-01T00:03:08.93Z 和 State eq 'Running'）。 有关更多参考，请查看 OData 文档。 此属性仅支持字符串或 String 变量。 当使用筛选器而不是表达式时，您可以使用可用的向导对其进行配置。

Windows 配置

• “Orchestrator 文件夹路径”- 应在此检索作业的文件夹路径（可能与运行流程的文件夹不同）。此字段仅支持字符串值，并使用 / 作为分隔符来表示子文件夹。例如 "Finance/Accounts Payable"。
  备注：

  Folder Path参数不适用于机器人在传统文件夹中执行的流程。只有新式文件夹中的机器人才能将数据传递到其文件夹之外。

  X-UIPATH-FolderPath-Encoded 参数支持相对文件夹路径，如下所示：

  -right: 以 / 开头的路径 - 从环境文件夹所在的树的 root 文件夹开始。

  -right: 以 . 开头的路径 - 从环境文件夹开始。

  -right: 以 .. 开头的路径 - 对于路径中的每个 ..，在环境文件夹的层次结构中向上启动一个级别（例如../ 表示上一级，../../ 表示上两级）。

  请注意，不应包含尾随斜杠。

• 筛选器 - 指定用于获取作业的 OData 筛选器（即 CreationTime GT 2017-01-01T00:03:08.93Z 和 State eq 'Running'）。 有关更多参考，请查看 OData 文档。 此属性仅支持字符串或 String 变量。 单击字段将打开“筛选器向导”窗口。

高级选项

其他

• “跳过”- 帮助您跳过前“n”个作业。此属性仅支持整数和整数变量。
• “置顶”- 仅返回总数中的指定作业数量。最大值为 100。该属性仅支持整数和 Integer 变量。
• “超时（以毫秒为单位）”- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 30000 毫秒（30 秒）。
• “出错时继续”- 指定在活动抛出错误时是否应继续自动化操作。该字段仅支持“布尔值”（True 和 False）。默认值为 False。因此，如果该字段为空且活动引发错误，系统将停止执行项目。如果该值设为“True”，则无论出现何种错误，系统都将继续执行项目。

输出

• “作业”- 检索到的作业，为 IEnumerable<OrchestratorJobs> 变量。

配置向导

该向导允许您轻松创建筛选器，用于从 Orchestrator 检索作业。

以下实体可用：

• “密钥 ” - Orchestrator 作业密钥。

  • 可设置为“ 等于 ”或 “不等于 ”特定字符串或变量。

• “开始时间” -Orchestrator 作业的开始时间。

  • 可以设置为“ 新于 ” 或“早 于 特定日期/时间/小时”。

• “结束时间” -Orchestrator 作业的结束时间。

  • 可以设置为“ 新于 ” 或“早 于 特定日期/时间/小时”。

• 状态 - Orchestrator 作业的状态。

  • 可以设置为“ 等于 ”或 “不等于 ”以下值之一：
    • 发生故障
    • 待处理
    • 已恢复
    • 正在运行
    • 已停止
    • 正在停止
    • 成功
    • 已暂停
    • 正在终止

• “优先级 ” - Orchestrator 作业的优先级。

• • 可以设置为“ 等于 ”或 “不等于 ”以下值之一：
    • 高
    • 低
    • 正常

• “创建 时间” - Orchestrator 作业的创建时间。

• • 可以设置为“ 新于 ” 或“早 于 特定日期/时间/小时”。

• 版本名称

• • 可以设置为以下选项之一：
    • 包含
    • 结尾为
    • 等于
    • 不包含
    • 不等于
    • 开头为

Windows - 旧版配置

属性面板

常见

• “出错时继续”- 指定在活动抛出错误时是否应继续自动化操作。该字段仅支持“布尔值”（True 和 False）。默认值为 False。因此，如果该字段为空且活动引发错误，系统将停止执行项目。如果该值设为“True”，则无论出现何种错误，系统都将继续执行项目。
• “显示名称”- 活动的显示名称。
• “超时（以毫秒为单位）”- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 30000 毫秒（30 秒）。

输入

• “筛选器”- 指定用于获取作业的 OData 筛选器（即CreationTime gt 2017-01-01T00:03:08.93Z 和 State eq 'Running'）。有关更多参考，请查看 OData 文档。此属性仅支持字符串或 String 变量。

其他

• “文件夹路径”- 应从中检索作业的文件夹的路径（可能与运行流程的文件夹不同）。此字段仅支持字符串值，并使用 / 作为分隔符来表示子文件夹。例如 "Finance/Accounts Payable"。
  备注：

  Folder Path参数不适用于机器人在传统文件夹中执行的流程。只有新式文件夹中的机器人才能将数据传递到其文件夹之外。

  X-UIPATH-FolderPath-Encoded 参数支持相对文件夹路径，如下所示：

  -right: 以 / 开头的路径 - 从环境文件夹所在的树的 root 文件夹开始。

  -right: 以 . 开头的路径 - 从环境文件夹开始。

  -right: 以 .. 开头的路径 - 对于路径中的每个 ..，在环境文件夹的层次结构中向上启动一个级别（例如../ 表示上一级，../../ 表示上两级）。

  请注意，不应包含尾随斜杠。

• “私有”- 选中后将不再以“Verbose”级别记录变量和参数的值。

输出

• “作业”- 检索到的作业，为 IEnumerable<OrchestratorJobs> 变量。

分页

• “跳过”- 帮助您跳过前“n”个作业。此属性仅支持整数和整数变量。
• “置顶”- 仅返回总数中的指定作业数量。最大值为 100。该属性仅支持整数和 Integer 变量。