创建表单任务

UiPath.Persistence.Activities.FormTask.CreateFormTask

描述

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

先决条件

• 安装 UiPath.FormActivityLibrary 包 2.0.7 或更高版本，以启用表单设计器。
• 表单任务的大小上限为 1MB。 为满足此 1MB 的限制，您需要仅使用存储桶将图像嵌入表单中。 此外，我们建议仅对小于 2KB 的徽标和图标使用base64类型的图像。

项目兼容性

Windows - 旧版 | Windows | 跨平台

Windows、Windows - 旧版配置

设计器面板

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

  在创建操作之前，请确保操作目录存在。否则，操作创建将失败，并显示以下错误消息：“不存在名称为 [action_catalog_name] 的任务目录，错误代码：2451”。

• FormData - A collection of business data in the form Dictionary<String,Argument> that you want to display in a form within the Actions inbox. Modifying Out and In/Out arguments maps them back to the workflow after the task is completed. This field supports Dictionary<String,Argument> objects only.
• “任务对象(输出)” - 创建操作后从 Orchestrator 作为FormTaskData对象返回的任务对象。可以将此对象传递给“等待表单任务然后继续”活动，以便在操作完成之前暂停工作流的执行。

备注：

任务对象有几个属性，用于保存有关输出操作对象的信息。例如， TaskUrl属性为您在 Orchestrator 内部部署版中的“操作”选项卡中提供了操作的 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 的“操作” 选项卡中批量编辑或完成这些表单操作。

  

• FormData - A collection of business data in the form Dictionary<String,Argument> that you want to display in a form within the Actions inbox. Modifying Out and In/Out arguments maps them back to the workflow after the task is completed. This field supports Dictionary<String,Argument> objects only.

• “生成输入字段” - 选中此选项后，系统会将“表单数据集合”中的所有条目生成为“表单设计器”中的组件。将其留空不会向设计器添加其他表单字段。

• 标签- 机器人将输入的标签添加到操作中，以便于将来进行筛选。此字段仅支持字符串值，并且有命名限制。

备注：

要允许通过“暂留”活动标记自动操作，执行工作流的机器人帐户需要对标签 的查看、创建和删除权限 。

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

备注：

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

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

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

  重要提示：

  在创建操作之前，请确保操作目录存在。否则，操作创建将失败，并显示以下错误消息：“不存在名称为 [action_catalog_name] 的任务目录，错误代码：2451”。

• 任务优先级- 用于选择操作的优先级。默认情况下，该属性设置为TaskPriority.MEDIUM ，提供以下选项： TaskPriority.Low 、 TaskPriority.MEDIUM 、 TaskPriority.High和TaskPriority.Critical 。

• 任务标题- 要创建的操作的标题。此字段仅支持字符串和String变量。

• 使用本地表单文件- 允许使用 JSON 表单文件创建表单操作（在执行时指定）。此字段仅支持Boolean值。启用后， “表单文件路径”属性字段将显示在活动的主体中，您可以在其中指定 JSON 文件的路径，该文件存储了特定表单布局。

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

其他

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

输出

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

存储

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

  结合使用图像嵌入与存储桶时，必须与“上传存储文件”活动结合使用。必须在参数名称的“表单数据收集”属性中添加后缀，并通过在HTML 元素组件中使用下划线 ( _ ) 将其映射到表单中的图像。参数名称 ( <key>_storage ) 必须映射到上传存储文件活动的目标属性中的存储值。请注意，图像文件名不得包含加号 ( + )，因为存储桶上传流程会掩盖此字符，从而导致错误。

跨平台配置

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

  在创建操作之前，请确保操作目录存在。否则，操作创建将失败，并显示以下错误消息：“不存在名称为 [action_catalog_name] 的任务目录，错误代码：2451”。

• FormData - A collection of business data in the form Dictionary<String,Argument> that you want to display in a form within the Actions inbox. Modifying Out and In/Out arguments maps them back to the workflow after the task is completed. This field supports Dictionary<String,Argument> objects only.
• “任务对象(输出)” - 创建操作后从 Orchestrator 作为FormTaskData对象返回的任务对象。可以将此对象传递给“等待表单任务然后继续”活动，以便在操作完成之前暂停工作流的执行。

备注：

任务对象有几个属性，用于保存有关输出操作对象的信息。例如， TaskUrl属性为您在 Orchestrator 内部部署版中的“操作”选项卡中提供了操作的 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. 重新打开表单，撤消之前所做的更改，然后再次保存。 现在，表单应重置，并且新列应该可见。