activities
latest
false
- Overview
- Document Processing Contracts
- Release notes
- About the Document Processing Contracts
- Box Class
- IPersistedActivity interface
- PrettyBoxConverter Class
- IClassifierActivity Interface
- IClassifierCapabilitiesProvider Interface
- ClassifierDocumentType Class
- ClassifierResult Class
- ClassifierCodeActivity Class
- ClassifierNativeActivity Class
- ClassifierAsyncCodeActivity Class
- ClassifierDocumentTypeCapability Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- ICapabilitiesProvider Interface
- IExtractorActivity Interface
- ExtractorPayload Class
- DocumentActionPriority Enum
- DocumentActionData Class
- DocumentActionStatus Enum
- DocumentActionType Enum
- DocumentClassificationActionData Class
- DocumentValidationActionData Class
- UserData Class
- Document Class
- DocumentSplittingResult Class
- DomExtensions Class
- Page Class
- PageSection Class
- Polygon Class
- PolygonConverter Class
- Metadata Class
- WordGroup Class
- Word Class
- ProcessingSource Enum
- ResultsTableCell Class
- ResultsTableValue Class
- ResultsTableColumnInfo Class
- ResultsTable Class
- Rotation Enum
- SectionType Enum
- WordGroupType Enum
- IDocumentTextProjection Interface
- ClassificationResult Class
- ExtractionResult Class
- ResultsDocument Class
- ResultsDocumentBounds Class
- ResultsDataPoint Class
- ResultsValue Class
- ResultsContentReference Class
- ResultsValueTokens Class
- ResultsDerivedField Class
- ResultsDataSource Enum
- ResultConstants Class
- SimpleFieldValue Class
- TableFieldValue Class
- DocumentGroup Class
- DocumentTaxonomy Class
- DocumentType Class
- Field Class
- FieldType Enum
- LanguageInfo Class
- MetadataEntry Class
- TextType Enum
- TypeField Class
- ITrackingActivity Interface
- ITrainableActivity Interface
- ITrainableClassifierActivity Interface
- ITrainableExtractorActivity Interface
- TrainableClassifierAsyncCodeActivity Class
- TrainableClassifierCodeActivity Class
- TrainableClassifierNativeActivity Class
- TrainableExtractorAsyncCodeActivity Class
- TrainableExtractorCodeActivity Class
- TrainableExtractorNativeActivity Class
- Document Understanding Digitizer
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Set PDF Password
- Merge PDFs
- Get PDF Page Count
- Extract PDF Text
- Extract PDF Images
- Extract PDF Page Range
- Extract Document Data
- Create Validation Task and Wait
- Wait for Validation Task and Resume
- Create Validation Task
- Classify Document
- Create Classification Validation Task
- Create Classification Validation Task and Wait
- Wait for Classification Validation Task and Resume
- Intelligent OCR
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Configuring Authentication
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- Wait For Document Classification Action And Resume
- Train Classifiers Scope
- Keyword Based Classifier Trainer
- Intelligent Keyword Classifier Trainer
- Data Extraction Scope
- Document Understanding Project Extractor
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Present Validation Station
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- ML Services
- OCR
- OCR Contracts
- Release notes
- About the OCR Contracts
- Project compatibility
- IOCRActivity Interface
- OCRAsyncCodeActivity Class
- OCRCodeActivity Class
- OCRNativeActivity Class
- Character Class
- OCRResult Class
- Word Class
- FontStyles Enum
- OCRRotation Enum
- OCRCapabilities Class
- OCRScrapeBase Class
- OCRScrapeFactory Class
- ScrapeControlBase Class
- ScrapeEngineUsages Enum
- ScrapeEngineBase
- ScrapeEngineFactory Class
- ScrapeEngineProvider Class
- OmniPage
- PDF
- [Unlisted] Abbyy
- [Unlisted] Abbyy Embedded
Document Understanding Activities
Last updated Nov 26, 2024
Wait For Document Classification Action And Resume
UiPath.IntelligentOCR.Activities.WaitForDocumentClassificationActionAndResume
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.
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,
ViewandDeleteoptions are selected. - For Storage Buckets permissions,
Viewoption is selected. - For Actions permissions,
Viewoption is selected.
- For Storage Files permissions,
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, andCompletedByUser.
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
Documentvariables. - 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
Stringvariables. - 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
Stringvariables. - 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
DocumentTaxonomyvariables. - 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, andCompletedByUser.
Common
- ContinueOnError - Specifies if the
automation should continue even when the activity throws an error. This field
only supports
Booleanvalues (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
Stringvariables. - 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
Int32variables.
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
Documentvariables. - 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
Stringvariables. - 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
Stringvariables. - 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
DocumentTaxonomyvariables. - 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,
ViewandDeleteoptions are selected. - For Storage Buckets permissions,
Viewoption is selected. - For Actions permissions,
Viewoption is selected.
- For Storage Files permissions,
