> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XML説明ファイル

> ABBYY FlexiCapture でカスタムレポートを有効化する XML説明ファイルのリファレンスです。customreport、sqlText、parameter、possiblevaluelist を扱います。

XML説明ファイルにはカスタムレポートに関する情報が含まれており、ABBYY FlexiCapture の管理および監視コンソールでレポートを[有効化](/ja/flexi-capture/reports/overview/connection)するために使用されます。レポートの[例](/ja/flexi-capture/reports/examples/examples)のいくつかは、インストール時に自動的に有効化されます。それらの構造を確認し、独自のレポートを作成する際の参考にできます。

XML説明ファイルには、次の要素が含まれます。

1. **\<customreport>\</customreport>**
   レポートのメイン要素です。レポートの説明全体を含める必要があります。
   属性:
   * Name レポートの名前です。管理および監視コンソールに表示される必須属性です。
   * Type レポートの型です。これは必須属性です。指定できる値は 2 つあります: CrystalReportQuery (Crystal Report クエリに基づくレポートの場合) または DataSetReport (DataSet ベースのレポートの場合) 。
   * Description レポートの説明です。管理および監視コンソールに表示されます。この属性は省略可能です。
2. **\<crystalreportfile/>**
   これは必須要素です。属性は Filename のみで、レポートファイル (\*.rdlc または \*.rdl) の名前を指定する必要があります。その名前のレポートは、XML説明ファイルと同じカタログに配置する必要があります。

<Note>
  その他の要素は、DataSet ベースのレポートでのみ必要です。
</Note>

3. **\<storedprocedure/>**
   この要素は、ストアドプロシージャで取得したデータに基づくレポートで必要です。属性は Name のみで、ストアドプロシージャの名前が入ります。
4. **\<sqlText>\</sqlText>**
   この要素は、SQL クエリに基づくレポートで必要です。クエリの内容は開始タグと終了タグの間に入力する必要があります。

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

5. **\<parameters>\</parameters>**
   ストアドプロシージャまたは SQL Query のパラメーター一覧です。これらの要素はすべて、\<parameter> タグと \</parameter> タグの間に記述する必要があります。DataSet の作成にパラメーターが不要な場合、この要素は XML説明ファイルに含めてはいけません。
6. **\<parameter>\</parameter>**
   SQL クエリまたはストアドプロシージャのパラメーターを記述し、管理および監視コンソールでのパラメーター入力に関する詳細を指定します。属性:
   * Name パラメーターの名前です。これは必須属性です。SQL クエリまたはストアドプロシージャに渡されます。
   * Type パラメーターの型です。これは必須属性です。指定可能な値: Int、Date、String。
   * Prompt ユーザーがこのパラメーターを入力する際に表示されるヒントです。この属性は省略可能です。
   * Default ユーザーが別の値を入力する前のパラメーターのデフォルト値です。これは省略可能な属性です。Date 型のパラメーターには "now" という値を指定でき、これは現在の日付に対応します。

既定では、ユーザーは入力フィールドにパラメーターの値を入力します。値をリストから選択する必要がある場合は、\<possiblevaluelist> 要素を追加します。

1. **\<possiblevaluelist>\</possiblevaluelist>**
   \<possiblevaluelistitem /> 要素には、\<parameter> 要素で指定可能なすべての値を記述します。
2. **\<possiblevaluelistitem />**
   パラメーターの指定可能な値の 1 つを記述します。属性:
   * value パラメーターの指定可能な値です。これは必須属性です。その型はパラメーターの型と一致している必要があります。
   * displayvalue リストに表示される項目です。この属性は省略可能です。この値がない場合は、value 属性が表示されます。