異なる環境のモデルを使用する

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

この手順では、外部アプリケーションを使用して、さまざまな環境にデプロイされたモデルにアクセスする方法について包括的な概要を示します。外部アプリケーションのアクセス権の設定、これらのモデルを使用するための Studio ワークフローの設定、および運用環境のワークフローの設定に関するステップ バイ ステップの手順を記載しています。

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. 外部アプリケーションを設定する
2. UiPath Studio のワークフローを設定する
3. モデルのバージョンをパラメーターとして設定する
4. Document Understanding Process テンプレート

外部アプリケーションを設定する

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

   ヒント:

   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. 外部アプリケーションのアクセス スコープを定義します。

   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.

      非機密アプリケーションは、アプリケーションのスコープにアクセスできません。

5. [保存] を選択します。

   注:

   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. [追加] を選択して登録を作成します。

   確認メッセージが表示されます。機密アプリケーションの場合、このメッセージにはアプリ シークレットが含まれます。登録済み外部アプリケーションは、このシークレットを使用して認可を要求できます。アプリ シークレットは再度確認することはできないため、必ず安全な場所に保存しておいてください。

   

UiPath Studio のワークフローを設定する

開始する前に、次の前提条件が満たされていることを確認します。

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

ヒント:

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. タクソノミーを定義します。

   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. 設計時の資格情報を設定します。

   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. 以下の情報を入力します。

      • 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. ウィザードを閉じます。

      

5. タクソノミーをマッピングします。

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

   2. 各ドキュメントの種類に対して、プロジェクトのタクソノミーからモデルのタクソノミーへのマッピングを作成します。

      この手順を実行するには、タクソノミーからドキュメントの種類を選択し、このドキュメントの種類の各フィールドを、Document Understanding プロジェクト用に設計されたモデルの対応するフィールドに合わせます。

      

6. 実行時の資格情報を Orchestrator アセットとして保存します。

   1. Automation Cloud のテナントに移動します。

   2. Orchestrator に移動します。

   3. オートメーション フォルダーを選択します。

   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. Studio で実行時の資格情報を設定します。

   1. Studio プロジェクトに移動します。

   2. [データ抽出スコープ] アクティビティに移動します。

   3. Configure the Runtime Credentials Asset property.

      このフィールドは、ロボットがローカルの Orchestrator に接続されているとき、または別のテナントから接続されているときに、Document Understanding モダン プロジェクトのリソースにアクセスする場合に使用します。認証のための資格情報アセットは、次のいずれかの方法で入力できます。

      • ロボットが接続されている Orchestrator のドロップダウン リストから、目的の資格情報アセットを選択します。
      • プロジェクトにアクセスするための外部アプリケーションの資格情報を保存する Orchestrator 資格情報アセットへのパスを入力します。パスは <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>.

外部アプリケーションは、テナント内のすべての Document Understanding プロジェクトにアクセスできます。プロジェクトごとに個別にアクセス権を設定する必要はありません。

モデルのバージョンをパラメーターとして設定する

プロジェクトのバージョンをパラメーターとして設定すると、ワークフローのコードを調整することなく、オートメーションのワークフローを新しいバージョンのプロジェクトに合わせて更新できます。

1. Automation Cloud のテナントに移動します。

2. Orchestrator に移動します。

3. オートメーション フォルダーを選択します。

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. [作成] を選択します。

   これにより、ワークフローのコードを変更することなく、オートメーションのワークフローを新しいバージョンのプロジェクトに合わせて更新できます。オートメーションを指定したフォルダーにデプロイすると、Orchestrator のアセットに従ってモデルのバージョンが設定されます。このプロセスは、外部アプリケーションの資格情報をアセットとして保存する場合と同様です。

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

    

Document Understanding Process テンプレート

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.

このプロセスでは、ログ、例外処理、リトライのメカニズムのほか、Document Understanding ワークフローですぐに使えるあらゆるメソッドを提供します。

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