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 Dec 5, 2024
Create Document Classification Action
UiPath.IntelligentOCR.Activities.CreateDocumentClassificationAction
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.
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,
CreateandEditoptions are selected. - For Storage Buckets permissions,
Viewoption is selected. - For Actions permissions,
Createoption is selected.
- For Storage Files permissions,
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 onlyClassificationResult[]variables. - DocumentObjectModel - The Document Object Model (DOM) you want to use to
validate the document against. This model is stored in a
Documentvariable and can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports onlyDocumentvariables. - DocumentPath - The path to the document you want to validate. This field
supports only strings and
Stringvariables. - DocumentText - The text of the document itself, stored in a
Stringvariable. 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 andStringvariables. - Taxonomy - The Taxonomy against which the document is to be processed,
stored in a
DocumentTaxonomyvariable. This object can be obtained by using a Load Taxonomy activity or by de-serializing a string into aDocumentTaxonomyobject. This field supports onlyDocumentTaxonomyvariables.
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
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 - 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
Int32variables.
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 onlyClassificationResult[]variables. - DocumentObjectModel - The Document Object
Model (DOM) you want to use to validate the document against. This model is
stored in a
Documentvariable and can be retrieved from the Digitize Document activity. Visit Digitize Document for more information on how to achieve this. This field supports onlyDocumentvariables. - DocumentPath - The path to the document
you want to validate. This field supports only strings and
Stringvariables. - DocumentText - The text of the document
itself, stored in a
Stringvariable. 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 andStringvariables. - Taxonomy - The Taxonomy against which the
document is to be processed, stored in a
DocumentTaxonomyvariable. This object can be obtained by using a Load Taxonomy activity or by de-serializing a string into aDocumentTaxonomyobject. This field supports onlyDocumentTaxonomyvariables.
Misc
- 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,
CreateandEditoptions are selected. - For Storage
Buckets permissions,
Viewoption is selected. - For Actions
permissions,
Createoption is selected.
- For Storage
Files permissions,
