Validating documents with App actions

Prerequisites

• Has sufficient Robot units since the app runs using 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. Create an Action app

1. Go to 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. Add and customize the Validation Control

1. Open the desired Action app, where you want to incorporate the Validation Station.
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.
   Note: 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 the action schema:
   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 the Validation Control:
   1. Go to the Validation Control properties.
   2. In the Source input, select the Action input that you have defined as a ContentValidationData type.
6. Configure the rest of the app with other Controls that you need.

3. Access Validation Control Data and its properties

4. Edit Validation Control data

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.
      This expression represents the field you want to change, accessed through the VarValidationControl_PageName variable.
   2. In the To field enter the desired value for the referenced field.
   Apart from regular fields, the AppVariable.VarValidationControl_PageName variable can also manipulate multi-value fields using AppVariable.VarValidationControl_PageName.Field("<field name>", <index>), and interact with table cells using 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:

   • Textual value (.Value)
   • Confirmed state (.Confirmed)
   • Confidence level of the value (.Confidence)
   • Deletion flag (.DeleteValue)
   • Flag to remove a value reference (.KeepReference)

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

5. Create events for the Validation Control

6. Use dedicated Validation Control activities

Common Validation Control expressions

6. Publish and deploy the app

Prerequisites

• Install the following activity package versions:
  • IntelligentOCR.Activities version 6.24.0
  • Persistence.Activities version 1.5.5 or higher.
  • AppEvents.Activities version 3.12.0 or higher.
• 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.

• Add the document that you want to process inside the Studio project folder.
• Optionally, if you want to use generative extraction or validation capabilities, then you need specific service units
  • If you enrolled in the Flex plan, you need AI units

  For more information on Document Understanding generative features, visit Generative features.

1. Process a file using Document Understanding

• DocumentTaxonomy (Taxonomy): Retrieved via the Load Taxonomy activity.
• Dom (Document Object Model) and text (Document Text): Acquired through the Digitize Document activity.
• doc (Document Path): Represents the path to the processed file.
• autoExtractionResults (ExtractionResults): This is the output from the Data Extraction Scope activity, regardless of the extraction methods used.

2. Send out the validation information to the app

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.

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