activities
latest
false
UiPath logo, featuring letters U and I in white
Document Understanding Activities
Last updated Nov 21, 2024

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:

1. Add the external application

  1. 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

  2. Enable Document UnderstandingTM in your chosen tenant.
  3. Allocate AI Units to the selected tenant.
  4. 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.

2. Provide the credentials in the activity

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>.
  • 1. Add the external application
  • 2. Provide the credentials in the activity

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.