Activities
latest
false
- Overview
- Document Processing Contracts
- 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 Process - Studio Template
- Document Understanding Activities
- About the Document Understanding 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
- About the IntelligentOCR Activities Package
- Project Compatibility
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Intelligent Keyword Classifier
- Present Classification Station
- 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
- 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
Create Document Validation Action
Document Understanding Activities
Last updated Apr 10, 2024
Create Document Validation Action
UiPath.IntelligentOCR.Activities.CreateDocumentValidationAction
Creates an action of type
Document Validation
in Orchestrator Action Center. The output of the Create Document Validation Action activity can be used with the Wait for Document Validation 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. Here you can find more information about how to connect robots to Orchestrator.
Action Details
- ActionCatalog - Specifies the name of the action catalog from UiPath 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. Mandatory.
- ActionFolderPath - Specifies which Orchestrator folder the action should be created in, if different from the folder 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 UiPath Action Center and/or UiPath Orchestrator. Mandatory.
Action Output
- ActionObject(Output) - Provides the action object returned by Orchestrator. This action object should be passed in as an input to the Wait for Document Validation 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 sec). This field supports only integer and
Int32
variables.
Document Validation Data Input
- AutomaticExtractionResults - The automatically generated extraction results, stored in an
ExtractionResult
proprietary variable. If a variable is added to this field, the results of the automatic extraction results are displayed, enabling you to review and modify them. If left empty, the Validation Station opens for the user to validate the data manually. This field supports onlyExtractionResult
variables. Mandatory. - DocumentObjectModel - The Document Object
Model 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. Please see the documentation of the activity for more information on how to do this. This field supports onlyDocument
variables. Mandatory. - DocumentPath - The path to the document you want to validate. This field supports only strings and
String
variables. Mandatory. - DocumentText - The text of the document
itself, stored in a
String
variable. This value can be retrieved from the Digitize Document activity. Please see the documentation of the activity for more information on how to do this. This field supports only strings andString
variables. Mandatory. - 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 deserializing a string into aDocumentTaxonomy
object. This field supports onlyDocumentTaxonomy
variables. Mandatory.
Misc
- FieldsValidationConfidence % (Preview) - Set the upper limit confidence score to be used when rendering the Validation Station.
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
- ShowOnlyRelevantPageRange - If selected, only the page range mentioned in the extraction results is shown and the pages that are outside the range are hidden.
Storage Details
- BucketDirectoryPath - Required. 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
/
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. The bucket should
exist in the same Orchestrator folder as the one the action will be created
in.
Note:
Make sure that you have enabled all needed permissions for Orchestrator. Go to Folder Permissions for the Robot role in Orchestrator and verify that:
- For Storage
Files permissions,
Create
andEdit
options are selected. - For Storage
Buckets permissions,
View
option is selected. - For Actions
permissions,
Create
option is selected.
- For Storage
Files permissions,