Validating stream results with Communications Mining

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, and then select App to create a new project.
3. Within the Project Explorer of your app, select Add pages, workflows, controls, integrations, and then select Action.

   This step adds an Action to your app, and allows you to 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, which 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 to your app.
   Adding the Validation Control to your app automatically creates a Var<ValidationControl_PageName> variable under the App variables section from the Project Explorer of your application.
   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 Communications Mining Validation Artifacts activity.
5. Configure the Validation Control:
   1. Go to the Validation Control properties.
   2. In the Source input, select the Action input you have defined as a ContentValidationData type.
6. Configure the rest of the app with other controls you need.

3. Create events for the Validation Control

4. Use dedicated Validation Control activities

5. Publish and deploy the app

Prerequisites

• Install the following activity package versions:
  • CommunicationsMining.Activities version 1.5.1 or higher.
  • 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 automation that processes stream results.

  Data required to load the Validation Control within apps is stored within an Orchestrator storage bucket.

• Add the stream results that you want to process inside the Studio project folder.
• Optionally, if you want to use generative extraction or validation capabilities, then you need AI units. For more information on the Generative Extraction feature in Communications Mining™, visit Generative Extraction.

1. Process a file using Communications Mining

• Output stream result: The stream result is stored in a variable in the output property, Results, of the Get Stream Results activity.

2. Send out the validation information to the app

1. Add a Create Communications Mining 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:

   • Orchestrator Bucket Folder Path: The name of the Orchestrator folder that hosts the storage bucket where you want to create the action.
   • Orchetsrator Bucket: storageBucketName
   • Orchestrator Bucket Directory Path: The directory path within the previously inputted storage bucket where you want to store action data
   • Input Stream Result: The stream result that you want to validate. Use one of the entries in the output variable of the Get Stream Results activity, which is a collection of results. Select one of the entries using, for example, <getStreamResultsOuputVariable>.Results(<index>).
   • Model: The model corresponding to the input stream result. Use the Model property of the output variable of the Get Stream Results activity, found under <getStreamResultsOuputVariable>.Model.

   • Timeout (milliseconds): Specify waiting time (in milliseconds) for the activity to connect to Orchestrator before an error is thrown.

   • Content Validation Data: The output variable where all the information about the processed stream result and the information on the location of action data is stored. You later use this output variable as input for the Retrieve Communications Mining Validation Artifacts activity.

2. Add a Create App Task activity, so you can bind the 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 Communications Mining validation artifacts previously created: contentValidationData.
   Figure 1. 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 Communications Mining Artifacts activity to return the Communications Mining validation artifacts after the user has performed validation in Action Center.

   Pass the output variable of the Create Communications Mining Validation Artifacts activity as the input of the Retrieve Communications Mining Artifacts activity.