- 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
- ContentValidationData Class
- EvaluatedBusinessRulesForFieldValue Class
- EvaluatedBusinessRuleDetails Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- FieldValue Class
- FieldValueResult 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
- Rule Class
- RuleResult Class
- RuleSet Class
- RuleSetResult Class
- 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
- FieldValueDetails Class
- 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
- Create Validation Task and Wait
- Wait for Validation Task and Resume
- Create Validation Task
- 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
- Create Document Validation Artifacts
- Retrieve Document Validation Artifacts
- 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
- 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
PREVIEWConfiguring external connection
An external connection allows you to create and run activities using on-premise robots. To set an external connection, begin by adding an external application to your cloud organization that contains resources for your local project. Next, you need to enter the external application credentials, which vary based on your needs. If you are designing the activity, input the credentials directly into the activity. For runtime, save these credentials in the local Orchestrator linked to your executing robot. This equips the on-premises robot with the necessary access to use resources from the cloud organization, or from a different tenant.
- In your Automation
CloudTM
organization, add an external application and select Document
Understanding as one of its resources. Ensure that the necessary
User and Application scopes are included.
The necessary application scopes depend on the activities for which you want to use the external application. For example, if you want to use external application authentication with extraction activities, such as the Generative Extractor or Data Extraction Scope, we recommend that you assign application scopes related to extraction, such as the Du.Extraction.Api application scope.
Once you've added the external application to your organization, save the provided App ID and App Secret. These credentials are necessary for your local Studio workflow, as they allow it to consume resources from the cloud organization at design-time or runtime.
Figure 1. Generated credentials after adding an external application to your organization
- Enable Document UnderstandingTM in your chosen tenant.
- Allocate AI Units to the selected tenant.
- If you want to use this external
application at runtime, store the external application credentials, saved at
step 1, in the local Orchestrator, where the robot belongs to, as a Credential Asset. In the Credential
Asset, assign the external application credentials as follows:
- Username: The App ID of the external application;
- Password: The App Secret of the external application.
After you add the external application, and store its credentials in a dedicated Credential Asset, you can configure the external connection, as follows:
- For Design-time external connection:
- Input the external application credentials directly in the activity, in the App ID and App secret fields.
- In the Tenant URL field, enter the URL of the tenant that the
robot will connect to in order to configure the classification. The URL
should be in the following format:
https://<baseURL>/<OrganizationName>/<TenantName>.
- For Runtime external connection:
- Runtime Credentials Asset - Use this field to input the
Credential Asset where you stored the external application credentials
from your desired cloud organization, or 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 to.
- Manually enter
the path to the Orchestrator Credential Asset where you store
the external application credentials for accessing the
generative features.
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 activity. The URL should
be in the following format:
https://<baseURL>/<OrganizationName>/<TenantName>.
- Runtime Credentials Asset - Use this field to input the
Credential Asset where you stored the external application credentials
from your desired cloud organization, or tenant. You can choose to enter
a Credential Asset, for authentication purposes, in one of the following
ways:
