Archivo de descripción XML - ABBYY Documentation

El archivo de descripción XML contiene información sobre un informe personalizado que lo habilita en la Consola de administración y supervisión de ABBYY FlexiCapture. La instalación habilita automáticamente varios informes de ejemplo. Estudie su estructura y utilícelos como punto de partida para sus propios informes.

Elementos del archivo de descripción XML

Los elementos <customreport> y <crystalreportfile/> siempre son obligatorios. El resto de los elementos se aplica únicamente a informes basados en DataSet.

Elemento	Obligatorio	Descripción
`<customreport></customreport>`	Sí	El elemento principal del informe. Debe contener toda la descripción del informe.
`<crystalreportfile/>`	Sí	Especifica el nombre del archivo de informe.
`<storedprocedure/>`	Para procedimientos almacenados	Obligatorio para informes basados en datos extraídos mediante un procedimiento almacenado. Su único atributo, `Name`, contiene el nombre del procedimiento almacenado.
`<sqlText></sqlText>`	Para consultas SQL	Obligatorio para informes basados en consultas SQL. Introduzca el contenido de la consulta entre las etiquetas de apertura y cierre.
`<parameters></parameters>`	No	Contiene los parámetros del procedimiento almacenado o de la consulta SQL, cada uno en su propio elemento `<parameter>`. Omita este elemento si el DataSet no requiere parámetros.
`<parameter></parameter>`	No	Describe un parámetro de una consulta SQL o de un procedimiento almacenado, así como la forma en que la Consola de administración y supervisión solicita su valor.
`<possiblevaluelist></possiblevaluelist>`	No	Contiene los posibles valores de un elemento `<parameter>`, cada uno en su propio elemento `<possiblevaluelistitem />`.
`<possiblevaluelistitem />`	No	Describe un posible valor de un parámetro.

Si el archivo contiene las etiquetas <storedprocedure/> y <sqlText></sqlText>, el procedimiento almacenado crea el DataSet.

Atributos de customreport

Atributo	Obligatorio	Descripción
`Name`	Sí	El nombre del informe, tal como aparece en la Consola de administración y supervisión.
`Type`	Sí	El tipo de informe. Valores posibles: `CrystalReportQuery` para informes basados en consultas de Crystal Report y `DataSetReport` para informes basados en DataSet.
`Description`	No	La descripción del informe, tal como aparece en la Consola de administración y supervisión.

Atributos de crystalreportfile

Atributo	Obligatorio	Descripción
`Filename`	Sí	El nombre del archivo de informe, con extensión `.rdlc` o `.rdl`. Coloque el informe en la misma carpeta que el archivo de descripción XML.

Atributos del parámetro

Atributo	Obligatorio	Descripción
`Name`	Sí	El nombre del parámetro. Se pasa a la consulta SQL o al procedimiento almacenado.
`Type`	Sí	El tipo del parámetro. Valores posibles: `Int`, `Date`, `String`.
`Prompt`	No	La indicación que se muestra cuando un usuario introduce este parámetro.
`Default`	No	El valor del parámetro antes de que el usuario introduzca uno diferente. Un parámetro `Date` acepta el valor `now`, que corresponde a la fecha actual.

Atributos de possiblevaluelistitem

De forma predeterminada, el usuario introduce los valores de los parámetros en un campo de entrada. Para que el usuario pueda elegir un valor de una lista, agregue el elemento <possiblevaluelist>.

Atributo	Obligatorio	Descripción
`value`	Sí	Un valor posible del parámetro. Su tipo debe coincidir con el tipo del parámetro.
`displayvalue`	No	La fila que se muestra en la lista. Si no se especifica, la lista muestra el atributo `value`.