XML記述ファイル

XML記述ファイルにはカスタムレポートに関する情報が含まれ、ABBYY FlexiCaptureの管理/監視コンソールでレポートを 有効化 するのに使用されます。レポートの複数の 例 がインストール中に自動的に有効になります。それらの構造を研究し、ご自身のレポートを作成する場合に見本としてそれらを使用することができます。

XML記述ファイルには以下の要素が含まれます：

1. <customreport></customreport>
   レポートのメイン要素。レポートの記述全体を含める必要があります。
   属性：

• Name、レポートの名前。管理/監視コンソールに表示され、必須の属性です。
• Type、レポートの型。これは必須の属性です。ここには2つの値があります：CrystalReportQuery (Crystal Reportクエリに基づくレポート用) または DataSetReport (DataSetベースのレポート用)。
• Description、管理/監視コンソールに表示されるレポートの記述。この属性はオプションです。

2. <crystalreportfile/>
   これは必須の要素です。これには、レポートファイル (*.rdlcまたは*.rdl) の名前を含まなくてはいけない一つの属性Filenameしかありません。その名前のレポートは、XML記述ファイルと同じカタログに配置する必要があります。
   注： 他の要素は、DataSetベースのレポートでのみ必須です。
3. <storedprocedure/>
   この要素は、格納プロシージャによって抽出されたデータに基づくレポートに必要です。これには、格納プロージャの名前を含む一つの属性Nameしかありません。
4. <sqlText></sqlText>
   この要素は、SQLクエリに基づくレポートに必要です。クエリのコンテンツは開始タグと終了タグの間に入力する必要があります。
   注： <storedprocedure/> および <sqlText></sqlText> のタグ両方がXML記述ファイルにある場合は、DataSetが格納プロシージャによって作成されます。
5. <parameters></parameters>
   格納プロシージャまたはSQLクエリのパラメータの範囲。これらの要素のすべてが <parameter> および </parameter> タグの間に入力されなければなりません。DataSetのコンパイルにパラメータが不要な場合は、この要素をXML記述ファイルには含みません。
6. <parameter></parameter>
   SQLクエリまたは格納プロシージャのパラメータを記述し、管理/監視コンソールのパラメータエントリに関連する詳細を指定します。属性：

• Name、パラメータの名前。これは必須の属性です。SQLクエリまたは格納プロシージャに転送されます。
• Type、パラメータの型。これは必須の属性です。可能な値：Int, Date, String。
• Prompt、ユーザーがこのパラメータを入力した時に表示されるヒント。この属性はオプションです。
• Default、ユーザーが別の値を入力する前のパラメータのデフォルト値。これはオプションの属性です。日付型パラメータには、現在の日付に対応する値「now」を入れることができます。

デフォルトでは、ユーザーは入力フィールドにパラメータの値を入力します。値をリストから選択しなければいけない場合は、<possiblevaluelist> 要素を追加します。

7. <possiblevaluelist></possiblevaluelist>
   <possiblevaluelistitem /> 要素は、<parameter> 要素の可能なすべての値です。
8. <possiblevaluelistitem />
   パラメータの可能な値の一つを記述します。属性：

• value、パラメータの可能な値。この属性は必須です。その型はパラメータの型と合致しなければなりません。
• displayvalue、リストに表示される行。この属性はオプションです。この値がない場合は、value属性が表示されます。