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
Document Understanding Project Extractor
UiPath.IntelligentOCR.Activities.DocumentClassification.DuAppExtractor
Extracts data from documents using a certain modern project and version. Visit Document Understanding for Modern Experience key concepts to learn more about modern projects and document types.
You can use this activity only with the Data Extraction Scope activity.
Designer panel
- Project - Select the
desired modern project from the dropdown menu. The available options are:
- Predefined: A default option that exposes the public UiPath® extraction model. You can select this, if you want to use the out-of-the-box extraction capabilities of UiPath®.
- Modern projects available in the organization and tenant to which your Studio is connected.
Note: If you have created more than 500 projects on your tenant and use the Document Understanding Project Extractor activity, UiPath Studio or Studio Web will not display any projects beyond the initial 500. Therefore, those projects cannot be used. - Version - Select the
deployed version of the desired project. If you select a version, you cannot
select a tag.
This field is disabled if you select the Predefined project type.
- Tag (Preview) - Select a
tag that links directly to a specific version of your chosen project. For
example, if you select the Staging tag, the activity uses the project
version assigned to this tag during the document extraction process. If you
select a tag, you cannot select a version.
This field is disabled if you select the Predefined project type.
Properties panel
Common
- DisplayName - The display name of the activity.
Authentication
The Authentication properties of this activity allow you to execute it via on-premises robots. Before configuring these properties, ensure you have fulfilled the prerequisites mentioned on the Configuring Authentication page . Once these steps are completed, you can proceed to fill in the Authentication properties of the activity.
- Runtime Credentials Asset - Use this field when you need to access
Document Understanding modern project resources while the robot is connected to
a local Orchestrator, or from a different tenant. You can choose to enter a
Credential Asset, for authentication purposes, in one of the following ways:
- From the dropdown list, select the desired Credential Asset from the Orchestrator to which the UiPath® Robot is connected.
- Manually enter the path to the Orchestrator Credential Asset where you
store the external application credentials for accessing the
project.
The format of the path should be:
<OrchestratorFolderName>/<AssetName>.
- Runtime Tenant Url - Use this field, alongside the Runtime Credentials
Asset field. Enter the URL of the tenant that the robot will connect to
in order to execute the extraction. The URL should be in the following format:
https://<baseURL>/<OrganizationName>/<TenantName>.
Input
- Project - Select the desired modern project from the dropdown menu. The
available options are:
- Predefined: A default option that exposes the public UiPath® extraction model. You can select this, if you want to use the out-of-the-box extraction capabilities of UiPath®.
- Modern projects available in the organization and tenant to which your Studio is connected.
- Tag (Preview) - Select a tag that links directly to a specific version of
your chosen project. For example, if you select the Staging tag, the
activity uses the project version assigned to this tag during the document
extraction process. If you select a tag, you cannot select a version.
This field is disabled if you select the Predefined project type.
- Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
- Version - Select the
deployed version of the desired project.
This field is disabled if you select the Predefined project type.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Note: You can use variables in the Project and
Version fields.
To map your taxonomy fields to a specific extractor, perform the following steps in
the Configure Extractors Wizard:
Note: If you wish to
use the same project resources at runtime, ensure the Authentication
properties of the activity match those in the Get Capabilities
wizard.
- Select Get or refresh extractor capabilities.
- Configure the Design time
credentials that allow you to map the taxonomy fields of a modern
project from a specific tenant or organization:
Before configuring these properties, ensure you have fulfilled the prerequisites mentioned on the Configuring Authentication page. Once these steps are completed, input your external application credentials into the wizard.
- App Id: Enter the App ID you generated from the external application in the organization you're trying to access.
- App Secret: Enter the App Secret generated from the same external application.
- Tenant Url:
Provide the URL of the specific tenant whose resources you wish to
use. The format of the URL should be:
https://<baseURL>/<OrganizationName>/<TenantName>.
- Select Get Projects to populate the Project dropdown list with projects from the organization and tenant where you created the external application.
- For Project, select your desired modern project from the dropdown list.
- For Version, choose a version for the selected project.
- Select Get
Capabilities.
Note: If you use variables for the Project and Version fields, then the Get Capabilities wizard will also request you to select an existing project and version that the robot can access, for configuration purposes.
Figure 1. Overview of the Get Capabilities wizard
