创建外部任务
UiPath.Persistence.Activities.ExternalTask.CreateExternalTask
描述
使用给定的数据、任务标题、任务优先级和任务目录创建外部操作。
项目兼容性
Windows - 旧版 | Windows | 跨平台
Windows、Windows - 旧版配置
设计器面板
- “任务 标题” - 要创建的操作的标题。 此字段仅支持字符串和
String
变量。 - “任务 优先级” - 用于选择操作的优先级。 默认情况下,此属性设置为 TaskPriority.Medium 提供以下选项: TaskPriority.Low、 TaskPriority.Medium、 TaskPriority.High、 TaskPriority.Critical。
- TaskCatalog - 任务项目的可选业务分类。 此字段仅支持字符串和
String
变量。 - “任务 数据” - 要存储在给定操作中的业务数据集合,格式为
Dictionary<String,Argument>
。 完成操作后,修改Out
和In/Out
参数会将其映射回工作流。 此字段仅支持Dictionary<String,Argument>
对象。 - 任务对象(输出) - 创建 Actions 后从 Orchestrator 作为
ExternalTaskData
对象返回的任务对象。 可以将此对象传递给“ 等待外部任务然后继续 ”活动,以便在 Actions 完成之前暂停工作流的执行。
属性面板
常见
- “出错时继续”- 指定在活动引发错误时是否应继续自动化操作。该字段仅支持“布尔值”(True 和 False)。默认值为 False。因此,如果该字段为空且活动引发错误,系统将停止执行项目。如果该值设为“True”,则无论出现何种错误,系统都将继续执行项目。
- “显示名称”- 活动的显示名称。
- “超时 (毫秒)”- 指定等待时间(以毫秒为单位),如果超出该时间活动未运行,就会引发错误。默认值为 30000 毫秒(30 秒)。
输入
- “外部标签 ” - 此标签可用于标识作为给定操作中数据来源的外部系统。 此字段仅支持字符串和
String
变量。 - 标签 - 机器人将输入的标签添加到操作中,以允许将来进行筛选。 此字段仅支持字符串值,并且具有 命名限制。
- “Orchestrator 文件夹路径 ” - Orchestrator 文件夹的路径 ,该文件夹 与要在其中创建任务的当前流程所在的文件夹不同。 要阅读有关 Orchestrator 文件夹的更多信息,请转到 此处。 对于 传统 文件夹,只有当当前用户在目标文件夹中具有正确的任务权限时,此属性才能与 浮动机器人 一起使用。 对于 新式 文件夹, 不支持覆盖文件夹路径。 此字段仅支持字符串和
String
变量。
- TaskCatalog - 任务项目的可选业务分类。 此字段仅支持字符串和
String
变量。
- “任务 数据” - 要存储在给定操作中的业务数据集合,格式为
Dictionary<String,Argument>
。 完成操作后,修改Out
和In/Out
参数会将其映射回工作流。 此字段仅支持Dictionary<String,Argument>
对象。 - “任务 优先级” - 用于选择操作的优先级。 默认情况下,此属性设置为 TaskPriority.Medium 提供以下选项: TaskPriority.Low、 TaskPriority.Medium、 TaskPriority.High、 TaskPriority.Critical。
- “任务 标题” - 要创建的操作的标题。 此字段仅支持字符串和
String
变量。
其他
- “私有”- 选中后将不再以“Verbose”级别记录变量和参数的值。
输出
- 任务对象(输出) - 创建 Actions 后从 Orchestrator 作为
ExternalTaskData
对象返回的任务对象。 可以将此对象传递给“ 等待外部任务然后继续 ”活动,以便在 Actions 完成之前暂停工作流的执行。
跨平台配置
- “任务 标题” - 要创建的操作的标题。 此字段仅支持字符串和
String
变量。 - “任务 优先级” - 用于选择操作的优先级。 默认情况下,此属性设置为 TaskPriority.Medium 提供以下选项: TaskPriority.Low、 TaskPriority.Medium、 TaskPriority.High、 TaskPriority.Critical。
- TaskCatalog - 任务项目的可选业务分类。 此字段仅支持字符串和
String
变量。
- “任务 数据” - 要存储在给定操作中的业务数据集合,格式为
Dictionary<String,Argument>
。 完成操作后,修改Out
和In/Out
参数会将其映射回工作流。 此字段仅支持Dictionary<String,Argument>
对象。 - 任务对象(输出) - 创建 Actions 后从 Orchestrator 作为
ExternalTaskData
对象返回的任务对象。 可以将此对象传递给“ 等待外部任务然后继续 ”活动,以便在 Actions 完成之前暂停工作流的执行。
高级选项
常见
- “出错时继续”- 指定在活动引发错误时是否应继续自动化操作。该字段仅支持“布尔值”(True 和 False)。默认值为 False。因此,如果该字段为空且活动引发错误,系统将停止执行项目。如果该值设为“True”,则无论出现何种错误,系统都将继续执行项目。
- “超时 (毫秒)”- 指定等待时间(以毫秒为单位),如果超出该时间活动未运行,就会引发错误。默认值为 30000 毫秒(30 秒)。
输入
- 标签 - 机器人将输入的标签添加到操作中,以允许将来进行筛选。 此字段仅支持字符串值,并且具有 命名限制。
- “Orchestrator 文件夹路径 ” - Orchestrator 文件夹的路径 ,该文件夹 与要在其中创建任务的当前流程所在的文件夹不同。 要阅读有关 Orchestrator 文件夹的更多信息,请转到 此处。 对于 传统 文件夹,只有当当前用户在目标文件夹中具有正确的任务权限时,此属性才能与 浮动机器人 一起使用。 对于 新式 文件夹, 不支持覆盖文件夹路径。 此字段仅支持字符串和
String
变量。
- “引用 ” - 一个标签,可用于标识作为给定操作中数据来源的外部系统。 此字段仅支持字符串和
String
变量。
创建外部操作
要创建外部操作,请在以下过程中选择:
-
将“ 创建外部任务” 活动添加到您的工作流中,并提供以下属性字段的信息:
- 任务标题
- 任务优先级
- 任务数据 (集合)
- “外部标签 ” - 指定一个标签,以唯一标识要从第三方系统检索的外部任务批次。 您可以使用此标签将外部任务与外部系统同步。 此外,您可以使用此标签根据用户在第三方系统中执行的操作完成任务。
- 使用 API创建外部 Actions 。
将外部操作与第三方工具同步
要将外部操作与其他外部系统同步,您需要首先在外部系统内为其创建相应的对象,然后使用 API 调用检索第三方系统创建的任务或任务批次。
-
在外部系统内创建对象,例如:
-
在 Swagger 中调用以下 API: GET
/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders
。例如: GET
<ORCH_URL>/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders?$filter=(Type eq 'ExternalTask') and (IsDeleted eq false) and (ExternalTag eq 'JiraTasks') and (Status ne 'Completed')&$count=true
。
检索外部操作
使用 任务 ID 和 组织单位 ID (Orchestrator 文件夹的 ID)调用以下 API 以检索有关外部任务的信息: GET /tasks/GenericTasks/GetTaskDataById
。 您可以使用检索到的详细信息在第三方系统中创建类似的任务。
下面的屏幕截图显示了 Swagger 中的 API 参数和响应。 要在 Swagger 中访问租户,请按照 访问 Swagger 文件 过程进行操作。
完成外部操作
使用 任务 ID 和 组织单位 ID (Orchestrator 文件夹的 ID)调用以下 API 以完成外部任务: POST /tasks/GenericTasks/CompleteTask
。
有关更多详细信息,请访问 Orchestrator API 指南中的“ 完成外部任务 ”过程。