XML description file - ABBYY Documentation

The XML description file holds the information about a custom report that enables it in the ABBYY FlexiCapture Administration and Monitoring Console. Installation enables several example reports automatically. Study their structure and use them as a starting point for your own reports.

Elements of the XML description file

The <customreport> and <crystalreportfile/> elements are always required. Every other element applies only to DataSet based reports.

Element	Required	Description
`<customreport></customreport>`	Yes	The main element of the report. It must contain the entire report description.
`<crystalreportfile/>`	Yes	Names the report file.
`<storedprocedure/>`	For stored procedures	Required for reports based on data extracted by a stored procedure. Its only attribute, `Name`, holds the name of the stored procedure.
`<sqlText></sqlText>`	For SQL queries	Required for reports based on SQL queries. Enter the contents of the query between the opening and closing tags.
`<parameters></parameters>`	No	Holds the parameters of the stored procedure or SQL query, each in its own `<parameter>` element. Omit this element when the DataSet needs no parameters.
`<parameter></parameter>`	No	Describes one parameter of a SQL query or stored procedure, and how the Administration and Monitoring Console prompts for it.
`<possiblevaluelist></possiblevaluelist>`	No	Holds the possible values of a `<parameter>` element, each in its own `<possiblevaluelistitem />` element.
`<possiblevaluelistitem />`	No	Describes one possible value of a parameter.

If the file contains both a <storedprocedure/> and a <sqlText></sqlText> tag, the stored procedure creates the DataSet.

Attributes of customreport

Attribute	Required	Description
`Name`	Yes	The name of the report, as displayed in the Administration and Monitoring Console.
`Type`	Yes	The type of the report. Possible values: `CrystalReportQuery` for reports based on Crystal Report queries, `DataSetReport` for DataSet based reports.
`Description`	No	The description of the report, as displayed in the Administration and Monitoring Console.

Attributes of crystalreportfile

Attribute	Required	Description
`Filename`	Yes	The name of the report file, either `.rdlc` or `.rdl`. Place that report in the same folder as the XML description file.

Attributes of parameter

Attribute	Required	Description
`Name`	Yes	The name of the parameter. It passes to the SQL query or stored procedure.
`Type`	Yes	The type of the parameter. Possible values: `Int`, `Date`, `String`.
`Prompt`	No	The hint displayed when a user enters this parameter.
`Default`	No	The value of the parameter before the user enters a different one. A `Date` parameter accepts the value `now`, which corresponds to the current date.

Attributes of possiblevaluelistitem

By default, the user types parameter values into an entry field. To have the user choose from a list instead, add the <possiblevaluelist> element.

Attribute	Required	Description
`value`	Yes	A possible value of the parameter. Its type must match the type of the parameter.
`displayvalue`	No	The row displayed in the list. Without it, the list displays the `value` attribute.