> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# エクスポートオプションの指定

> XML 構成またはエクスポートスクリプトで、UiPath Orchestrator の接続パラメーター、ファイルの命名、キュー名、画像オプション、および field マッピングを設定します。

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

1. <a id="connestion-settings" />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";
```

1.2. **Repository** オプションで:

* UiPath Enterprise Orchestrator を使用している場合は、Orchestrator tenant の名前を指定します。
  * UiPath Cloud Platform を使用している場合は、アカウント内のservice名を次のように指定します。

```
connectorSettings.DmsConnectionSettings.Repository = "test_service";
```

利用可能なサービス名は、UiPath Cloud Platform アカウントを開き、**Services** タブに移動すると確認できます。

<img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_58.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=5032df632d638d4152fcad76364af6b6" alt="" width="650" height="386" data-path="images/flexi-capture/connectors/UiCon_58.png" />

1.3. **Username** オプションで:

* UiPath Enterprise Orchestrator を使用している場合は、Orchestrator ユーザーの名前またはメールアドレスを指定します。
  * UiPath Cloud Platform を使用している場合は、ユーザーのメールアドレスと認証タイプを[追加のエクスポートオプション](#authenticationtype)で指定します。

1.4. **Password** オプションで、Orchestrator ユーザーのパスワードを指定します。

<Warning>
  UiPath Community Orchestrator の古いアカウントで UiPath Cloud Platform を使用している場合は、最初に[パスワードをリセットして新しい認証方式に移行する](https://forum.uipath.com/t/consuming-apis-with-the-new-cloud-orchestrator/123112)必要があります。
</Warning>

Orchestrator のユーザーには、次のロールを割り当てる必要があります: **view queues**、**create transactions**、**view units**。

<img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_59.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=5b0159500b67f01765f2a8c7f0b2a478" alt="" width="580" height="321" data-path="images/flexi-capture/connectors/UiCon_59.png" />

2. **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 が含まれます) 。

3. <a id="queue" />**DmsMetadataTemplate.Name** field で、たとえば Orchestrator のキュー名を指定します:

```
connectorSettings.MappedFields.DmsMetadataTemplate.Name = "Verification queue"
```

エクスポートスクリプトの実行後、このキューにデータを含む新しいトランザクションが作成されます。Orchestrator でこのようなキューを作成します。

<img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_60.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=e5640aaadef0922ef921888e4529184e" alt="" width="969" height="506" data-path="images/flexi-capture/connectors/UiCon_60.png" />

4. **ExportImageSavingOptions** - 出力画像で使用できるオプション (例: 画像形式のオプションや、機密情報を含む field を墨消しする機能) については、ABBYY FlexiCapture Help に記載されています ([IExportImageSavingOptions](/ja/flexi-capture/appendix/scripts/iexportimagesavingoptions) インターフェイスの説明を参照してください) 。
5. 認識されたメタデータをエクスポートするために、fields をマッピングします。エクスポートする値を持つ各 Document Definition field について、トランザクション内でその名前を指定する必要があります。

<Note>
  マッピングされた Document Definition field のみがトランザクションにエクスポートされます。マッピングできる field の数に制限はありません。
</Note>

スクリプトを使用してエクスポートオプションを設定する場合、field の組み合わせは次の形式にする必要があります。

```
{ @"Invoice Layout\InvoiceNumber", "InvoiceNumber" }
```

1 つ目の値は、FlexiCapture Document Definition 内の field へのフルパスです。2 つ目の値は、UiPath Orchestrator のトランザクション内での field 名です。2 つ目の値では、トランザクション内の field に使用する名前を指定できます。指定した名前の fields が、ランタイム時にトランザクション内に作成されます。

XML を使用してエクスポートオプションを設定する場合、field の組み合わせは次の形式にする必要があります。

```
<FieldPair>
<AfcField>Invoice Layout\InvoiceNumber</AfcField>
<DmsField>InvoiceNumber</DmsField>
</FieldPair>
```

ここで、AfcField は ABBYY FlexiCapture の Document Definition における完全な field 名、DmsField は UiPath Orchestrator のトランザクションにおける field 名を表します。

6. **DmsSpecificOptions** プロパティを使用して、追加の UiPath エクスポート設定を指定することもできます。

6.1. <a id="authenticationtype" />**AuthenticationType** では、UiPath Orchestrator へのログイン時に使用する認証タイプを選択できます。指定できる値は *Basic* と *OAuth2* の 2 つのみです。

<Warning>
  UiPath Cloud Platform Orchestrator へのエクスポートを設定する場合、このオプションの使用は必須です。この場合は *OAuth2* を指定してください。
</Warning>

UiPath Enterprise Orchestrator へのエクスポートを設定する場合は、値に *Basic* を指定してください。UiPath Enterprise Orchestrator では、このオプションの使用は必須ではありません。

このオプションの値は、次のコードを使用して設定できます。

```
connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("AuthenticationType", "OAuth2"))
};
```

ここで、AuthenticationType はオプション名で、2 番目の属性はオプションの値です。

6.2. **Reference** では、トランザクションの作成時に Reference を指定できます。このオプションを設定するには、エクスポートスクリプトに次のコードを追加します。

```
connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("Reference", Document.Batch.Id.ToString()))
};
```

ここで、Reference はオプション名で、2 番目の属性はオプション値です。参照としてバッチ識別子を使用するには、値として Document.Batch.Id.ToString() を指定します。

6.3. **OrganizationUnitName** を使用すると、処理結果を指定した Orchestrator Organization Unit にエクスポートできます。このオプションは、UiPath Enterprise Orchestrator でのみ使用できます。

<Note>
  Orchestrator では、[Organization Unit](https://orchestrator.uipath.com/docs/about-organization-units) 機能を有効にする必要があります。
</Note>

このオプションを設定するには、エクスポートスクリプトに次のコードを追加します。

```
connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("OrganizationUnitName", "ORG_UNIT_NAME"))
};
```

ここで、OrganizationUnitName はオプション名で、2 番目の属性はその値です。オプション値として設定する Organization Unit の名前を指定します。

6.4. **AccountLogicalName** では、処理結果のエクスポート先となる UiPath Cloud Platform アカウントを指定できます。このオプションは、ユーザーが複数の UiPath Cloud Platform アカウントを利用できる場合に使用します。UiPath Cloud Platform Orchestrator でのみ使用できます。

このオプションの値には、アカウントの論理名を使用します。論理名は Orchestrator の **Account Settings** で確認でき、**Orchestrator site URL** の編集可能な部分に当たります。アカウントにログインすると、ブラウザーのアドレスバーにも論理名が表示されます。

<img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_62.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=f80e329ec04d539baac05d25ba541e75" alt="" width="949" height="679" data-path="images/flexi-capture/connectors/UiCon_62.png" />

以下のコード例は、このオプションの使用方法を示しています。

```
connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("AccountLogicalName", "testaccount123"))
};
```

ここで、AccountLogicalName はオプション名で、2 番目の属性はオプション値です。

1 つのエクスポート スクリプトで複数のオプションを使用する必要がある場合は、それらを **Option** 配列の要素として (カンマ区切りで) 指定します。たとえば、次のとおりです。

```
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()))
};
```

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

以下のコード例は、このオプションの使用方法を示しています。

```
connectorSettings.SaveDocumentImages = true;
```

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