Passer au contenu principal
Le fichier de description XML contient des informations sur un rapport personnalisé et sert à activer le rapport dans l’Administration and Monitoring Console d’ABBYY FlexiCapture. Plusieurs exemples de rapports sont activés automatiquement lors de l’installation. Vous pouvez étudier leur structure et vous en servir comme modèles pour créer vos propres rapports. Le fichier de description XML comprend les éléments suivants :
  1. <customreport></customreport> Élément principal du rapport. Il doit contenir la description complète du rapport. Attributs :
    • Name le nom du rapport. Il sera affiché dans l’Administration and Monitoring Console et constitue un attribut obligatoire.
    • Type le type de votre rapport. Il s’agit d’un attribut obligatoire. Il peut prendre deux valeurs : CrystalReportQuery (pour les rapports basés sur des requêtes Crystal Report) ou DataSetReport (pour les rapports basés sur DataSet).
    • Description la description du rapport qui sera affichée dans l’Administration and Monitoring Console. Cet attribut est facultatif.
  2. <crystalreportfile/> Il s’agit d’un élément obligatoire. Il n’a qu’un seul attribut, Filename, qui doit contenir le nom du fichier de rapport (*.rdlc ou *.rdl). Le rapport portant ce nom doit être placé dans le même dossier que le fichier de description XML. Remarque : Les autres éléments ne sont requis que pour les rapports basés sur DataSet.
  3. <storedprocedure/> Cet élément est obligatoire pour les rapports basés sur des données extraites par une procédure stockée. Il n’a qu’un seul attribut, Name, qui contient le nom de la procédure stockée.
  4. <sqlText></sqlText> Cet élément est obligatoire pour les rapports basés sur des requêtes SQL. Le contenu de la requête doit être saisi entre les balises d’ouverture et de fermeture. Remarque : Si les balises <storedprocedure/> et <sqlText></sqlText> sont toutes deux présentes dans le fichier de description XML, le DataSet sera créé par la procédure stockée.
  5. <parameters></parameters> Ensemble des paramètres de la procédure stockée ou de la requête SQL. Tous ces éléments doivent être saisis entre les balises <parameter> et </parameter>. Si aucun paramètre n’est nécessaire pour compiler le DataSet, cet élément ne doit pas être inclus dans le fichier de description XML.
  6. <parameter></parameter> Décrit un paramètre d’une requête SQL ou d’une procédure stockée, et précise les informations relatives à la saisie des paramètres dans l’Administration and Monitoring Console. Attributs :
    • Name le nom du paramètre. Il s’agit d’un attribut obligatoire. Il sera transmis à la requête SQL ou à la procédure stockée.
    • Type le type du paramètre. Il s’agit d’un attribut obligatoire. Valeurs possibles : Int, Date, String.
    • Prompt l’indication qui sera affichée lorsqu’un utilisateur saisit ce paramètre. Cet attribut est facultatif.
    • Default la valeur par défaut du paramètre avant que l’utilisateur ne saisisse une autre valeur. Il s’agit d’un attribut facultatif. Les paramètres de type Date peuvent avoir la valeur “now”, qui correspond à la date actuelle.
Par défaut, l’utilisateur saisit les valeurs des paramètres dans un champ de saisie. Si la valeur doit être choisie dans une liste, ajoutez l’élément <possiblevaluelist>.
  1. <possiblevaluelist></possiblevaluelist> Les éléments <possiblevaluelistitem /> représentent toutes les valeurs possibles d’un élément <parameter>.
  2. <possiblevaluelistitem /> Décrit l’une des valeurs possibles d’un paramètre. Attributs :
    • value valeur possible d’un paramètre. Cet attribut est obligatoire. Son type doit correspondre à celui du paramètre.
    • displayvalue la ligne qui sera affichée dans la liste. Cet attribut est facultatif. Si cette valeur est absente, l’attribut value sera affiché.