- 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
- Release notes
- About the Document Understanding ML activity package
- Project compatibility
- Configuring Authentication
- 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
Configuring Authentication
The Authentication properties in activities allows you to execute them using on-premises robots. First, add an external application to the cloud organization containing the resources for your local project. Then, save these external app credentials in the local Orchestrator associated with the robot performing the workflow. Lastly, in the activity's Authentication section, provide the local robot with access to the stored credentials and the URL of the cloud tenant. This equips the on-premises robot with the necessary access to use resources from the cloud organization, or from a different tenant.
To achieve this, perform the following steps:
- 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 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.
- 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 app, and store its credentials in a dedicated Credential Asset, you can populate the Authentication properties of an activity, as follows:
- Runtime Credentials Asset
- Use this field to input the Credential Asset where you stored the external app
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>.
