Fichier de description XML - ABBYY Documentation

Le fichier de description XML contient les informations relatives à un rapport personnalisé qui permettent de l’activer dans l’Administration and Monitoring Console d’ABBYY FlexiCapture. L’installation active automatiquement plusieurs rapports d’exemple. Étudiez leur structure et utilisez-les comme point de départ pour vos propres rapports.

Éléments du fichier de description XML

Les éléments <customreport> et <crystalreportfile/> sont toujours obligatoires. Tous les autres éléments s’appliquent uniquement aux rapports basés sur un DataSet.

Élément	Obligatoire	Description
`<customreport></customreport>`	Oui	Élément principal du rapport. Il doit contenir la description complète du rapport.
`<crystalreportfile/>`	Oui	Indique le nom du fichier de rapport.
`<storedprocedure/>`	Pour les procédures stockées	Obligatoire pour les rapports basés sur des données extraites par une procédure stockée. Son seul attribut, `Name`, contient le nom de la procédure stockée.
`<sqlText></sqlText>`	Pour les requêtes SQL	Obligatoire pour les rapports basés sur des requêtes SQL. Saisissez le contenu de la requête entre les balises ouvrante et fermante.
`<parameters></parameters>`	Non	Contient les paramètres de la procédure stockée ou de la requête SQL, chacun dans son propre élément `<parameter>`. Omettez cet élément lorsque le DataSet ne nécessite aucun paramètre.
`<parameter></parameter>`	Non	Décrit un paramètre d’une requête SQL ou d’une procédure stockée, ainsi que la manière dont l’Administration and Monitoring Console invite l’utilisateur à le renseigner.
`<possiblevaluelist></possiblevaluelist>`	Non	Contient les valeurs possibles d’un élément `<parameter>`, chacune dans son propre élément `<possiblevaluelistitem />`.
`<possiblevaluelistitem />`	Non	Décrit une valeur possible d’un paramètre.

Si le fichier contient à la fois une balise <storedprocedure/> et une balise <sqlText></sqlText>, la procédure stockée crée le DataSet.

Attributs de customreport

Attribut	Obligatoire	Description
`Name`	Oui	Nom du rapport tel qu’il est affiché dans l’Administration and Monitoring Console.
`Type`	Oui	Type de rapport. Valeurs possibles : `CrystalReportQuery` pour les rapports basés sur des requêtes Crystal Report, `DataSetReport` pour les rapports basés sur DataSet.
`Description`	Non	Description du rapport telle qu’elle est affichée dans l’Administration and Monitoring Console.

Attributs de crystalreportfile

Attribut	Obligatoire	Description
`Filename`	Oui	Nom du fichier de rapport, au format `.rdlc` ou `.rdl`. Placez ce rapport dans le même dossier que le fichier de description XML.

Attributs du paramètre

Attribut	Obligatoire	Description
`Name`	Oui	Nom du paramètre. Il est transmis à la requête SQL ou à la procédure stockée.
`Type`	Oui	Type du paramètre. Valeurs possibles : `Int`, `Date`, `String`.
`Prompt`	Non	Indication affichée lorsqu’un utilisateur saisit ce paramètre.
`Default`	Non	Valeur du paramètre avant que l’utilisateur n’en saisisse une autre. Un paramètre `Date` accepte la valeur `now`, qui correspond à la date du jour.

Attributs de possiblevaluelistitem

Par défaut, l’utilisateur saisit les valeurs des paramètres dans un champ de saisie. Pour lui permettre de sélectionner une valeur dans une liste, ajoutez l’élément <possiblevaluelist>.

Attribut	Obligatoire	Description
`value`	Oui	Valeur possible du paramètre. Son type doit correspondre à celui du paramètre.
`displayvalue`	Non	Ligne affichée dans la liste. En l’absence de cet attribut, la liste affiche l’attribut `value`.