Create Document Classification Action

UiPath.IntelligentOCR.Activities.CreateDocumentClassificationAction

Description

Creates an action of type Document Classification in Action Center. The output of the Create Document Classification Action activity can be used with the Wait For Document Classification Action And Resume activity to suspend and resume orchestration workflows upon human action completion in Action Center.

note

Make sure that the connection between Robot and Orchestrator is correctly established. Visit Connecting robots to Orchestrator to find more information about how to connect robots to Orchestrator.

Project compatibility

Windows-Legacy | Windows

Configuration

Designer panel

Action Details

• ActionCatalog - Specifies the name of the action catalog from Action Center. Make sure the action catalog exists prior to the action creation, otherwise action creation fails, resulting in an error. More information about Action catalogs can be found here.
• ActionFolderPath - Specifies if the entity should be created or queried from a different directory than that of the current process for an auto-provisioned Robot user. Mandatory.
• ActionPriority - Specifies the priority level of the action. The possible values are Low, Medium, High, and Critical. The default value is Medium. This input only accepts values of type UiPath.IntelligentOCR.Activities.Actions.Model.DocumentActionPriority.
• ActionTitle - Specifies the title of the action. All actions should have a title for identification/accessing purposes in Action Center and/or Orchestrator. Mandatory.

Storage Details

• BucketDirectoryPath - The path of the directory inside the storage bucket where the files used as part of the action are to be stored and retrieved. This field only supports string values, with / (slash) as the separator to indicate subdirectories. For example "Finance/AccountsPayable".
• BucketName - Specifies the name of an existing storage bucket where the action stores its data.
  note

  Make sure that you have enabled all needed permissions for Orchestrator. Go to Folder Permissions for the Robot role in Orchestrator and verify the following:

  • For Storage Files permissions, Create and Edit options are selected.
  • For Storage Buckets permissions, View option is selected.
  • For Actions permissions, Create option is selected.

Document Classification Data Input

• AutomaticClassificationResults - The automatically generated classification results, stored in an ClassificationResult[] proprietary variable. If a variable is added to this field, the results of the automatic classification results are displayed, enabling you to review and modify them. If left empty, the Classification Station opens for the user to validate the data manually. This field supports only ClassificationResult[] variables.
• DocumentObjectModel - The Document Object Model (DOM) you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only Document variables.
• DocumentPath - The path to the document you want to validate. This field supports only strings and String variables.
• DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only strings and String variables.
• Taxonomy - The Taxonomy against which the document is to be processed, stored in a DocumentTaxonomy variable. This object can be obtained by using a Load Taxonomy activity or by de-serializing a string into a DocumentTaxonomy object. This field supports only DocumentTaxonomy variables.

Action Output

• ActionObject - Provides the action object returned by Orchestrator. This action object should be passed in as an input to the Wait For Document Classification Action And Resume activity.

Properties panel

Action Details

• ActionCatalog - Specifies the name of the action catalog from Action Center. Make sure the action catalog exists prior to the action creation, otherwise action creation fails, resulting in an error. Visit Action Catalogs for more information about action catalogs. .
• ActionFolderPath - Specifies if the entity should be created or queried from a different directory than that of the current process for an auto-provisioned Robot user.
• ActionPriority - Specifies the priority level of the action. The possible values are Low, Medium, High, and Critical. The default value is Medium. This input only accepts values of type UiPath.IntelligentOCR.Activities.Actions.Model.DocumentActionPriority.
• ActionTitle - Specifies the title of the action. All actions should have a title for identification/accessing purposes in Action Center and/or Orchestrator.

Action Output

• ActionObject - Provides the action object returned by Orchestrator. This action object should be passed in as an input to the Wait For Document Classification Action And Resume activity.

Common

• ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
• DisplayName - Specifies the display name of the activity.
• Timeout (milliseconds) - Specifies how long to wait (in milliseconds) for the activity to connect to Orchestrator before an error is thrown. The default value is 30000 milliseconds (30 seconds). This field supports only integer and Int32 variables.

Document Classification Data Input

• AutomaticClassificationResults - The automatically generated classification results, stored in an ClassificationResult[] proprietary variable. If a variable is added to this field, the results of the automatic classification results are displayed, enabling you to review and modify them. If left empty, the Classification Station opens for the user to validate the data manually. This field supports only ClassificationResult[] variables.
• DocumentObjectModel - The Document Object Model (DOM) you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only Document variables.
• DocumentPath - The path to the document you want to validate. This field supports only strings and String variables.
• DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports only strings and String variables.
• Taxonomy - The Taxonomy against which the document is to be processed, stored in a DocumentTaxonomy variable. This object can be obtained by using a Load Taxonomy activity or by de-serializing a string into a DocumentTaxonomy object. This field supports only DocumentTaxonomy variables.

Document Validation Data Input

• DocumentText - The text extracted from the document.

Misc

• AutomaticExtractionResults - Provide a variable of type ExtractionResult, which contains automatically generated extraction results.
• EnablePageReordering (Preview) - If set to True, allows you to reorder document pages inside the Classification Station, by drag and dropping the pages in the desired order.
• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Storage Details

• BucketDirectoryPath - The path of the directory inside the storage bucket where the files used as part of the action are to be stored and retrieved. This field only supports string values, with / (slash) as the separator to indicate subdirectories. For example "Finance/AccountsPayable".
• BucketName - Specifies the name of an existing storage bucket where the action stores its data.
  note

  Make sure that you have enabled all needed permissions for Orchestrator. Go to Folder Permissions for the Robot role in Orchestrator and verify the following:

  • For Storage Files permissions, Create and Edit options are selected.
  • For Storage Buckets permissions, View option is selected.
  • For Actions permissions, Create option is selected.

Using the Create Document Classification Action

The Create Document Classification Action activity can be used with Studio Desktop, in Action Center, or with Orchestrator.