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

# ABBYY_FlexiCapture_12 ユーザーライブラリ仕様

> WinActor 向け ABBYY_FlexiCapture_12 UMS5 ライブラリ（Configure、CreateBatch、GetBatchStage、GetBatchVerificationURLs、FetchBatchResult）のリファレンスです。

以下では、ABBYY\_FlexiCapture\_12 のすべてのライブラリについて説明します。

<div id="configureums5">
  ## Configure.ums5
</div>

このライブラリでは、**CreateBatch**、**GetBatchStage**、**GetBatchVerificationURLs**、**FetchBatchResult** の各ライブラリが FC に接続するための設定を指定します。**Configure** シナリオは、ワークフロー内で他の ABBYY\_FlexiCapture\_12 ライブラリよりも前に配置する必要があります。

|    | **Name**   | **Description**              |
| -- | ---------- | ---------------------------- |
| In | Server URL | FC Application Server のアドレス。 |
| In | Company    | FC テナント名 (任意) 。              |
| In | User name  | FC のユーザー名。                   |
| In | Password   | FC のユーザーパスワード。               |
| In | Project    | FC のプロジェクト名。                 |

<div id="createbatchums5">
  ## CreateBatch.ums5
</div>

このライブラリは、指定したフォルダー内のすべてのファイルを処理のために FC に送信し、送信されたファイルに対して作成されたバッチの ID を返します。これらのファイルすべてに対して、1 つのバッチが作成されます。

|     | **名前**      | **説明**                                                         |
| --- | ----------- | -------------------------------------------------------------- |
| In  | バッチタイプ      | FC のバッチタイプ名 (省略可能) 。このパラメーターを空白のままにすると、「Default」バッチタイプが使用されます。 |
| In  | Input フォルダー | FC に送信する画像のフルパス。                                               |
| Out | Batch ID    | 作成されたバッチの ID。                                                  |

<div id="getbatchstageums5">
  ## GetBatchStage.ums5
</div>

このライブラリは、バッチの現在のステージに関する情報を取得します。

|    | **名前**   | **説明**                                                                                                         |
| -- | -------- | -------------------------------------------------------------------------------------------------------------- |
| 入力 | Batch ID | バッチ識別子。                                                                                                        |
| 出力 | ステージ型    | バッチの現在のステージ型を示す数値です。FC のステージ型の詳細については、[処理ステージの型](/ja/flexi-capture/reports/database/stage-type-enum)を参照してください。 |
| 出力 | ステージ名    | 現在のバッチのステージ名です。                                                                                                |
| 出力 | 詳細       | 現在のステージの詳細な説明です。バッチが **Exceptions** ステージにある場合は、エラーの説明が表示されます。                                                  |

<div id="getbatchverificationurlsums5">
  ## GetBatchVerificationURLs.ums5
</div>

このライブラリは、バッチの Web Verification Station タスクの URL を返します。

|     | **Name**          | **Description**       |
| --- | ----------------- | --------------------- |
| In  | Batch ID          | バッチ識別子。               |
| Out | Verification URLs | ";" で区切られたリンクのコレクション。 |

<div id="fetchbatchresultums5">
  ## FetchBatchResult.ums5
</div>

このライブラリは、バッチ処理の結果を取得します。

<table width="100%"><tbody><tr><td> </td><td><p><strong>名前</strong></p></td><td><p><strong>説明</strong></p></td></tr><tr><td><p>入力</p></td><td><p>Batch ID</p></td><td><p>バッチ識別子です。</p></td></tr><tr><td><p>入力</p></td><td><p>Output フォルダー</p></td><td><p>バッチ処理の結果が保存されるフォルダーです。エクスポートされたファイルは、次の形式でこのフォルダーに保存されます。</p><p>\<Output folder> / \<Batch ID> / \<Document ID> / \< Name of the exported file ></p></td></tr><tr><td><p>出力</p></td><td><p>ドキュメント数</p></td><td><p>バッチ内のドキュメント数です。</p></td></tr><tr><td><p>出力</p></td><td><p>Document ID</p></td><td><p>バッチ内のドキュメント ID を ";" で区切った文字列です。</p></td></tr><tr><td><p>出力</p></td><td><p>ドキュメント定義</p></td><td><p>バッチ内のドキュメント名を ";" で区切った文字列です。</p></td></tr></tbody></table>