activities
latest
false
Document Understanding Activities
Last updated Oct 8, 2024

PREVIEW
Document Understanding Project Extractor

UiPath.IntelligentOCR.Activities.DocumentClassification.DuAppExtractor

Description

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.

Project compatibility

Windows - Legacy | Windows

Configuration

Designer panel
  • Project (Mandatory) - 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 that your Studio is connected to.
    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 (Mandatory) - Select the deployed version of the desired project.

    This field is disabled if you select the Predefined project type.

Properties panel

Common

  • DisplayName - The display name of the activity.

Authentication (Preview)

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 in the Configuring Authentication page . Once these steps are completed, you can then 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 to.
    • 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 that your Studio is connected to.
  • 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.

Configuring Document Understanding Project Extractor

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.
  1. Select Get or refresh extractor capabilities.
  2. 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 in 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 want to use. The format of the URL should be: https://<baseURL>/<OrganizationName>/<TenantName>.
  3. Select Get Projects to populate the Project dropdown list with projects from the organization and tenant where you created the external application.
  4. For Project, select your desired modern project from the dropdown list.
  5. For Version, choose a version for the selected project.
  6. 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

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.