Uso de modelos de diferentes ambientes

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

Esse procedimento oferece uma visão geral abrangente sobre como acessar modelos implantados em diferentes ambientes usando aplicativos externos. Inclui instruções passo a passo sobre como configurar um aplicativo externo para direitos de acesso, configurar o fluxo de trabalho do Studio para consumir esses modelos e estabelecer fluxos de trabalho de produção.

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 um aplicativo externo
2. Configurar o fluxo de trabalho do UiPath Studio
3. Configurar versões do modelo como parâmetros
4. Modelo de processo do Document Understanding

Configurar um aplicativo externo

1. Navegue até seu tenant do 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.

   Dica:

   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. Defina os escopos de acesso para seu aplicativo externo.

   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.

      Os aplicativos não confidenciais não podem acessar o escopo do aplicativo.

   

   5. Selecione Salvar.
      Observação:

      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.

8. Selecione Adicionar para criar o registro.

   Uma mensagem de confirmação é exibida. Para aplicativos confidenciais, essa mensagem inclui o segrodo do aplicativo. O aplicativo externo registrado pode usar esse segredo para solicitar autorização. Certifique-se de salvar o segredo do aplicativo em um local seguro, pois você não poderá vê-lo novamente.

   

Configurar o fluxo de trabalho do UiPath Studio

Antes de começar, certifique-se de que os seguintes pré-requisitos estejam cumpridos:

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

Dica:

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. Defina a taxonomia.

   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 credenciais de tempo de design.

   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. Preencha as seguintes informações:

      • 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. Encerrar o assistente.

      

5. Mapear a taxonomia.

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

   2. Crie um mapeamento da taxonomia do projeto para a taxonomia do modelo para cada tipo de documento.

      Para executar essa etapa, escolha um Tipo de documento na taxonomia e alinhe cada campo desse Tipo de documento com um campo correspondente no modelo projetado para o Projeto de Document Understanding.

      

6. Salve a credencial de tempo de execução como um ativo do Orchestrator.

   1. Navegue até seu tenant do Automation Cloud.

   2. Acesse o Orchestrator.

   3. Escolha sua pasta de automação.

   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 credenciais de tempo de execução no Studio.

   1. Navegue até seu projeto do Studio.

   2. Acesse a atividade Data Extraction Scope.

   3. Configure the Runtime Credentials Asset property.

      Use esse campo para acessar recursos de projeto modernos do Document Understanding enquanto o robô está conectado a um Orchestrator local ou de um tenant diferente. Você pode optar por inserir um Ativo de Credencial, para fins de autenticação, de uma das seguintes maneiras:

      • Selecione o ativo de credencial desejado do Orchestrator ao qual o robô está conectado na lista suspensa.
      • Insira o caminho para o Ativo de Credenciais do Orchestrator onde você armazena as credenciais de aplicativos externos para acessar o projeto. O formato do caminho deve ser o seguinte: <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>.

O aplicativo externo fornece acesso a todos os projetos do Document Understanding dentro do tenant. Você não precisa configurar o acesso para cada projeto individualmente.

Configurar versões do modelo como parâmetros

Se você configurar versões do projeto como parâmetros, você pode atualizar fluxos de trabalho de automação para novas versões do projeto sem ajustar o código do fluxo de trabalho.

1. Navegue até seu tenant do Automation Cloud.

2. Acesse o Orchestrator.

3. Escolha sua pasta de automação.

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. Selecione Criar.

   Isso permite que você atualize fluxos de trabalho de automação para novas versões do projeto sem alterar o código do fluxo de trabalho. Quando a automação é implantada em uma pasta especificada, a versão do modelo é definida de acordo com o ativo no Orchestrator. Esse processo é semelhante a salvar credenciais de aplicativos externos como ativos.

10. Navegue até seu projeto do 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.

    

Modelo de processo do 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.

O processo fornece log, tratamento de exceção, mecanismos de repetição e todos os métodos que devem ser usados em um fluxo de trabalho do Document Understanding, pronto para uso.

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