Skip to main content
エクスポート設定の構成方法に応じて、XML 構成ファイルまたはスクリプト内で、エクスポートに使用するオプションを指定します。 これらのオプションには、UiPath Orchestrator への接続パラメーター、出力画像オプション、エクスポートファイルの命名方法、および field のマッピングが含まれます。

UiPath Orchestrator の接続設定

UiPath Cloud Platform では、UiPath Community Orchestrator の古いアカウントを使用する場合、まずパスワードをリセットして新しい認証方式へ移行する必要があります。詳細については、Consuming APIs with the new cloud Orchestrator を参照してください。

サーバーアドレスの例

UiPath Enterprise Orchestrator の場合は、Orchestrator Web アプリケーションのアドレスを指定します。
UiPath Cloud Platform Orchestrator の場合は、次のサーバー アドレスを指定します。

リポジトリの例

UiPath Cloud Platform の場合は、サービス名を指定します。
利用可能なサービスの名前を確認するには、UiPath Cloud Platform アカウントを開き、Services タブに移動します。
UiPath Cloud Platform アカウントの Services タブのスクリーンショット。Repository オプションの値として使用する名前を持つ、利用可能なサービスが一覧表示されています。

必須の Orchestrator ユーザーロール

Orchestrator でユーザーに次のロールを割り当てます。view queuescreate transactionsview units
UiPath Orchestrator のロール編集ページのスクリーンショット。Queues に View 権限、Transactions に Create 権限、Units に View 権限が選択されている状態を示しています。

エクスポートファイル名

FileName フィールドで、エクスポートファイルの名前を生成するために使用するテンプレートを指定します。 <FileNameWithoutExtension> タグは、画像を UiPath の Activity から受け取った場合に機能します。この場合、バッチが元の画像ファイル名を格納した registration parameter を保持しているためです。

Orchestrator queue 名

DmsMetadataTemplate.Name field に Orchestrator queue 名を指定します。
エクスポートスクリプトの実行後、データを含む新しいトランザクションがこのキューに作成されます。キューはOrchestratorで作成してください。
UiPath Orchestratorのキュー作成ダイアログのスクリーンショット。ここで入力するキュー名は、エクスポート設定のDmsMetadataTemplate.Nameの値と一致する必要があります。

出力画像オプション

ExportImageSavingOptions オプションは、画像形式のオプションや、機密情報を含む field を墨消しする機能など、出力画像で使用できる設定を対象とします。 詳細については、IExportImageSavingOptions を参照してください。

field マッピング

field を map して、認識されたメタデータをエクスポートします。値をエクスポートする Document Definition field ごとに、トランザクション内での名前を指定します。 map された Document Definition field のみがトランザクションにエクスポートされます。map できる field の数に制限はありません。 script を使用して エクスポートオプション を構成する場合、field の組み合わせは次の形式にする必要があります。
XML を使用して エクスポートオプション を設定する場合、field の組み合わせは次の形式で指定する必要があります。
どちらの形式でも、1 つ目の値は ABBYY FlexiCapture Document Definition 内の field へのフルパス、2 つ目の値は UiPath Orchestrator トランザクション内の field 名です。トランザクション内の field 名には任意の名前を指定できます。指定した名前の fields は、実行時にトランザクション内に作成されます。

追加の UiPath エクスポートオプション

追加の UiPath エクスポート設定は、DmsSpecificOptions プロパティを使用して指定します。以下の各コード サンプルでは、1 番目の属性がオプション名で、2 番目の属性がオプション値です。

AuthenticationType

AuthenticationType では、UiPath Orchestrator へのログイン時に使用する認証タイプを設定します。指定できる値は BasicOAuth2 の 2 つのみです。 UiPath Cloud Platform Orchestrator の場合、このオプションは必須であり、その値は OAuth2 でなければなりません。UiPath Enterprise Orchestrator の場合、このオプションは必須ではなく、その値は Basic です。

Reference

Reference では、トランザクションの作成時に使用する Reference を指定します。参照としてバッチ識別子を使用するには、値として Document.Batch.Id.ToString() を指定します。

OrganizationUnitName

OrganizationUnitName は、処理結果を指定した Orchestrator の Organization Unit にエクスポートします。このオプションは UiPath Enterprise Orchestrator でのみ使用でき、Orchestrator で Organization Unit 機能を有効にする必要があります。 オプション値として Organization Unit の名前を指定します。

AccountLogicalName

AccountLogicalName では、処理結果のエクスポート先となる UiPath Cloud Platform アカウントを指定します。ユーザーが複数の UiPath Cloud Platform アカウントを利用できる場合に使用してください。このオプションは UiPath Cloud Platform Orchestrator でのみ使用できます。 アカウントの論理名とは、Orchestrator の Account Settings に表示される Orchestrator site URL のうち、編集可能な部分です。アカウントにログインした後、ブラウザーのアドレスバーでも確認できます。
Screenshot of the Account Settings page in UiPath Orchestrator, showing the Orchestrator site URL whose editable part is the account logical name.

1 つのスクリプトで複数のオプションを使用する

1 つのエクスポート スクリプトで複数のオプションを使用するには、それらを Option 配列の要素として、カンマ区切りで指定します。

文書画像の保存

SaveDocumentImages オプションは、画像ファイルを UiPath Orchestrator のトランザクションに保存するかどうかを指定します。画像を保存する場合は true に設定し、保存しない場合は false に設定します。

リファレンス ファイル

エクスポート オプションの設定例は、Connector のインストール先にある \Single-task package\Samples\FlexiCapture Scripts フォルダーにあります。default.config.xml および UiPath - ExportScript - Configure by script (Attended service).cs という名前のファイルを探してください。