Consumir modelos de diferentes entornos

When using Document Understanding^TM modern projects, you need to configure an external application to access models across various tenants and organizations.

Este procedimiento ofrece una descripción general sobre cómo acceder a los modelos implementados en diferentes entornos utilizando aplicaciones externas. Incluye instrucciones paso a paso sobre cómo configurar una aplicación externa para los derechos de acceso, configurar el flujo de trabajo de Studio para utilizar estos modelos y establecer flujos de trabajo de producción.

This functionality also allows you to use models in hybrid deployment environments. In this case, Document Understanding projects are configured on Automation Cloud^TM, while Orchestrator and Robots are deployed on-premises.

1. Configurar una aplicación externa
2. Configurar el flujo de trabajo de UiPath Studio
3. Configurar versiones de modelo como parámetros
4. Plantilla de proceso de Document Understanding

Configurar una aplicación externa

1. Navega a tu tenant de Automation Cloud.

2. Go to the Administration page and select your organization.

3. Go to the External applications page.

   

4. Select Add Application from the External applications page.

   Consejo:

   For more information on adding an external application, check the Managing external OAuth applications page from the Automation Cloud admin guide.

5. Type in a unique name for the application in the Application Name field.

6. Select an application type from the Application type section:

   • Confidential application: suitable for storing the App Secret securely. Use this for high-security requirements.

   • Non-Confidential application: use this option only when secure storage for the App Secret is not required.

     

7. Define los ámbitos de acceso para tu aplicación externa.

   1. Select Add Scopes from the Resources section.

   2. Select Document Understanding from the Resource drop-down list.

   3. Configure User scope(s) to grant permissions within a user context.

      Select the checkboxes corresponding to the logical API permissions you want to grant as per your requirement in the User scope(s) tab. If you grant permissions under user scope, it is implied that the external application can access those resources within a user context. Therefore, a user with the corresponding permissions must be logged in.

   4. Configure Application scope(s) to provide application-level access for broader automation needs.

      If you are using a confidential application, navigate to the Application scope(s) tab to allocate application-level permissions for the chosen resource as required. By delegating permissions under the application scope, the external application can access data across the selected scopes without any user interaction.

      Las aplicaciones no confidenciales no pueden acceder al ámbito de la aplicación.

5. Selecciona Guardar.

   Nota:

   If you have registered the external application with user scopes, add a Redirect URL. This URL will receive the authorization response. However, if you selected only application scopes, providing a redirect URL is optional.

6. Selecciona Añadir para crear el registro.

   Se muestra un mensaje de confirmación. Para las aplicaciones confidenciales, este mensaje incluye el secreto de la aplicación. La aplicación externa registrada puede utilizar este secreto para solicitar autorización. Asegúrate de guardar el secreto de la aplicación en una ubicación segura, ya que no podrás volver a verlo.

   

Configurar el flujo de trabajo de UiPath Studio

Antes de comenzar, asegúrate de que se cumplan los siguientes requisitos previos:

• Use a compatible Windows Project version.
• Make sure that the IntelligentOCR activity package is installed. The IntelligentOCR.Activities package supports the consumption of Document Understanding modern projects starting with v6.22.1.

Consejo:

For a more detailed understanding of the differences between the DocumentUnderstanding.Activities and IntelligentOCR.Activities packages, as well as guidance on when to use each of them, check the Automations in Document Understanding page.

1. Open your UiPath Studio project.

2. Definir la taxonomía.

   1. Open Taxonomy Manager to define relevant document types and fields for your automation.

      Your project taxonomy should encompass each document type and the necessary fields. The taxonomy you create in Studio can contain additional document types and fields that are not part of the Document Understanding modern projects. If you wish to use additional extractors like the Form Extractor or the Regex Extractor for various document types, this step will be necessary.

      

3. Install the IntelligentOCR.Activities package to use activities such as Document Understanding Project Extractor and Document Understanding Project Classifier.

   1. Add the Data Extraction Scope activity to configure extraction models and include the Document Understanding Project Extractor activity.

      

   2. Add the Classify Document Scope activity to configure classification models and include the Document Understanding Project Classifier activity.

4. Configurar credenciales de tiempo de diseño.

   1. Open the Get Capabilities wizard from the activity scope.

      The wizard is displayed when you include the Document Understanding Project activities within that scope. This wizard allows you to configure design-time credentials needed to map the taxonomy fields of a modern project.

   2. Rellena la siguiente información:

      • App ID and App Secret from the external application.
      • Tenant URL for the target environment.

   3. Select Get Projects and choose the needed project and version.

   4. Cierra el asistente.

      

5. Mapea la taxonomía.

   1. Select Configure Extractors within the Data Extraction Scope activity.

   2. Crea una asignación de la taxonomía del proyecto a la taxonomía del modelo para cada tipo de documento.

      Para ejecutar este paso, elige un tipo de documento de la taxonomía y alinea cada campo de este tipo de documento con un campo correspondiente en el modelo diseñado para el proyecto de Document Understanding.

      

6. Guarda la credencial de tiempo de ejecución como un activo de Orchestrator.

   1. Navega a tu tenant de Automation Cloud.

   2. Ve a Orchestrator.

   3. Elige tu carpeta de automatización.

   4. Go to the Assets tab.

   5. Select Add asset and choose Create a new asset from the drop-down list.

   6. Type in a name in the Asset name field.

   7. Select Credential from the Type drop-down list.

   8. Use the previously created App ID and App Secret as the Username and Password.

      

7. Configurar credenciales de runtime en Studio.

   1. Navega a tu proyecto de Studio.

   2. Ve a la actividad Ámbito de extracción de datos.

   3. Configure the Runtime Credentials Asset property.

      Utiliza este campo para acceder a los recursos del proyecto moderno de Document Understanding mientras el robot está conectado a un Orchestrator local o desde un tenant diferente. Puedes elegir introducir un activo de credenciales, con fines de autenticación, de una de las siguientes maneras:

      • Selecciona el activo de credenciales deseado del Orchestrator al que está conectado el robot en la lista desplegable.
      • Introduce la ruta al activo de credenciales de Orchestrator donde almacenas las credenciales de la aplicación externa para acceder al proyecto. El formato de la ruta debe ser el siguiente: <OrchestratorFolderName>/<AssetName>.

   4. Configure the Runtime Tenant Url property.

      Use this field together with the Runtime Credentials Asset property. Enter the URL of the tenant to which the robot will connect to execute the extraction. The URL must have the following format: https://<baseURL>/<OrganizationName>/<TenantName>.

La aplicación externa proporciona acceso a todos los proyectos de Document Understanding dentro del tenant. No necesitas configurar el acceso para cada proyecto individualmente.

Configurar versiones de modelo como parámetros

Si configuras las versiones del proyecto como parámetros, puedes actualizar los flujos de trabajo de automatización para las nuevas versiones del proyecto sin ajustar el código del flujo de trabajo.

1. Navega a tu tenant de Automation Cloud.

2. Ve a Orchestrator.

3. Elige tu carpeta de automatización.

4. Go to the Assets tab.

5. Select Add asset and choose Create a new asset from the drop-down list.

6. Type in a name in the Asset name field.

7. Select Text from the Type drop-down list.

8. Type in a name in the Text field to define a version-specific asset.

   

9. Selecciona Crear.

   Esto te permite actualizar los flujos de trabajo de automatización para las nuevas versiones del proyecto sin cambiar el código del flujo de trabajo. Cuando la automatización se implementa en una carpeta especificada, la versión del modelo se establece de acuerdo con el activo en Orchestrator. Este proceso es similar a guardar las credenciales de la aplicación externa como activos.

10. Navega a tu proyecto de Studio.

11. Add a Get Asset activity in your workflow to retrieve the version asset.

12. Pass the retrieved value as an input variable to the Document Understanding Project activities.

    

Plantilla de proceso de Document Understanding

Document Understanding Process is a fully functional UiPath® Studio project template based on a document processing flowchart. You can use it to get started with working on either a demo, or a large-scale implementation of Document Understanding^TM.

El proceso proporciona registro, manejo de excepciones, mecanismos de reintento, y todos los métodos que deben utilizarse en un flujo de trabajo de Document Understanding de manera inmediata.

For more information, check the Document Understanding Process template page.