Datacap オブジェクト API 参照

Datacap オブジェクト API を使用して、ランタイム・バッチと文書階層を作成または変更し、認識信頼性レベル、フィールド値、テキスト値、およびオブジェクト・タイプを取得または変更することもできます。Datacap オブジェクト API を使用するには、Microsoft Visual Studio などの開発環境で TDCO.DLL を参照します。

Datacap には、Datacap オブジェクト (DCO) の異なる部分 (バッチ、文書、ページ、フィールド、または文字) に対してアクションを実行するために使用可能な 3 つの別個のクラスまたは API があります。この 3 セットの Datacap API を使用して、文書階層 (セットアップ DCO) およびランタイム・バッチ階層 (ランタイム DCO) を変更します。

Datacap は、バッチを処理するために XML ファイルを必要とします。 Datacap Studio を使用してアプリケーションを作成する場合、Datacap はセットアップ DCO を XML ファイルとして保存します (例: C:¥Datacap¥application name¥dco_application name¥application name.xml)。同様に、Datacap Studio の外部で文書階層を作成する場合は、API を使用して、セットアップ DCO を XML ファイルとして保存します。各 Datacap オブジェクトは、XML ファイル内でノードとして表されます。セットアップ DCO は、有効な文書、文書内のページ、各ページ上のフィールド、およびその他の定義済み情報を含む、バッチの予定構造を定義します。

Datacap は、ワークフローの開始時にランタイム DCO を作成します。タスクが完了すると、Datacap はバッチをバッチ・フォルダー (C:¥Datacap¥APT¥batches¥batch number など) に書き込みます。ランタイム情報は、完了したタスクの名前が付けられたルート・ファイル (C:¥Datacap¥APT¥batches¥batch number¥Verify.xml など) で構成され、バッチ内の文書およびページを定義します。また、Datacap は、各ページのデータ・ファイル (C:¥Datacap¥APT¥batches¥batch number¥tm000001.xml など) の書き込みも行います。ランタイム DCO は、文書、ページ、フィールド、文字などの、バッチの現行構成を指示します。

API の 3 つのセットとは、DCO、DCOSetup、および DCOSetupNode です。この API を使用すると、ルート・ノード (バッチ) から子ノード (文書、ページ、フィールド、文字など) まで、DCO オブジェクト内を検索または参照することができます。 API を使用して、子ノードを検索および選択し、値の変更または設定を行うことができます。 DCO API をランタイム DCO で、DCOSetup API をセットアップ DCO で、DCOSetupNode API をセットアップ DCO 内の個々のノードで使用します。以下の作業は、一部の API の使用例を示しています。

文書階層を作成する
文書の作成、ページの再編成、または文書の削除により、バッチを変更する
機密情報を含むページ・タイプを判別し、カスタム検証パネルの実装により、適切なアクセス権限を持つオペレーターにのみこれらのページを表示する
フィールドおよび文字を作成、変更、またはデータ設定する
検証タスク中に、有効なフィールド値のリストをオペレーターに示すために使用可能なディクショナリーにアクセスおよび変更する
XML ファイルを使用してバッチをロードするか、バッチをディスクに保存する