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

ABBYY_FlexiCapture_12 セットには、5 つのユーザーライブラリが含まれています。各ライブラリには、入力および出力パラメーターが一覧表示されています。

Configure.ums5

このライブラリは、CreateBatch、GetBatchStage、GetBatchVerificationURLs、および FetchBatchResult ライブラリで ABBYY FlexiCapture に接続するための設定を指定します。

ワークフローでは、Configure シナリオを他の ABBYY_FlexiCapture_12 ライブラリより前に配置する必要があります。

方向	名前	説明
入力	Server URL	ABBYY FlexiCapture Application Server のアドレス。
入力	Company	ABBYY FlexiCapture のテナント名。オプション。
入力	ユーザー名	ABBYY FlexiCapture のユーザー名。
入力	パスワード	ABBYY FlexiCapture のユーザーパスワード。
入力	Project	ABBYY FlexiCapture プロジェクト名。

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

方向	名前	説明
入力	バッチタイプ	ABBYY FlexiCapture のバッチタイプ名。オプション。空欄の場合は、Default バッチタイプが使用されます。
入力	Input フォルダー	ABBYY FlexiCapture に送信する画像のフルパス。
出力	バッチ ID	作成されたバッチの ID。

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

方向	名前	説明
入力	バッチ ID	バッチ識別子。
出力	ステージ型	バッチの現在のステージ型を示す数値です。
出力	ステージ名	現在のバッチのステージ名です。
出力	詳細	現在のステージの詳細な説明です。バッチが Exceptions ステージにある場合は、エラーの説明が提供されます。

ステージ型の数値の詳細については、処理ステージの型を参照してください。

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

方向	Name	Description
In	バッチ ID	バッチ識別子。
Out	Verification URLs	`;` で区切られたリンクのコレクション。

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

方向	名前	説明
入力	バッチ ID	バッチ識別子。
入力	Output フォルダー	バッチ処理結果が保存されるフォルダー。
出力	ドキュメント数	バッチ内のドキュメント数。
出力	ドキュメント ID	`;` 区切りのバッチ内ドキュメント ID を含む string。
出力	ドキュメント定義	`;` 区切りのバッチ内ドキュメント名を含む string。

エクスポートファイルは、次の構造で Output フォルダーに保存されます。

<Output folder>/<Batch ID>/<Document ID>/<Name of the exported file>