创建表单任务

UiPath.Persistence.Activities.FormTask.CreateFormTask

描述

在 Action Center 的云实例和内部部署实例中创建表单操作。 它还会在 On-Premises Orchestrator 版本 21.4 及更低版本中创建表单任务。

先决条件

• Install the UiPath.FormActivityLibrary package version 2.0.7 or higher to enable the form designer.
• Form tasks have a limit of maximum 1MB. To fit in this 1MB limit, you need to embed images inside forms, using Storage Buckets only. Also, we suggest using images of type base64 only for logos and icons smaller than 2KB.

项目兼容性

Windows - 旧版 | Windows | 跨平台

Windows、Windows - 旧版配置

设计器面板

• “任务 标题” - 要创建的操作的标题。 此字段仅支持字符串和 String 变量。
• “任务 优先级” - 用于选择操作的优先级。 默认情况下，此属性设置为 TaskPriority.Medium 提供以下选项： TaskPriority.Low、 TaskPriority.Medium、 TaskPriority.High、 TaskPriority.Critical。

• TaskCatalog - 任务项目的可选业务分类。 此字段仅支持字符串和字符串变量。

  重要提示： 确保在创建操作之前 操作目录 已存在。 否则，操作创建将失败，并显示以下错误消息：“不存在名称为 [action_catalog_name] 的任务目录，错误代码: 2451”。
• “表单 数据” - 要在“操作”收件箱中的表单中显示的表单 Dictionary<String,Argument> 中的业务数据集合。 完成任务后，修改 Out 和 In/Out 参数会将其映射回工作流。 此字段仅支持 Dictionary<String,Argument> 对象。
• “任务对象（输出） ” - 创建 Actions 后从 Orchestrator 作为 FormTaskData 对象返回的任务对象。 可以将此对象传递给“ 等待表单任务然后继续” 活动，以便在 Actions 完成之前暂停工作流的执行。

备注： TaskObject 具有多个属性，用于保存有关输出操作对象的信息。 例如， TaskUrl 属性为您提供 Orchestrator On-Premises 中“操作”选项卡内 操作 的 URL，而 ActionUrl 属性为您提供 Automation Cloud 中“操作”选项卡内 操作 的 URL。 要从内部部署 Action Center 访问操作，请将 /actions_/tasks/taskID 添加到 Action Center 基本 URL，例如： https://laptop-name:port-number/actions_/tasks/taskID。

单击“打开表单设计器”按钮将打开“表单设计器”向导，该向导使您能够自定义要在工作流中使用的表单。

选择“启用批量编辑”属性后，“打开批量表单设计器”按钮将变为可用。此选项将打开“批量表单设计器”，允许您设计表单操作，这些操作可在相应 Action Center 实例的“操作”选项卡中批量编辑或完成。

属性面板

常见

• “出错时继续”- 指定在活动引发错误时是否应继续自动化操作。该字段仅支持“布尔值”(True 和 False)。默认值为 False。因此，如果该字段为空且活动引发错误，系统将停止执行项目。如果该值设为“True”，则无论出现何种错误，系统都将继续执行项目。

注意：如果 Try Catch 异常处理中包含该活动且出错时继续属性的值为 True，则系统在执行项目时不会捕获任何错误。

• “显示名称”- 活动的显示名称。
• “超时 (毫秒)”- 指定等待时间（以毫秒为单位），如果超出该时间活动未运行，就会引发错误。默认值为 30000 毫秒（30 秒）。

输入

• 启用高级表单- 为表单呈现和逻辑启用增强功能和自定义选项，例如：
  • 用于编辑网格的可自定义模板。
  • 充当事件的按钮。
  • 能够使用 ES6 和新式 JavaScript 自定义表单。
  • 用于自定义表单的instance和options变量的可用性。
• “启用批量编辑” - 如果选中，则活动主体中的“打开批量表单设计器”按钮将变为可用。 此选项允许您生成可从 Action Center 的“操作”选项卡批量编辑或完成的表单操作。
  
  

  

  
  
• “表单 数据” - 要在“操作”收件箱中的表单中显示的表单 Dictionary<String,Argument> 中的业务数据集合。 完成任务后，修改 Out 和 In/Out 参数会将其映射回工作流。 此字段仅支持 Dictionary<String,Argument> 对象。
• “生成 输入字段” - 如果选中，则 表单数据集合 中的所有条目都将作为表单设计器中的组件生成。 将其留空不会向设计器添加其他表单字段。
• 标签 - 机器人将输入的标签添加到操作中，以允许将来进行筛选。 此字段仅支持字符串值，并且具有 命名限制。

注意： 要允许通过“持久性”活动自动标记操作，执行工作流的机器人帐户需要对标签具有 “查看”、“ 创建”和“ 删除 ”权限。

• “Orchestrator 文件夹路径 ” - 要用于此活动的 Orchestrator 文件夹的路径。 如果留空，则使用当前的 Orchestrator 文件夹。 此字段仅支持字符串和字符串变量。

注意： 如果执行此操作的用户不具备目标文件夹的所需权限，则任务创建将失败并引发严重错误。 查看有关 文件夹权限的更多信息。

• “引用 ” - 用作将来筛选操作的参考的名称。 此字段仅支持字符串值。

• TaskCatalog - 任务项目的可选业务分类。 此字段仅支持字符串和字符串变量。

  重要提示： 确保在创建操作之前 操作目录 已存在。 否则，操作创建将失败，并显示以下错误消息：“不存在名称为 [action_catalog_name] 的任务目录，错误代码: 2451”。
• “任务 优先级” - 用于选择操作的优先级。 默认情况下，此属性设置为 TaskPriority.Medium 提供以下选项： TaskPriority.Low、 TaskPriority.Medium、 TaskPriority.High、 TaskPriority.Critical。
• “任务 标题” - 要创建的操作的标题。 此字段仅支持字符串和 String 变量。
• “使用本地表单文件 ” - 允许使用执行时指定的 JSON 表单文件创建表单操作。 此字段仅支持 Boolean 值。 启用后，“ 表单文件路径 ” 属性字段将显示在活动主体中，您可以在其中指定存储特定表单布局的 JSON 文件的路径。

  选择 “使用本地表单文件” 后，单击 “打开表单设计器” ，选择 “新建”，然后开始构建表单。 完成后，选择“ 另存为”，并将其保存在相应的项目文件夹中。 现在，您已将先前创建的表单存储在 JSON 文件中。 在“ 表单文件路径 ” 字段中输入此 JSON 文件的路径，以在运行时使用该表单。

其他

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

输出

• “任务对象（输出） ” - 创建 Actions 后从 Orchestrator 作为 FormTaskData 对象返回的任务对象。 可以将此对象传递给“ 等待表单任务然后继续” 活动，以便在 Actions 完成之前暂停工作流的执行。

存储

• 存储桶名称 - 要用于表单数据中引用的大型数据文件的存储桶。
• “存储文件夹路径 ” - 指定存储桶中文件夹的完整路径。 此字段仅支持字符串和 String 变量。
  提示：

  将图像嵌入与存储桶一起使用必须与“上传存储文件” 活动一起完成。 参数名称必须在“表单数据 集合”属性中加上后缀，并通过在 HTML 元素 组件中使用下划线 (_) 将其映射到表单中的图像。

  参数名称 (<key>_storage) 必须映射到“ 上传存储文件 ”活动的“目标”属性中的存储值。

  请注意，图像文件名不得包含加号 (+)，因为存储桶上传流程会屏蔽此字符，从而导致错误。

跨平台配置

• “任务 标题” - 要创建的操作的标题。 此字段仅支持字符串和 String 变量。
• “任务 优先级” - 用于选择操作的优先级。 默认情况下，此属性设置为 TaskPriority.Medium 提供以下选项： TaskPriority.Low、 TaskPriority.Medium、 TaskPriority.High、 TaskPriority.Critical。

• TaskCatalog - 任务项目的可选业务分类。 此字段仅支持字符串和字符串变量。

  重要提示： 确保在创建操作之前 操作目录 已存在。 否则，操作创建将失败，并显示以下错误消息：“不存在名称为 [action_catalog_name] 的任务目录，错误代码: 2451”。
• “表单 数据” - 要在“操作”收件箱中的表单中显示的表单 Dictionary<String,Argument> 中的业务数据集合。 完成任务后，修改 Out 和 In/Out 参数会将其映射回工作流。 此字段仅支持 Dictionary<String,Argument> 对象。
• “任务对象（输出） ” - 创建 Actions 后从 Orchestrator 作为 FormTaskData 对象返回的任务对象。 可以将此对象传递给“ 等待表单任务然后继续” 活动，以便在 Actions 完成之前暂停工作流的执行。

备注： TaskObject 具有多个属性，用于保存有关输出操作对象的信息。 例如， TaskUrl 属性为您提供 Orchestrator On-Premises 中“操作”选项卡内 操作 的 URL，而 ActionUrl 属性为您提供 Automation Cloud 中“操作”选项卡内 操作 的 URL。 要从内部部署 Action Center 访问操作，请将 /actions_/tasks/taskID 添加到 Action Center 基本 URL，例如： https://laptop-name:port-number/actions_/tasks/taskID。

单击“打开表单设计器”按钮将打开“表单设计器”向导，该向导使您能够自定义要在工作流中使用的表单。

选择“启用批量编辑”属性后，“打开批量表单设计器”按钮将变为可用。此选项将打开“批量表单设计器”，允许您设计表单操作，这些操作可在相应 Action Center 实例的“操作”选项卡中批量编辑或完成。

高级选项

常见

• “出错时继续”- 指定在活动引发错误时是否应继续自动化操作。该字段仅支持“布尔值”(True 和 False)。默认值为 False。因此，如果该字段为空且活动引发错误，系统将停止执行项目。如果该值设为“True”，则无论出现何种错误，系统都将继续执行项目。

注意：如果 Try Catch 异常处理中包含该活动且出错时继续属性的值为 True，则系统在执行项目时不会捕获任何错误。

• “超时 (毫秒)”- 指定等待时间（以毫秒为单位），如果超出该时间活动未运行，就会引发错误。默认值为 30000 毫秒（30 秒）。

输入

• 启用高级表单- 为表单呈现和逻辑启用增强功能和自定义选项，例如：
  • 用于编辑网格的可自定义模板。
  • 充当事件的按钮。
  • 能够使用 ES6 和新式 JavaScript 自定义表单。
  • 用于自定义表单的instance和options变量的可用性。
• “启用批量编辑 ” - 如果选中，则“ 打开批量表单设计器” 按钮在活动正文中变为可用。 此选项允许您生成 可从 Action Center 的“操作” 选项卡批量编辑或完成的表单操作。
  
  

  

  
  
• “使用本地表单文件 ” - 允许使用执行时指定的 JSON 表单文件创建表单操作。 此字段仅支持 Boolean 值。 启用后，“ 表单文件路径 ” 属性字段将显示在活动主体中，您可以在其中指定存储特定表单布局的 JSON 文件的路径。
• “生成 输入字段” - 如果选中，则 表单数据集合 中的所有条目都将作为表单设计器中的组件生成。 将其留空不会向设计器添加表单字段。
• 标签 - 机器人将输入的标签添加到操作中，以允许将来进行筛选。 此字段仅支持字符串值，并且具有 命名限制。

注意： 要允许通过“持久性”活动自动标记操作，执行工作流的机器人帐户需要对标签具有 “查看”、“ 创建”和“ 删除 ”权限。

• “Orchestrator 文件夹路径 ” - 要用于此活动的 Orchestrator 文件夹的路径。 如果留空，则使用当前的 Orchestrator 文件夹。 此字段仅支持字符串和字符串变量。

注意： 如果执行此操作的用户不具备目标文件夹的所需权限，则任务创建将失败并引发严重错误。 查看有关 文件夹权限的更多信息。

• “引用 ” - 用作将来筛选操作的参考的名称。 此字段仅支持字符串值。
• 表单文件路径 - 输入您在当前项目中保存的表单 JSON 文件的相对路径。

存储

• 存储桶名称 - 要用于表单数据中引用的大型数据文件的存储桶。
• “存储文件夹路径 ” - 指定存储桶中文件夹的完整路径。 此字段仅支持字符串和 String 变量。

已知问题

将新列添加到网格组件时，表单设计器可能不会自动更新。要解决此问题，您可以使用以下解决方法：

1. 打开表单设计器。
2. 编辑表单中的任何组件，然后保存更改。
3. 保存整个表单。
4. 重新打开表单，撤消之前所做的更改，然后再次保存。

   现在，表单应重置，并且新列应该可见。