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

# 説明ファイル

> FlexiCapture で Hot Folder からインポートする際のバッチ作成を制御する説明ファイルについて、Captiva、Kodak、空ファイル、XML 形式の詳細とともに説明します。

**説明ファイル** は、Hot Folder から画像を追加する際に、バッチをどのように構成するかを定義する補助ファイルです。説明ファイルの形式によって、バッチの構成に使用されるファイルセットは異なります。

<Note>
  文書画像に加えて、[office形式のファイルをインポートして処理する](/ja/flexi-capture/project-settings/image-processing-settings#office)こともできます。
</Note>

プログラムでは、次の種類の説明ファイルを使用します。

1. **Captiva QuickScan**
   説明ファイルに記載されているすべての画像ファイルがバッチに追加されます。バッチ内の画像ファイルの順序は、説明ファイルに記載されている順序と同じです。
2. **Capture Software for Kodak**
   Kodak バッチのフォルダーにある画像ファイルが、ファイル名の昇順でバッチに追加されます。画像の追加元フォルダーへのパスは、\*.ini 説明ファイルの **Properties** セクションにある **Batch** キーで指定します。

```
[Properties]
BatchPath=\\computer\HotFolder\PathInHF"
```

サブフォルダー内の画像もバッチに追加されます。

<Note>
  この種類の説明ファイルには登録パラメーターを追加できません。
</Note>

3. **空のファイル**
   このファイルは、新しいバッチを作成する必要があることを示すマーカーとして使用されます。ファイルの内容は関係なく、重要なのは名前だけです。画像はHot Folderからアルファベット順に追加されます。\[File name] フィールドで指定したマスクに対応する名前のファイルが見つかると、システムは新しいバッチを作成します。したがって、`*.dat` マスクが指定され、Hot Folderに次のファイルが含まれている場合:
   * Contract1.jpg
   * Contract2.jpg
   * Contract3.dat
   * Contract4.jpg
   * Contract5.jpg
   * Contract6.dat

Contract3.dat が見つかった時点で、Contract1.jpg と Contract2.jpg のファイルに対する 1 つのバッチが作成され、Contract6.dat が見つかった時点で、Contract4.jpg と Contract5.jpg のファイルに対する別のバッチが作成されます。

4. **XML ファイル**
   これは、定義済みの構造を持つ XML ファイルです。XML ファイルは、他の 3 種類が使用できず、カスタム説明ファイルを生成できる場合に使用されます。説明ファイルに一覧表示されている画像ファイルがバッチに追加されます。

<div id="file-structure">
  ## ファイル構造
</div>

XML ドキュメントには、ルート要素 **Batch** と、次の子要素 **RegistrationParams**、**Documents**、**Images** が含まれている必要があります。

**Images** 要素には **Image** 要素を含める必要があり、その数は作成されるバッチのページ数に対応している必要があります。

**Batch** 要素には次のタグがあります。

* **Priority** - バッチの優先度: Lowest、Low、Normal、High、または Highest (このタグは省略できます。優先度が指定されていない場合は、インポートプロファイルで指定された優先度が使用されます。)
* **Name** - バッチ名
* **TypeName** - バッチタイプの名前 (インポートプロファイルで Default バッチタイプが指定されている場合に適用されます。Scanning Station の Output フォルダーが Hot Folder として使用される場合、このタグで指定する名前は Scanning Station 上のバッチタイプ名と同じである必要があります。この場合、指定したタイプのバッチが作成されます。)
* **Attachments** - バッチの添付ファイル
* **SourceID** - バッチソースの文字列識別子
* **Description** - バッチの説明
* **RegistrationParams** - バッチ登録パラメーターのリスト (説明ファイルの登録パラメーターは、インポートプロファイルで指定された登録パラメーターに追加されます。)
* **Documents** - 文書のリスト (自動文書アセンブリから除外)
* **Images** - 個別ページのリスト (自動アセンブリに含まれる)

**Document** 要素には次のタグがあります。

* **Index** (mandatory attribute) - バッチ内の文書のインデックス (番号は 0 から始まります)

* **Priority** - 文書の優先度: Lowest、Low、Normal、High、または Highest (このタグは省略できます。)

* **Name** - 文書名

* **Barcode** - バーコード値

* **RegistrationParams** - 文書登録パラメーターのリスト

* **Attachments** - 文書の添付ファイル

* **Images** - 文書ページのリスト

**Parameter** 要素 (**RegistrationParams** 要素の子) には次のタグがあります。

* **Name** (attribute) - 登録パラメーターの名前
* **Value** - 登録パラメーターの値

**Image** 要素には次のタグがあります。

* Index (mandatory attribute) - 文書内のページのインデックス (**Images** 要素に含まれるページの場合は対応する文書、またはバッチの文書)。番号は 0 から始まります。
* **PageIndex** (attribute) - 複数ページのインポートファイル内のページ番号 (番号は 0 から始まります)
* **SourcePath** (attribute) - 元の画像が格納されているフォルダーへのパス
* **SourceFile** (attribute) - ページ画像を含むソースファイル (SourcePath からの相対パス)
* **SourceFilePageIndex** (attribute) - 複数ページのソースファイル内のページ番号 (番号は 0 から始まります)
* **SourceDetails** (attribute) - ソースの説明 (スキャナ名)
* **Attachments** - ページの添付ファイル
* **Value** - Hot Folder からの相対パスで指定する、ページのインポートファイルへのパス

**Attachment** 要素には次のタグがあります。

* **Name** - 添付ファイル名 (名前が指定されていない場合は、ソースファイル名が使用されます。)
* **Value** - 添付ファイルへのパス (HotFolder ルートからの相対パスを指定できます。)

スキャンプログラムは、スキャンした画像が Hot Folder 自体、またはその第 1 レベルのサブフォルダーに配置されるように設定することをお勧めします。バッチの作成時に、プログラムは対応する説明ファイルの **Image** 要素に列挙されているすべての画像をバッチに追加します。画像は、説明ファイル内に記載されている順序で追加されます。

バッチ内の画像ファイルの順序は、説明ファイル内の順序と同じです。