使用应用程序操作验证文档

在端到端文档处理工作流中，使用 UiPath Apps 验证站点和 Action Center 应用程序操作验证文档。

本快速入门指南通过在 UiPath TM Action 应用中添加验证站点，然后通过 Action Center 将其作为应用程序操作发送出以进行验证，帮助您开始验证文档。本教程使用 UiPath Studio 来自动化文档处理，使用 UiPath Apps 显示验证站点，并使用 Action Center 来执行验证。本教程示例中使用的文档类型是健康保险表单，其类型为 CMS 1500 索赔表单。

本快速入门指南的概述步骤如下：

1. 构建显示验证控件的操作应用程序。
2. 使用先前配置的应用程序来设计处理文档的 Studio 自动化，并将其发送以在 Action Center 中进行验证。
3. 在 Action Center 中完成操作。

步骤

1. 构建 Actions 应用程序

先决条件

确保您的租户：

• 拥有足够的 Robot Units，因为应用程序使用 Serverless Robot 运行。
• 在 Orchestrator 中创建并配置 Serverless Robot 模板。有关 Serverless Robot 以及将其添加到租户的更多信息，请访问使用 Serverless Robot 执行 Unattended 自动化。

1. 创建 Actions 应用程序

备注：

与通过 Apps 服务使用的 VB 应用程序不同，应用程序可以通过 Studio Web 访问。

要创建 Actions 应用程序，请按照以下步骤操作：

1. 转到 Studio Web。
2. 选择“新建” > “应用”以创建新项目。
3. 在应用程序的项目资源管理器中，选择“添加页面、工作流、控件、集成” > “操作” 。此步骤会向您的应用程序添加一个操作，并让您为其配置操作架构。
4. 展开“操作” ，然后选择“操作架构” 。使用您希望用于 Action Center 中的应用程序操作的 In 和 Out 参数配置操作架构。
   1. 对于结果，添加您希望操作具有的其他自定义结果。例如，您可以添加名为“批准”的自定义结果。
   2. 对于“输入属性” ，为要传递到操作中的数据添加属性。从“Apps” 下拉列表中选择此应用程序时，这些属性将显示在“创建应用程序任务” 活动中。输入属性允许您将数据从 Studio 自动化传递到操作。
   3. 对于“输出属性” ，为要从操作中检索的参数添加属性。可以通过“任务对象（输出）” 变量从“等待应用程序任务然后继续” 活动访问这些属性。
   4. 对于“输入/输出”属性，添加在 Studio 自动化中用作输入/输出参数的属性。这些输入/输出属性首先在传递给操作的“创建应用程序任务”活动中显示为属性。然后，在操作完成后，您可以从“等待应用程序任务然后继续”活动中，通过“任务对象（输出）”属性访问已更新的相同属性。

2. 添加并自定义验证控件

验证控件包含在文档处理工作流中使用的验证站点。要在操作应用程序中添加并自定义验证控件，请按照以下步骤操作：

1. 打开要包含验证站点的所需操作应用程序。

2. 选择“打开工具箱” 。

3. 在“显示”下，找到“验证控件” ，并将其添加到您的应用程序中。

   将验证控件添加到应用程序后，系统会自动在应用程序 的“项目资源管理器”的“应用程序变量”部分下创建一个Var<ValidationControl_PageName>变量。

   备注：

   您可以使用验证控件和相应的应用程序变量，从验证控件中读取信息。使用Var<ValidationControl_PageName>应用程序变量向其中写入信息。

4. 准备操作架构：

   1. 在“项目资源管理器”中的“操作”下，选择“操作架构” 。

   2. 在“输入属性”中，选择“添加属性” 。

   3. 在属性搜索栏中，选择“更多选项” 。

   4. 在“高级”下，选择“内容验证数据”。

      这是将在“创建应用程序任务”活动中显示的输入属性。内容验证数据输入属性需要ContentValidationData对象作为输入，输入可以是单个对象也可以是ContentValidationData实例的数组/列表。ContentValidationData包含验证站点的工件。ContentValidationData是使用“创建文档验证工件”活动创建的。

5. 配置验证控件：

   1. 转到“验证控件”属性。
   2. 在“来源输入”中，选择您已定义为ContentValidationData类型的“操作”输入。

6. 使用您需要的其他控件配置应用程序的其余部分。

3. 访问验证控件数据及其属性

可以使用“验证控件”变量 ( VarValidationControl_PageName ) 访问“验证控件”的各种属性，例如“分类”、“提取结果”、“选定的文档类型”、“选定的字段” 和“数据源”。您可以通过相应的应用程序变量更改“验证控件”中显示的值。请按照“编辑验证控件”数据中列出的步骤添加、修改或删除字段值。

下表描述了可以从“验证控件”访问的属性、其数据类型和说明。

表 1.验证控件属性

属性	数据类型	描述
Taxonomy	UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy	准备显示内容的分类对象。其中包含有关文档类型、字段和显示属性的信息。
ExtractionResult	UiPath.DocumentProcessing.Contracts.Results.ExtractionResult	来自验证控件的原样提取结果 (无论是否存在人为更改)。
SelectedDocumentType	System.String	验证控件中当前选择的文档类型的名称。
SelectedField	UiPath.DocumentProcessing.Contracts.Apps.FieldValueDetails	验证控件中当前选择的字段及其值。
DataSource	UiPath.DocumentProcessing.Contracts.Actions.ContentValidationData	当前作为验证控件来源的内容验证数据。
Hidden	boolean	管理控件是可见还是隐藏的控件属性状态。
Disabled	boolan	管理控件是否可编辑的控件属性状态。
IsValid	boolean	检查“验证控制”值的有效性。如果为 true，则表示它有效。

4. 编辑验证控件数据

您可以通过相应的应用程序变量更改“验证控件”中显示的值。例如，您可以通过相应的应用程序变量更改在“验证控件”中显示的“提取结果”值。

以下示例显示了如何更新常规字段值：

1. 选择应用程序中的任何控件，然后转到事件。
2. 选择“定义自动化” 。此操作将打开 Studio Web 的设计器面板，您可以在其中为特定应用程序控件构建触发器自动化。
3. 在文档“提取结果”的上下文中，要添加或更改常规字段的字段值，请在自动化中添加“设置变量值”活动。

   1. 对于“目标变量”字段，使用AppVariable.VarValidationControl_PageName.Field("<field name>").Value 。

      该表达式表示您要更改的字段，可通过VarValidationControl_PageName变量访问。

   2. 在“目标”字段中，为引用的字段输入所需的值。

      除常规字段外， AppVariable.VarValidationControl_PageName变量还可使用AppVariable.VarValidationControl_PageName.Field("<field name>", <index>)操作多值字段，并使用AppVariable.VarValidationControl_PageName.Field("<table field name").Field("<column name>", <row index>)与表格单元格交互。

      要删除值，请以类似方式选择目标值，并使用设置为True 的.DeleteValue标志。您可以在验证控件中更新的值属性包括：

   • 文本值 ( .Value )
   • 已确认的状态 ( .Confirmed )
   • 值的置信度 ( .Confidence )
   • 删除标志 ( .DeleteValue )
   • 标记以删除值引用 ( .KeepReference )

您可以使用相同的步骤在运行时更改其他验证控件数据。唯一的区别是，您在“目标变量”字段中使用了不同的变量，因此它对应于要更改的“验证控件”数据。例如，如果要使用不同的值进行更新，可以使用AppVariable.ValidationControl.SelectedDocumentType变量。

图 1.“设置变量值”活动，您可以通过这些活动更新“验证控件”中的数据

5. 为验证控件创建事件

您可以触发特定于验证控件的各种事件。在“项目资源管理器”中，导航到“验证控件”，然后将其选中。验证控件的“事件”面板允许您为特定事件定义自动化。

下表描述了可用的验证控件事件：

表 2. 验证控件事件

事件	描述
就绪	加载验证控件时触发。
文档类型已更改	当用户更改验证控件的文档类型时触发。
选定的字段	当用户在验证控件中选择一个字段或一个字段值时触发。
字段值已更改	当用户在验证控件中添加、删除或替换字段值时触发。

6. 使用专用的验证控件活动

您可以使用AppEvents.Activities包中专用于处理验证控件的特定活动：

1. “设置验证控件字段焦点” : 用于根据配置的事件将焦点放在某个字段上。
2. Save Validation Control State: Saves the current state of the Validation Control, including all field edits made by the validator. You must call this activity before the Submit Action in your app's submit button event. Without it, the ValidatedExtractionResults output of the Retrieve Document Validation Artifacts activity returns null.

7. Add a submit button

The Validation Control does not include a built-in submit button. You must add a button to your app and configure it to submit the action task. To do so, follow these steps:

1. Add a Button control to your app page.
2. Select the button, then go to Events.
3. Under the Click event, select Define automation.
4. In the automation, add a Save Validation Control State activity. Set its Validation Control input to your Validation Control variable (for example, MainPage.ValidationControl). This saves the validator's edits so they are available after the task is submitted.
5. After the Save Validation Control State activity, add a Submit Action rule to complete the action task and send the outcome back to Action Center.

重要提示：

The Save Validation Control State activity must execute before the Submit Action. If the Submit Action runs without a prior Save Validation Control State call, the ValidatedExtractionResults output of the Retrieve Document Validation Artifacts activity will be null.

常用验证控件表达式

在创建包含验证控件的应用程序时，可以使用以下表达式来访问该验证控件公开的各种数据。下表描述了使用“验证控件”时可以使用的最常用表达式：

表 3. 常见“验证控件”表达式

用途	表达式
访问验证控件中显示的提取结果	AppVariable.VarValidationControl_PageName.ExtractionResult MainPage.ValidationControl.ExtractionResult
访问“验证控件”中加载的分类	AppVariable.VarValidationControl_PageName.Taxonomy MainPage.ValidationControl.Taxonomy
访问“验证控件”中的选定字段	AppVariable.VarValidationControl_PageName.SelectedField MainPage.ValidationControl.SelectedField 所选字段的属性可以是： Field.FieldName – 字段名称。 Field.FieldType – 字段类型。 Field.ValidatorNotes – 字段的验证程序说明。 Field.Values – 所选字段的所有值。 Field.Value – 与字段值相关的信息： FieldValue.Value FieldValue.Confidence FieldValue.OperatorConfirmed FieldValue.FieldValueIndex （对于多值字段，返回与所选“字段值”相关的索引）。
访问其他验证控件属性	MainPage.ValidationControl.<PropertyName>
读取提取结果数据	使用提取结果类公开的方法。
读取分类数据	使用分类类公开的方法。
访问字段值以在验证控件中更新该值	AppVariable.<ValidationControlVariable>.Field("<FieldName>").Value
检索“验证控件”中显示的字段名称列表	AppVariable.<ValidationControlVariable>.ExtractionResult.GetFields().Select(Function(f) f.FieldName)

8. Publish and deploy the app

在构建 Action 应用程序并为其中的控件触发自动化后，您即可发布该应用程序。发布应用程序后，可用于创建应用程序操作。有关发布应用程序的更多信息，请访问发布、部署和升级应用程序项目。

2. 创建 Studio 自动化

先决条件

• 安装以下活动包版本：
  • IntelligentOCR.Activities 版本 6.24.0
  • Persistence.Activities 版本 1.5.5 或更高版本。
  • AppEvents.Activities 版本 3.12.0 或更高版本。
• 在 Orchestrator 中要发布文档处理自动化的同一文件夹中创建一个存储桶。在应用程序中加载验证控件所需的数据存储在 Orchestrator 存储桶中。
• 在 Studio 项目文件夹中添加要处理的文档。
• （可选）如果要使用生成式提取或验证功能，则需要特定的服务单元
  • 如果您加入了 Flex 计划，则需要 AI Unit。有关 Document Understanding 生成式功能的更多信息，请访问生成式功能。

1. 使用 Document Understanding 处理文件

添加使用 Document Understanding 处理文件的活动。使用数字化和提取，通过应用程序准备要在 Action Center 中进行验证的文档。

添加用于处理文件的活动后，以下变量应可用：

• DocumentTaxonomy （分类）：通过“加载分类”活动检索。
• Dom （文档对象模型）和text （文档文本）：通过“数字化文档”活动获取。
• doc （文档路径）：表示已处理文件的路径。
• autoExtractionResults (提取结果)：无论使用哪种提取方法，这都是“数据提取作用域”活动的输出。

2. 将验证信息发送到应用程序

文档准备好进行验证后，您可以准备要发送给先前创建和部署的应用程序的所有信息。请执行以下步骤：

1. 添加“创建文档验证工件”活动以创建Content Validation Data对象，该对象存储在操作应用程序中加载验证控件所需的信息。在此示例中，使用先前创建或输出的变量配置活动：
   • 存储桶文件夹路径（可选） ：在其中创建存储桶的 Orchestrator 文件夹的名称。
   • 存储桶名称： storageBucketName
   • 存储桶目录路径（必填） ：先前输入的存储桶中要存储操作数据的目录路径。
   • 文档路径： doc
   • 文档文本: text
   • 文档对象模型： dom
   • 分类： taxonomy
   • 自动提取结果： autoExtractionResults
2. 添加“创建应用程序任务”活动，以便将Content Validation Data对象绑定到先前设计的应用程序，然后将其发送到 Action Center 进行验证。在此示例中，请按如下方式配置活动：
   • 标题： CVD
   • 优先级: Medium
   • Apps： Demo.Validation.Control.in.Apps
   • 应用程序版本：v2.0.0选择应用程序以及要用于创建操作的相应版本后，该应用程序的输入属性将显示在活动的主体中。

     • 在此示例中，输入属性之一为Action_Content_Validation_Data ，它需要使用先前创建的文档验证工件： contentValidationData 。

       图 2. “创建应用程序任务”活动

       

3. 添加“等待应用程序任务然后继续”活动以返回有关操作的信息，然后继续执行工作流。在“已创建的应用程序任务”字段中，输入“创建应用程序任务”活动的输出变量。
4. 添加“检索文档验证工件”活动，以在用户在 Action Center 中执行验证后返回文档验证工件。将创建文档验证工件活动的输出变量作为检索文档验证工件活动的输入。
   提示：

   您还可以为存储在验证工件中的其他信息创建专用的输出变量，例如自动提取结果和已验证的提取结果。

   重要提示：

   The ValidatedExtractionResults output is only populated if the Save Validation Control State activity was called before the Submit Action executes. If the Submit Action runs without a prior Save Validation Control State call, this output returns null. For more information, see step 7 of building the Action app.

3. 在 Action Center 中执行验证

1. 打开 Action Center，然后转到“我的操作” （“管理操作” > “管理操作”） 。
2. 在“未分配”选项卡中，找到刚才使用以前的 Studio 自动化创建的操作。
3. 如果要将操作分配给自己，请选择所需的操作，然后选择“分配给自己” 。
4. 如果要将操作分配给其他用户，请为所需操作选择更多选项。然后选择“分配给用户” ，然后从下拉列表中选择一个用户。
5. 转到“待处理”选项卡，并完成操作，以便 Studio 工作流可以继续。