XML 構成ファイルまたはスクリプト内で (エクスポート設定の構成方法に応じて) 、エクスポートに使用するオプションを指定する必要があります。これには、UiPath Orchestrator への接続に使用する接続パラメーター、出力画像オプション、エクスポートファイルの命名方法、および field のマッピングが含まれます。
- UiPath Orchestrator の接続設定。
1.1. Server オプションで、Orchestrator が配置されているサーバーのアドレスを指定します。
- UiPath Enterprise Orchestrator を使用している場合は、次のように Server オプションに Orchestrator Web アプリケーションのアドレスを指定します。
connectorSettings.DmsConnectionSettings.Server = "https://orchestrator.mydomain.com";
- UiPath Cloud Platform Orchestrator を使用している場合は、次のサーバー アドレスを指定します。
connectorSettings.DmsConnectionSettings.Server = "https://platform.uipath.com";
- UiPath Enterprise Orchestrator を使用している場合は、Orchestrator tenant の名前を指定します。
- UiPath Cloud Platform を使用している場合は、アカウント内のservice名を次のように指定します。
connectorSettings.DmsConnectionSettings.Repository = "test_service";
1.3. Username オプションで:
- UiPath Enterprise Orchestrator を使用している場合は、Orchestrator ユーザーの名前またはメールアドレスを指定します。
- UiPath Cloud Platform を使用している場合は、ユーザーのメールアドレスと認証タイプを追加のエクスポートオプションで指定します。
1.4. Password オプションで、Orchestrator ユーザーのパスワードを指定します。
Orchestrator のユーザーには、次のロールを割り当てる必要があります: view queues、create transactions、view units。
- FileName field で、エクスポートファイル名の生成に使用するテンプレートを指定します。
動的に置き換え可能なサポート対象タグの一覧:
-
<Project> – ABBYY FlexiCapture プロジェクトの名前;
-
<Batch> – バッチ名;
-
<DocumentDefinition> – ABBYY FlexiCapture の Document Definition の名前;
-
<Identifier> – ドキュメント識別子;
-
<BatchType> – バッチタイプ名;
-
<Time> – yyyy-MM-dd_HH-mm-ss 形式の現在時刻;
-
<Index:> – Index field の値。
また、<FileNameWithoutExtension> タグを使用してソースファイル名を使用することもできます (画像が UiPath Activity から受信された場合、バッチ には元の画像ファイル名を含むこの Registration Parameter が含まれます) 。
- DmsMetadataTemplate.Name field で、たとえば Orchestrator のキュー名を指定します:
connectorSettings.MappedFields.DmsMetadataTemplate.Name = "Verification queue"
- ExportImageSavingOptions - 出力画像で使用できるオプション (例: 画像形式のオプションや、機密情報を含む field を墨消しする機能) については、ABBYY FlexiCapture Help に記載されています (IExportImageSavingOptions インターフェイスの説明を参照してください) 。
- 認識されたメタデータをエクスポートするために、fields をマッピングします。エクスポートする値を持つ各 Document Definition field について、トランザクション内でその名前を指定する必要があります。
マッピングされた Document Definition の fields だけがトランザクションにエクスポートされます。マッピングできる fields 数に制限はありません。
{ @"Invoice Layout\InvoiceNumber", "InvoiceNumber" }
<FieldPair>
<AfcField>Invoice Layout\InvoiceNumber</AfcField>
<DmsField>InvoiceNumber</DmsField>
</FieldPair>
- DmsSpecificOptions プロパティを使用して、追加の UiPath エクスポート設定を指定することもできます。
6.1. AuthenticationType では、UiPath Orchestrator へのログイン時に使用する認証タイプを選択できます。指定できる値は Basic と OAuth2 の 2 つのみです。
UiPath Cloud Platform Orchestrator へのエクスポートを設定する場合、このオプションの使用は必須です。この場合は OAuth2 を指定してください。
connectorSettings.DmsSpecificOptions = new Option[] {
new Option(new KeyValuePair<string, object>("AuthenticationType", "OAuth2"))
};
connectorSettings.DmsSpecificOptions = new Option[] {
new Option(new KeyValuePair<string, object>("Reference", Document.Batch.Id.ToString()))
};
connectorSettings.DmsSpecificOptions = new Option[] {
new Option(new KeyValuePair<string, object>("OrganizationUnitName", "ORG_UNIT_NAME"))
};
以下のコード例は、このオプションの使用方法を示しています。
connectorSettings.DmsSpecificOptions = new Option[] {
new Option(new KeyValuePair<string, object>("AccountLogicalName", "testaccount123"))
};
connectorSettings.DmsSpecificOptions = new Option[] {
new Option(new KeyValuePair<string, object>("AuthenticationType", "OAuth2")),
new Option(new KeyValuePair<string, object>("AccountLogicalName", "ACCOUNT_LOGICAL_NAME")),
new Option(new KeyValuePair<string, object>("Reference", Document.Batch.Id.ToString()))
};
- SaveDocumentImages オプションは、画像ファイルを UiPath Orchestrator のトランザクションに保存するかどうかを指定します。画像を保存する場合は、このオプションを true に設定します。画像を保存しない場合は、このオプションを false に設定します。
以下のコード例は、このオプションの使用方法を示しています。
connectorSettings.SaveDocumentImages = true;
エクスポート オプションの設定例は、[Connector installation path]\Single-task package\Samples\FlexiCapture Scripts フォルダーにあります。default.config.xml および UiPath - ExportScript - Configure by script (Attended service).cs. という名前のファイルを探してください。
