Validação de documentos com ações de aplicativos

This quickstart guide helps you start validating documents by adding the Validation Station within UiPath® Action apps, and then sending them out for validation through Action Center as App actions. The tutorial uses UiPath Studio to automate the document processing, UiPath Apps to for displaying the validation station, and Action Center for performing the validation. The document type that is used in the examples throughout this tutorial is a health insurance form, of type CMS 1500 claim form.

As etapas de visão geral deste guia de início rápido são:

1. Crie o aplicativo de Ação que exibe o Controle de validação.
2. Use um aplicativo configurado anteriormente para criar a automação do Studio que processa o documento e o envia para validação no Action Center.
3. Conclua a ação no Action Center.

Etapas

1. Criar um aplicativo do Action

Pré-requisitos

Certifique-se de que seu tenant:

• Tem Robot Units suficientes, pois o aplicativo é executado usando Serverless Robots.
• A Serverless robot template is created in Orchestrator and provisioned. For more information on serverless robots and adding them to a tenant, visit Executing unattended automations with Serverless robots.

1. Crie um aplicativo de Ação

Observação:

Unlike VB apps available via the Apps service, apps can be accessed through Studio Web.

Para criar um aplicativo do Action Center, siga estas etapas:

1. Acesse o Studio Web.
2. Select Create New > App to create a new project.
3. Within the Project Explorer of your app, select Add pages, workflows, controls, integrations > Action. This step adds an Action to your app, and lets you configure an action schema for it.
4. Expand Action, and select ActionSchema. Configure the action schema with the In and Out arguments that you want for App actions in Action Center.
   1. For Outcomes, add other custom outcomes that you want the action to have. For example, you can add the a custom outcome, named "Approve".
   2. For Input Properties, add properties for data that you want to pass into the action. These properties will appear in the Create App Task activity, when this app is selected from the Apps dropdown list. Input properties allow you to pass data from your Studio automation to your action.
   3. For Output Properties, add properties for arguments that you want to retrieve from the action. These properties will be accessible from the Wait for App Task and Resume activity, through the Task Object (Output) variable.
   4. For Input/Output properties, add properties that function as In/Out arguments in your Studio automation. These Input/Output properties first appear as properties in the Create App Task activity, that you pass to the action. And then, after the action is completed, you can access the same properties, that were updated, from the Wait for App Task and Resume activity, through the Task Object (Output) property.

2. Adicione e personalize o Controle de validação

Um controle de validação incorpora a estação de validação, usada em fluxos de trabalho de processamento de documentos. Para adicionar e personalizar um controle de validação em um aplicativo do Action Center, siga estas etapas:

1. Abra o aplicativo de Ação desejado, no qual você deseja incorporar a Estação de Validação.

2. Select Open toolbox.

3. Under Display, find the Validation Control, and add it into your app.

   Adding the Validation Control to your app automatically creates a Var<ValidationControl_PageName> variable under the App variables section from your app's Project Explorer.

   Observação:

   You can use the Validation Control and the corresponding App Variable to read information from the Validation Control. Use the Var<ValidationControl_PageName> App Variable to write information to it.

4. Prepare o esquema de ação:

   1. In the Project Explorer, under Action, select ActionSchema.

   2. In the Input Properties, select Add property.

   3. In the property search bar, select More Options.

   4. Under Advanced, select ContentValidationData.

      This is the input property that will display in the Create App Task activity. The ContentValidationData input property requires a ContentValidationData object as input, which can be a single object or an array/list of ContentValidationData instances. ContentValidationData contains the artifacts of the Validation Station. ContentValidationData is created using the Create Document Validation Artifacts activity.

5. Configure o controle de validação:

   1. Acesse as propriedades do Controle de validação.
   2. In the Source input, select the Action input that you have defined as a ContentValidationData type.

6. Configure o restante do aplicativo com outros Controles de que você precisar.

3. Dados de controle de validação de acesso e suas propriedades

Various properties of the Validation Control, such as Taxonomy, Extraction Result, Selected Document Type, Selected Field, and Data Source, can be accessed using the Validation Control variable (VarValidationControl_PageName). You can change the values displayed in the Validation Control through the corresponding app variable. Follow the steps outlined under Edit Validation Control data to add, modify, or remove a field value.

A tabela a seguir descreve as propriedades que você pode acessar a partir do Controle de validação, seu tipo de dados e as descrições.

Table 1. Validation Control properties

Propriedade	Tipo de dados	Description
Taxonomy	UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy	O objeto de taxonomia com o qual o conteúdo foi preparado para exibição. Ele contém informações sobre os tipos de documentos, campos e propriedades de exibição.
ExtractionResult	UiPath.DocumentProcessing.Contracts.Results.ExtractionResult	Os resultados da extração, conforme estão (com ou sem alterações humanas), do Controle de validação.
SelectedDocumentType	System.String	O nome do tipo de documento selecionado atualmente no Controle de Validação.
SelectedField	UiPath.DocumentProcessing.Contracts.Apps.FieldValueDetails	O campo atualmente selecionado no Controle de Validação com seu valor.
DataSource	UiPath.DocumentProcessing.Contracts.Actions.ContentValidationData	Os dados de validação de conteúdo que são atualmente a origem do Controle de Validação.
Hidden	boolean	O estado da propriedade do controle que rege se o controle está visível ou oculto.
Disabled	boolan	O estado da propriedade de controle que rege se o controle é editável ou não.
IsValid	boolean	Verifica a validade do valor do Controle de validação. Se verdadeiro, indica que é válido.

4. Editar dados de controle de validação

Você pode alterar os valores exibidos no Controle de validação por meio da variável do aplicativo correspondente. Por exemplo, você pode alterar os valores do Resultado da Extração exibidos no Controle de Validação por meio da variável do aplicativo correspondente.

O seguinte exemplo mostra como atualizar um valor de campo regular:

1. Select any Control in your app, and go to Events.
2. Select Define automation. This action opens Studio Web's designer panel, where you can build a trigger automation for a certain app control.
3. In the context of the document's Extraction Results, to add or change a field value for regular fields, add a Set Variable Value activity in the automation.

   1. For the To Variable field, use AppVariable.VarValidationControl_PageName.Field("<field name>").Value.

      Essa expressão representa o campo que você deseja alterar, acessado por meio da variável VarValidationControl_PageName .

   2. In the To field enter the desired value for the referenced field.

      Além de campos regulares, a variável AppVariable.VarValidationControl_PageName também pode manipular campos de vários valores usando AppVariable.VarValidationControl_PageName.Field("<field name>", <index>) e interagir com células de tabela usando AppVariable.VarValidationControl_PageName.Field("<table field name").Field("<column name>", <row index>).

      To delete values, select the target value similarly and use the .DeleteValue flag set to True. The properties of values that you can update in the validation control include:

   • Valor textual (.Value)
   • Estado confirmado (.Confirmed)
   • Nível de confiança do valor (.Confidence)
   • Sinalização de exclusão (.DeleteValue)
   • Sinalizador para remover uma referência de valor (.KeepReference)

You can use the same steps for changing other Validation Control data at runtime. The only difference is that you use a different variable, in the To Variable field, so it corresponds to the Validation Control data you want to change. For example, you can use AppVariable.ValidationControl.SelectedDocumentType variable if you want to update it with a different value.

Figure 1. The Set Variable Value activities through which you can update data from the Validation Control

5. Criar eventos para o Controle de validação

You can trigger various events specific to the Validation Control. In the Project Explorer, navigate to the Validation Control, and select it. The Events panel of the Validation Control allows you to define automations for specific events.

A tabela a seguir descreve os eventos de Controle de validação disponíveis:

Table 2. Validation Control events

Evento	Description
Pronto	Dispara quando o Controle de validação é carregado.
Tipo de documento alterado	Dispara quando o usuário altera o tipo do documento no Controle de Validação.
Campo selecionado	Dispara quando o usuário seleciona um dos campos ou o valor de um campo no Controle de validação.
Valor do campo alterado	Dispara quando o usuário adiciona, remove ou substitui um valor de campo no Controle de validação.

6. Use atividades dedicadas ao Controle de validação

You can use specific activities dedicated to working with the Validation Control, from the AppEvents.Activities package:

1. Set Validation Control Field Focus: Allows you to focus on a field, based on a configured event.
2. Save Validation Control State: Saves the state of the Validation Control. You can use this when you want to revisit and complete the validation later.

Expressões comuns de controle de validação

Quando estiver criando seu aplicativo que contém um Controle de Validação, você pode usar as seguintes expressões para acessar vários dados expostos pelo Controle de Validação. A tabela a seguir descreve as expressões mais comuns que você pode usar ao trabalhar com o Controle de validação:

Table 3. Common Validation Control expressions

Finalidade	Expression
Acesse os resultados da extração exibidos no controle de validação	AppVariable.VarValidationControl_PageName.ExtractionResult MainPage.ValidationControl.ExtractionResult
Acesse a taxonomia carregada no Controle de Validação	AppVariable.VarValidationControl_PageName.Taxonomy MainPage.ValidationControl.Taxonomy
Acesse o campo selecionado no Controle de Validação	AppVariable.VarValidationControl_PageName.SelectedField MainPage.ValidationControl.SelectedField As propriedades do campo selecionado podem ser: Field.FieldName – Nome do campo. Field.FieldType – Tipo de campo. Field.ValidatorNotes – As notas do validador do campo. Field.Values – Todos os valores de um campo selecionado. Field.Value – Informações relacionadas ao valor do campo: FieldValue.Value FieldValue.Confidence FieldValue.OperatorConfirmed FieldValue.FieldValueIndex (para campos de vários valores, retorna o índice ao qual o Valor de campo selecionado pertence).
Acesse propriedades adicionais do Controle de validação	MainPage.ValidationControl.<PropertyName>
Ler dados de resultados de extração	Use the methods exposed by the Extraction Result class .
Ler dados de taxonomia	Use the methods exposed by the Taxonomy class .
Acesse um valor de campo para atualizá-lo no Controle de Validação	AppVariable.<ValidationControlVariable>.Field("<FieldName>").Value
Recuperar a lista de nomes de campos exibidos no Controle de Validação	AppVariable.<ValidationControlVariable>.ExtractionResult.GetFields().Select(Function(f) f.FieldName)

6. Publique e implante o aplicativo

After you build your Action app and trigger automations for Controls inside of it, you can publish it. Publishing the app makes it available to use for creating App actions. For more information on publishing apps, visit Publishing, deploying, and upgrading app projects.

2. Criar automação do Studio

Pré-requisitos

• Instale as seguintes versões do pacote de atividades:
  • IntelligentOCR.Activities versão 6.24.0
  • Persistence.Activities versão 1.5.5 ou posterior.
  • AppEvents.Activities versão 3.12.0 ou posterior.
• Create a storage bucket in Orchestrator, in the same folder where you want to publish the document processing automation. Data required to load the Validation Control within apps is stored within an Orchestrator storage bucket.
• Adicione o documento que você deseja processar dentro da pasta do projeto do Studio.
• Opcionalmente, se você quiser usar recursos de extração ou validação generativos, precisará de unidades de serviço específicas
  • If you enrolled in the Flex plan, you need AI unitsFor more information on Document Understanding generative features, visit Generative features.

1. Processar um arquivo usando o Document Understanding

Adicione atividades que usem o Document Understanding para processar um arquivo. Prepare o documento para validação no Action Center por meio de aplicativos, usando digitalização e extração.

Após adicionar as atividades para processar o arquivo, as seguintes variáveis devem estar disponíveis:

• DocumentTaxonomy (Taxonomy): Retrieved via the Load Taxonomy activity.
• Dom (Document Object Model) and text (Document Text): Acquired through the Digitize Document activity.
• doc (Caminho do documento): representa o caminho para o arquivo processado.
• autoExtractionResults (ExtractionResults): This is the output from the Data Extraction Scope activity, regardless of the extraction methods used.

2. Envie as informações de validação para o aplicativo

Depois que o documento estiver pronto para ser validado, você poderá preparar todas as informações a serem enviadas para o aplicativo criado e implantado anteriormente. Siga estas etapas:

1. Add a Create Document Validation Artifacts activity to create the Content Validation Data object which stores the information necessary for loading the Validation Control within the Action app. In this example, configure the activity using the previously created or outputted variables:
   • Bucket Folder Path: The name of the Orchestrator folder where the storage bucket was created.
   • Bucket Name: storageBucketName
   • Bucket Directory Path: The directory path within the previously inputted storage bucket, where you want to store action data.
   • DocumentPath: doc
   • Document Text: text
   • Document Object Model: dom
   • Taxonomy: taxonomy
   • Automatic Extraction Results: autoExtractionResults
2. Add a Create App Task activity, so you can bind the Content Validation Data object to the previously designed app and then send it out to Action Center for validation. In this example, configure the activity as follows:
   • Title: CVD
   • Priority: Medium
   • Apps: Demo.Validation.Control.in.Apps
   • App Version: v2.0.0 After you select the App, and the corresponding version that you want to use for creating the action, the input properties of that app will be shown in the body of the activity.

     • In this example, one of the input properties is Action_Content_Validation_Data, which requires the document validation artifacts previously created: contentValidationData.

       Figure 2. The Create App Task activity

       

3. Add a Wait for App Task and Resume activity to return the information about the action, and resume the workflow. In the Created App Task field, enter the output variable of the Create App Task activity.
4. Add a Retrieve Document Validation Artifacts activity, to return the document validation artifacts after the user performed validation in Action Center. Pass the output variable of the Create Document Validation Artifacts activity as the input of the Retrieve Document Validation Artifacts activity.
   Dica:

   You can also create dedicated output variables for additional information stored in the validation artifacts, such as AutomaticExtractionResults, and ValidatedExtractionResults.

3. Realize a validação no Action Center

1. Open Action Center, and go to My Actions or Manage Actions.
2. In the Unassigned tab, find the action you just created using the previous Studio automation.
3. If you want to assign the action to yourself, select the desired action, and then select Assign to self.
4. If you want to assign the action to another user, select More options for the desired action. Then select Assign to user, and select a user from the dropdown list.
5. Go to the Pending tab, and complete the action, so the Studio workflow can be resumed.