XML 記述ファイル - ABBYY Documentation

XML 記述ファイルには、ABBYY FlexiCapture の管理および監視コンソールでカスタムレポートを有効化するための情報が含まれています。インストール時に、いくつかのレポート例が自動的に有効化されます。それらの構造を確認し、独自のレポートを作成する際の出発点として使用してください。

XML 記述ファイルの要素

<customreport> 要素と <crystalreportfile/> 要素は常に必須です。それ以外の要素は、DataSet ベースのレポートにのみ適用されます。

要素	必須	説明
`<customreport></customreport>`	はい	レポートのメイン要素です。レポートの記述全体を含める必要があります。
`<crystalreportfile/>`	はい	レポートファイルの名前を指定します。
`<storedprocedure/>`	ストアドプロシージャの場合	ストアドプロシージャで抽出したデータに基づくレポートでは必須です。唯一の属性である `Name` には、ストアドプロシージャの名前を指定します。
`<sqlText></sqlText>`	SQL クエリの場合	SQL クエリに基づくレポートでは必須です。開始タグと終了タグの間にクエリの内容を入力します。
`<parameters></parameters>`	いいえ	ストアドプロシージャまたは SQL クエリのパラメーターを格納します。各パラメーターは個別の `<parameter>` 要素に格納されます。DataSet にパラメーターが不要な場合は、この要素を省略します。
`<parameter></parameter>`	いいえ	SQL クエリまたはストアドプロシージャの 1 つのパラメーターと、管理および監視コンソールでの入力方法を記述します。
`<possiblevaluelist></possiblevaluelist>`	いいえ	`<parameter>` 要素で指定可能な値を格納します。各値は個別の `<possiblevaluelistitem />` 要素に格納されます。
`<possiblevaluelistitem />`	いいえ	パラメーターに指定可能な値を 1 つ記述します。

ファイルに <storedprocedure/> タグと <sqlText></sqlText> タグの両方が含まれている場合は、ストアドプロシージャによって DataSet が作成されます。

属性	必須	説明
`Name`	はい	管理および監視コンソールに表示されるレポートの名前。
`Type`	はい	レポートの型。指定可能な値は、Crystal Report クエリに基づくレポートの場合は `CrystalReportQuery`、DataSet ベースのレポートの場合は `DataSetReport` です。
`Description`	いいえ	管理および監視コンソールに表示されるレポートの説明。

属性	必須	説明
`Filename`	はい	`.rdlc` または `.rdl` のレポートファイル名。レポートファイルは XML 記述ファイルと同じフォルダーに配置します。

属性	必須	説明
`Name`	はい	パラメーターの名前。SQL クエリまたはストアドプロシージャに渡されます。
`Type`	はい	パラメーターの型。指定可能な値: `Int`、`Date`、`String`。
`Prompt`	いいえ	ユーザーがこのパラメーターを入力する際に表示されるヒント。
`Default`	いいえ	ユーザーが別の値を入力する前のパラメーターの値。`Date` パラメーターには、現在の日付を表す `now` を指定できます。

デフォルトでは、ユーザーは入力フィールドにパラメーター値を入力します。ユーザーがリストから選択できるようにするには、<possiblevaluelist> 要素を追加します。

属性	必須	説明
`value`	はい	パラメーターの候補値です。型はパラメーターの型と一致している必要があります。
`displayvalue`	いいえ	リストに表示される行です。この属性がない場合、リストには `value` 属性が表示されます。