Wait For Document Classification Action And Resume

UiPath.IntelligentOCR.Activities.WaitForDocumentClassificationActionAndResume

Description

The activity can be used to suspend the execution of the current workflow until a specified document classification action is completed. To designate a classification action, a DocumentClassificationActionData object obtained from the Create Document Classification Action activity must be supplied. Upon completion of the classification action provided as input, the execution of the workflow can be resumed.

Note:

When creating a new Studio project that includes this activity, you should select the Document Understanding Process template or go to Project Settings and activate the Supports Persistence flag.

For Action Center integration, CORS/CSP settings are required. Visit CORS/CSP configuration for more details.

Project compatibility

Windows-Legacy | Windows

Configuration

Designer panel

Action Details

• ActionObject(Input) - Specifies the input action, which is actually the output of the Create Document Classification Action activity.

Storage Details

• DownloadDirectoryPath - Provides a path to a local directory used for downloading and storing the document associated with the action. If set, the document is downloaded to the specified directory path.
• RemoveDataFromStorage - If selected, removes all data associated with the current action from the storage bucket. Once all data is removed, no completed actions are available in Orchestrator.
  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, View and Delete options are selected.
  • For Storage Buckets permissions, View option is selected.
  • For Actions permissions, View option is selected.

Action Output

• ActionObject(Output) - Provides the updated action object returned by Orchestrator once the action is completed. These are the available action objects: AssignedToUser, CreatorUser, DeleterUser, LastModifierUser, and CompletedByUser.

Document Classification Data Output

• AutomaticClassificationResults - If set, the automatically generated classification results used by the document classification action are downloaded from storage and set in the variable passed in. This field supports only ClassificationResult[] variables.
• DocumentObjectModel - If set, the document object model used by the document classification action is downloaded from storage and set in the variable passed in. This field supports only Document variables.
• DocumentPath - If set, it returns the full local path of the downloaded document associated with the action in the specified DownloadDirectoryPath. This field supports only strings and String variables.
• DocumentText - If set, the document text used by the document classification action is downloaded from storage and set in the variable passed in. This field supports only String variables.
• Taxonomy - If set, the taxonomy used by the document classification action is downloaded from storage and set in the variable passed in. This field supports only DocumentTaxonomy variables.
• ValidatedClassificationResults - If set, the human validated classification results from the document classification action are downloaded from storage and set in the variable passed in. This field supports only ClassificationResult[] variables.

Properties panel

Action Details

• ActionObject(Input) - Specifies the input action, which is actually the output of the Create Document Classification Action activity.

Action Output

• ActionObject(Output) - Provides the updated action object returned by Orchestrator once the action is completed. These are the available action objects: AssignedToUser, CreatorUser, DeleterUser, LastModifierUser, and CompletedByUser.

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 - The display name of the activity.
• StatusMessage - The status message is displayed against the workflows in suspended mode while waiting for the action completion. This field supports only strings and String variables.
• Timeout (milliseconds) - Specifies how long to wait (in milliseconds) for the activity to connect to Orchestrator before an error is thrown. This does not refer to the time spent in suspension by the workflow. The default value is 30000 milliseconds (30 seconds). This field supports only integer and Int32 variables.

Document Classification Data Output

• AutomaticClassificationResults - If set, the automatically generated classification results used by the document classification action are downloaded from storage and set in the variable passed in. This field supports only ClassificationResult[] variables.
• DocumentObjectModel - If set, the document object model used by the document classification action is downloaded from storage and set in the variable passed in. This field supports only Document variables.
• DocumentPath - If set, it returns the full local path of the downloaded document associated with the action in the specified DownloadDirectoryPath. This field supports only strings and String variables.
• DocumentText - If set, the document text used by the document classification action is downloaded from storage and set in the variable passed in. This field supports only String variables.
• Taxonomy - If set, the taxonomy used by the document classification action is downloaded from storage and set in the variable passed in. This field supports only DocumentTaxonomy variables.
• ValidatedClassificationResults - If set, the human validated classification results from the document classification action are downloaded from storage and set in the variable passed in. This field supports only ClassificationResult[] variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Storage Details

• DownloadDirectoryPath - Provides a path to a local directory used for downloading and storing the document associated with the action. If set, the document is downloaded to the specified directory path.
• RemoveDataFromStorage - If selected, removes all data associated with the current action from the storage bucket. Once all data is removed, no completed actions are available in Orchestrator.
  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, View and Delete options are selected.
  • For Storage Buckets permissions, View option is selected.
  • For Actions permissions, View option is selected.

Using the Wait for Document Classification Action and Resume

The Wait for Document Classification Action and Resume activity can be used with Studio Desktop, in Action Center, or with Orchestrator.