追加の FlexiLayout を作成するための ABBYY FlexiLayout Studio の特長

ABBYY FlexiLayout Studio には、請求書プロジェクト向けの追加の FlexiLayout を開発するための特長がいくつかあります。

請求書プロジェクトのメインの FlexiLayout の適用時に検出されたfield Regionを基準に、要素の位置を指定できます。
ベンダーおよび事業部門の識別子を、Document Definition のデータセットへのリクエストで使用できます。
FlexiLayout のキーワードのリストやその他のパラメーターを XML ファイルにエクスポートできます。エクスポートしたファイルでは、FlexiLayout や Document Definition を編集せずにこれらを編集できます。

追加の FlexiLayout を作成する

FlexiCapture でバッチを開く

認識済みの請求書を含むバッチを FlexiCapture で開きます。

FlexiLayout Studio プロジェクトを作成する

ABBYY FlexiLayout Studio で新しいプロジェクトを作成します。メインメニューで Tools → Export Batch to FlexiLayout Studio → Create New FlexiLayout Studio Project… を選択します。このコマンドは、お使いのコンピューターに保存されている FlexiCapture プロジェクトでのみ使用できます。分散インストール環境でプロジェクトがサーバーに保存されている場合は、事前にプロジェクトをコンピューターにダウンロードしてください。ダウンロードするには、Project メニューの Export Project… をクリックします。

新しい ABBYY FlexiLayout Studio プロジェクトには、FlexiCapture バッチ内のすべてのドキュメントが含まれます。さらに、認識時に検出された field のRegionも reference layout として含まれます。プロジェクト名のサフィックスは、プロジェクト作成時点での Document Definition のバージョンを表します。

ツリー	ノード	説明
SearchElements	CommonBlockRegions	Document Definition のすべての field に対応する要素が含まれます。ABBYY FlexiLayout Studio プロジェクトには、FlexiCapture で各ドキュメントに FlexiLayouts を適用した際に検出されたすべてのブロックRegionの座標が保存されます。デフォルトでは、これらの座標を持つ Region が、Document Definition の field と同じ名前の要素に割り当てられます。これらを利用して、要素の相対位置を指定したり、新しい要素を作成したりできます。
SearchElements	CustomSearchElements	サンプル要素が含まれます。FlexiLayout の適用時に影響を与えないよう、これらはデフォルトで無効になっています。DataSetRequestSample は、Document Definition に保存されているベンダーおよび事業部門のデータセットに対するリクエストの例です。このデータセットには、ベンダーおよび事業部門の識別子が含まれています。

追加の FlexiLayout にfieldを追加する

追加の FlexiLayout にfieldを追加するには、そのfield用のブロックを作成し、その検索要素を指定します。Document Definition 内のfieldには一意の名前が必要なため、目的に応じて次のようにブロックに名前を付けます。

目的	作成するブロックの名前
新しいfieldの検索ロジックを記述する	一意の名前
すでに Document Definition に存在するfieldの検索ロジックを変更する	そのfieldと同じ名前

追加の FlexiLayout にページを追加する

追加の FlexiLayout に加えた変更を新しい画像でテストするには、FlexiCapture のバッチを ABBYY FlexiLayout Studio の既存の請求書プロジェクトにエクスポートします。Tools → Export Batch to FlexiLayout Studio → Add to Existing FlexiLayout Studio Project… をクリックします。 FlexiCapture のバッチのエクスポート先にできるのは、Create New FlexiLayout Studio Project… コマンドで作成した ABBYY FlexiLayout Studio プロジェクトのみです。エクスポートした FlexiCapture バッチは、それぞれ ABBYY FlexiLayout Studio プロジェクト内の新しいバッチになります。

プロジェクト作成後に追加されたfieldのエクスポート

新しい Document Definition には、ABBYY FlexiLayout Studio プロジェクトで使用したものより多くのfieldが含まれている場合があります。その場合、エクスポートログには、追加されたfieldごとに警告が記録されます。追加されたfieldをエクスポートするには、SearchElements ツリーの CommonBlockRegions ノードに、各fieldと同じ名前のブロックを追加してください。

Document Definition からデータセットにリクエストを送信する

サンプルリクエストは DataSetRequestSample 要素にあります。この要素はデフォルトで無効になっています。

NamedValue 型

名前付きの値。コンストラクター: NamedValue( String, String )

メソッド	説明
`String Name()`	名前付きの値の名前を返します。
`String Value()`	名前付きの値の値を返します。

NamedValueArray 型

名前付きの値の配列。コンストラクター:

NamedValueArray()
NamedValueArray( NamedValue namedValue )

メソッド	説明
`Int Count()`	配列内の要素の総数を返します。
`NamedValue GetAt( Int index )`	指定した index の要素を返します。
`Void Add( NamedValue namedValue )`	配列に名前付きの値を追加します。
`Void Add( NamedValueArray namedValueArray )`	名前付きの値の配列に、別の名前付きの値の配列を追加します。
`Void InsertAt( Int index, NamedValue namedValue )`	指定した位置 index に名前付きの値を挿入します。
`Void DeleteAll()`	配列内のすべての要素を削除します。
`Void DeleteAt( Int index )`	指定した位置 index の要素を削除します。
`Int FindByName( String name )`	name で指定した名前の値の位置を返します。

関数のパラメーター

パラメーター	説明
connectionString	接続文字列。形式は `"dbtype=FCDataset;fcTemplate=path_to_Document_Definition;datasetName=name_of_Data_Set;"` です。パスの各部分は二重のバックスラッシュ (`\\`) で区切ります。ABBYY FlexiLayout Studio では、Document Definition へのパスとデータセット名を使用してデータセットにアクセスします。コンパイル済みの FlexiLayout を FlexiCapture の Document Definition に追加した後は、データセット名のみが使用されます。
searchFields	値の取得元となる列の名前の配列。
searchCriteria	列-エントリのペアの配列。配列が空の場合は、すべての値が返されます。

searchCriteria 内のリクエストに複数の値が含まれる場合は、OR 演算子と AND 演算子で組み合わせます。

リクエストの内容	使用する演算子
1 つの field に対する複数の値	OR
それぞれが 1 つの field のみに対応する複数の値	AND
1 つの field に対する複数の値と、複数の field に対する値	同じ field の値同士には OR、field 同士には AND

関数

Function	Description
`Logic TestAccessToFCDataSet( String connectionString )`	データセットへの接続をテストします。
`Logic TestFCDataSetSearchCriteria( String connectionString, StringArray searchFields, NamedValueArray searchCriteria )`	データセットの検索条件をテストします。
`StringArray FieldNamesOfFCDataset( String connectionString )`	データセット内のすべての field のリストを、インデックス番号の昇順で返します。
`StringArray FieldNamesOfFCDataset( String connectionString, StringArray searchFields )`	指定したデータセットのデータセット field のリストを、インデックス番号の昇順で返します。複合列がある場合は、RecordOfFCDataset 関数と組み合わせて使用します。
`Int RecordCountOfFCDataset( String connectionString, StringArray searchFields, NamedValueArray searchCriteria )`	検索条件に一致するデータセット内のエントリ数を返します。RecordOfFCDataset 関数が返すことのできるエントリ数を確認するために使用します。
`Void PrepareRecordsetOfFCDataset( String connectionString, StringArray searchFields, NamedValueArray searchCriteria, Int maxRecordsCount = DefaultMaxRecordsCount )`	データセットへのクエリに使用するデータを準備します。RecordOfFCDataset 関数を呼び出す前に、新しい検索条件の set ごとにこの関数を呼び出してください。
`StringArray RecordOfFCDataset( String connectionString, StringArray searchFields, NamedValueArray searchCriteria, Int rowIndex )`	データセットへのクエリ結果のうち、rowIndex 番のエントリから値の配列を返します。値の数は、searchFields で渡された field の数と等しくなります (複合列の場合も含みます) 。
`Quality ValidateByFCDataSet( String word, String connectionString, Int fieldIndex, NamedValueArray searchCriteria, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = DefaultMaxRecordsCount )`	文字列 word の品質を返します。field のインデックス番号を受け取ります。インデックス番号は、FieldNamesOfFCDataset 関数の出力に indexing して取得できます。
`Void SearchTextFromFCDataSet( String connectionString, Int fieldIndex, NamedValueArray searchCriteria, Int maxRecordsCount = DefaultMaxRecordsCount )`	Static Text 関数の単語に対する検索条件を指定します。呼び出すたびに、既存の検索条件は新しい条件に置き換えられます。field のインデックス番号を受け取ります。インデックス番号は、FieldNamesOfFCDataset 関数の出力に indexing して取得できます。
`Void RegularExpressionFromFCDataSet( String connectionString, Int fieldIndex, NamedValueArray searchCriteria, Int maxRecordsCount = DefaultMaxRecordsCount )`	CharString 関数に対して、正規表現を使用した検索条件を指定します。呼び出すたびに、既存の検索条件は新しい条件に置き換えられます。field のインデックス番号を受け取ります。インデックス番号は、FieldNamesOfFCDataset 関数の出力に indexing して取得できます。

画像上の外部データベースで、列を指定して行を検索する

列の一覧を取得する

FieldNamesOfFCDataset を使用して、インデックス番号の昇順に並んだ列の一覧を取得します。

列のインデックスを特定する

検索するデータが含まれる列のインデックス番号を特定します。

フィルターを作成する

データセットからデータを絞り込むための条件の配列を作成します。

検索を実行する

列のインデックス番号とフィルター条件を SearchTextFromFCDataSet に渡します (正規表現を使用する必要がある場合は RegularExpressionFromFCDataSet) 。

このコードは、認識済みバッチが FlexiCapture からエクスポートされる際に自動生成されます。

複数の列のエントリを画像内で検索する

SearchTextFromFCDataSet 関数は呼び出すたびに検索パラメーターを置き換えるため、繰り返し呼び出しても効果はありません。回避策として、外部データベースから文字列を取得し、それらを SearchText 関数に渡します。SearchText は、各文字列で既存の検索パラメーターを置き換えるのではなく、既存の検索パラメーターに追加します。

列を一覧化する

検索対象のデータが含まれる列名の配列を作成します。

フィルターを作成する

データセット内のデータを絞り込むためのフィルター条件の配列を作成します。

エントリ数を数える

RecordCountOfFCDataset 関数を使用して、返されるエントリ数を確認します。

クエリを準備する

PrepareRecordsetOfFCDataset 関数を使用してクエリデータを準備します。

各レコードを読み取る

すべてのレコードを順に処理し、RecordOfFCDataset メソッドを使用して各レコードの配列を取得します。

値を SearchText に渡す

配列内の各要素の値を SearchText 関数に渡します。

複合列

データセット内の複合列は、エンコードされた外部データベースでは複数の列として格納されます。以下の例では、複合列 Name が 3 つの列として格納されているため、データセットの field は {VendorId, VATID, Name, Name, Name, City} となります。

関数またはパラメーター	複合列での動作
FieldNamesOfFCDataset	エンコードされた外部データベース内の列インスタンスごとに、複合列の名前を 1 回ずつ返します (例: `{VendorId, VATID, Name, Name, Name, City}`) 。
searchCriteria	複合列に対応する field に条件を指定すると、その複合列のすべての列インスタンスが検査対象になります。
searchFields	searchFields に複合列に対応する field が含まれている場合、結果には各列インスタンスの値が含まれます。たとえば、`{ VATID, Name, City}` をリクエストすると、`{VATID_value, Name_valueInColumn1, Name_valueInColumn2, Name_valueInColumn3, City_value}` が返されます。

リクエストで返される列の一覧を取得するには、searchFields 配列を FieldNamesOfFCDataset 関数に渡します。

FlexiLayout 設定を含む XML ファイルへのリクエストを行う

FlexiLayout 設定を含む XML ファイルに対しては、ABBYY FlexiLayout Studio の Documentation で説明されている 2 つの標準関数を使用してリクエストを行うことができます。

StringArray ReadFromXML(String filename, String xPathQuery)
String ReadSingleStringFromXML(String filename, String xPathQuery)

ABBYY FlexiLayout Studio で FlexiLayout の作業時にこのファイルを使用するには、このファイルをプロジェクトフォルダーまたはそのサブフォルダーに配置します。ファイルのパスは、ABBYY FlexiLayout Studio のプロジェクトファイルからの相対パスです。コンパイル済みの FlexiLayout を FlexiCapture の Document Definition にロードし、追加の FlexiLayout として使用する場合、XML ファイルは Templates フォルダーに配置されます。このファイルはそのフォルダー内で編集できます。FlexiLayout が適用されると、プログラムがこのファイルへのアクセスを自動的に管理します。

ABBYY FlexiCapture for Invoices

ABBYY FlexiCapture for Invoices Cloud

追加の FlexiLayout を作成するための ABBYY FlexiLayout Studio の特長