Avant d'ajouter un rapport
à ReportDefinitions.xml, vous devez créer un modèle de rapport dans Crystal Reports Designer.
Procédure
Pour ajouter un rapport à ReportDefinitions.xml :
- A l'aide d'un éditeur XML, ouvrez ReportDefinitions.xml situé dans le répertoire<chemin_install_ier>\Config.
- Localisez la matrice du modèle de données que vous allez utiliser dans votre librairie de plans de fichiers. Le fichier xml contient une matrice pour les rapports DoD, les rapports DoD classifié, les rapports PRO et les rapports BASE.
- Ajoutez une balise de valeur (par exemple, <value>42</value>).
Cette valeur est un entier qui identifie le rapport que vous avez créé dans Crystal Reports Designer et est unique pour chaque rapport. Elle est égale au nombre existant de rapports plus 1.
- Dans <List key="ReportDefinitions">, ajoutez <object
key="reportDefinition"> pour le nouveau rapport. S'il existe un rapport existant similaire au rapport que vous venez de créer :
- Copiez la clé d'objet entière reportDefinition du rapport existant dans le fichier XML.
- Collez la clé d'objet copiée dans un autre emplacement du fichier XML.
- Modifiez la clé d'objet reportDefinition du nouveau rapport en modifiant ou en ajoutant des valeurs (selon les besoins) pour les balises suivantes.
n est le nombre que vous avez entré à l'étape 3 précédemment.
<setting
key="id">n</setting>.
<setting key="title"
localizationKey="server.report_title.n">nom_rapport</setting>, où nom_rapport représente le titre du rapport affiché par IBM® Enterprise
Records.
<setting
key="desc" localizationKey="server.report_desc.n">description</setting>,
où description représente le texte affiché par IBM Enterprise
Records, qui décrit brièvement l'objet du rapport. Par exemple, "Ce rapport liste les volumes électroniques ouverts/fermés au sein d'une période donnée".
<setting
key="reportName" localizationKey="server.report_name.n">nom_fichier.rpt</setting>,
où nom_fichier représente le nom du modèle de rapport créé dans Crystal Reports Designer.
<setting key="img">chemin relatif du fichier image</setting> Il s'agit d'une valeur facultative permettant d'insérer un graphique. Par exemple, images/action/report.gif.
- Pour exclure le nouveau rapport d'une librairie de plans de fichiers spécifique, entrez les balises suivantes :
<array key="excludedObjectStores">
<value>fpos</value> </array>
où fpos représente le nom de la librairie de plans de fichiers de laquelle le nouveau rapport est exclu.
Vous pouvez ajouter des balises de valeur supplémentaires afin d'exclure le rapport de plusieurs librairies de plans de fichiers.
- Ajoutez des critères de rapport, tels que des emplacements de librairies de plans de fichiers, des actions, des événements, des planifications et des dates.
- Sous <object key="reportDefinition">, ajoutez <list
key="properties">, le cas échéant. Si vous avez copié la clé d'objet reportDefinition à partir d'un rapport existant, alors <list key="properties:> existe.
- Sous la clé "property", ajoutez ou modifiez la clé de paramètre (setting key) de nom symbolique, le cas échéant, pour chacun des critères de rapport. Si vous avez créé des critères, ajoutez aussi les clés de paramètre de nom symbolique correspondant aux nouveaux critères.
Faites suivre chaque clé de paramètre de nom symbolique de cette balise : <setting key="required"> 0 ou 1 </setting>, afin d'indiquer si une valeur est nécessaire. 0 indique que l'utilisateur n'est pas obligé de faire une sélection ou d'entrer une valeur. 1 indique que l'utilisateur est obligé de faire une sélection ou d'entrer une valeur.
Encadrez chaque paire de noms symboliques et de clés de paramètres requises avec cette balise : <object key="property"> </object>.
Par exemple :
<object key="property"> <setting
key="symbolicname">nom_symbolique</setting>
<setting key="required">1</setting> </object>
où nom_symbolique représente le critère que vous venez de créer ou l'une des clés de paramètre suivantes :
- fileplan_browse - Ordonne à IBM Enterprise
Records d'autoriser l'utilisateur à se rendre jusqu'à un emplacement de la librairie de plans de fichiers.
- ros_browse - Ordonne à IBM Enterprise
Records d'autoriser l'utilisateur à se rendre jusqu'à un emplacement de la librairie des enregistrements.
- start_date - Date de début des critères du rapport.
- end_date - Date de fin des critères du rapport.
- application_type - Type d'enregistrement à utiliser comme critère (PDF, DOC, XLS et autres).
- security_category - Annotation de sécurité, telle que classifié, secret, confidentiel et autres, selon le modèle de données.
- review_decision - Décision faisant suite à une révision, notamment une approbation ou un rejet.
- action - Action effectuée sur une entité (par exemple, ouverture ou fermeture).
- disposal_schedule - Planning d'élimination associé à une entité.
- disposal_action - Action d'élimination programmée appliquée à une entité (par exemple, transfert, révision, transfert temporaire ou destruction).
- disposal_action_export - Action d'élimination appliquée à une entité à la suite d'une exportation.
- report_type - Ordonne à IBM Enterprise
Records d'activer les boutons d'option Summary ou Detailed.
- disposal_trigger - Evénement qui déclenche l'élimination d'une entité (par exemple, une date, la fermeture d'un conteneur ou un événement externe).
Pour ros_browse, security_category, disposal_action, disposal_action_export, review_decision et disposal_trigger, IBM Enterprise
Records récupère les valeurs par défaut de Content Engine au moment de l'exécution. Elles apparaissent dans un menu dans lequel vous pouvez sélectionner une valeur.
- Si le rapport utilise des types d'entité tels que des critères :
- Sous la clé "property", ajoutez le nom symbolique entity_type, suivi de la clé de paramètre "required" (1=requis, 0=non requis).
Par exemple :
<object key="property">
<setting key="symbolicname">entity_type</setting>
<setting key="required">1</setting>
- Ajoutez <list key="values"> à l'endroit où vous entrez les types d'entité qu'un utilisateur peut sélectionner en vue de leur inclusion dans le rapport. Par exemple :
<list key="values">
<object key="value">
<setting key="id">type_entité</setting>
<setting key="value" localizationKey=serve.report_n.type_entité">entité</setting>
</object>
où :
- type_entité représente RecordCategory, RecordFolder ou Record.
Vous pouvez inclure ces trois types d'entité, mais vous devez encadrer chacun d'eux par des balises <object key="value"> distinctes.
- n représente le nombre identifié à l'étape 3 plus tôt.
- entité représente Record Category, Record Folder ou Record.
Les environnements localisés nécessitent l'élément "localizationKey."
Par
exemple, si votre rapport inclut les statistiques relatives aux Catégories d'enregistrement
et aux Dossiers d'enregistrement, cette section du fichier XML est similaire à l'exemple
suivant :
<object key="property">
<setting key="symbolicname">entity_type</setting>
<setting key="required">1</setting>
<list key="values">
<object key="value">
<setting key="id">RecordCategory</setting>
<setting key="value" localizationKey=serve.report_42.RecordCategory">Record Category</setting>
</object>
<object key="value">
<setting key="id">RecordFolder</setting>
<setting key="value" localizationKey=serve.report_42.RecordFolder">Record Folder</setting>
</object>
</list>
</object>
- Si le rapport utilise des actions de classification :
Sous la clé "property", ajoutez le nom symbolique classification_action, suivi de la clé de paramètre "required" (1=requis, 0=non requis).
Par exemple :
<object key="property">
<setting key="symbolicname">classification_action</setting>
<setting key="required">1</setting>
Ajoutez <list key="values"> à l'endroit où vous entrez les actions de classification qu'un utilisateur peut sélectionner en vue de leur inclusion dans le rapport. Par exemple :
<list key="values">
<object key="value">
<setting key="id">Action_Classification</setting>
<setting key="value" localizationKey=serve.report_n.Action_Classification">Action_Classification</setting>
</object>
où :
- Action_Classification représente Upgrading (Mise à niveau), Downgrading (Diminution de niveau) ou Declassification (Déclassification). Vous pouvez inclure ces trois actions de classification, mais vous devez encadrer chacune d'elles par des balises <object key="value"> distinctes.
- n représente la valeur "id" de ce rapport dans la matrice correspondant au modèle de données.
Les environnements localisés nécessitent l'élément "localizationKey."
Par exemple,
si votre rapport inclut les statistiques relatives aux actions de diminution de niveau et de
déclassification, cette section du fichier XML est similaire à l'exemple
suivant :
<object key="property">
<setting key="symbolicname">classification_action</setting>
<setting key="required">1</setting>
<list key="values">
<object key="value">
<setting key="id">Downgrading</setting>
<setting key="value" localizationKey=serve.report_42.Downgrading">Downgrading</setting>
</object>
<object key="value">
<setting key="id">Declassification</setting>
<setting key="value" localizationKey=serve.report_42.Declassification">Declassification</setting>
</object>
</list>
</object>
- Une fois que vous avez entré tous les critères du rapport :
- Fermez <list key="properties"> avec la balise </list>.
- Fermez <object key="reportDefinition"> avec la balise </object>
- Enregistrez le fichier XML.
- Redémarrez le serveur d'applications Web sur lequel IBM Enterprise
Records s'exécute afin que les modifications soient prises en compte.
Résultats
Une fois que vous en avez fini avec les modifications, la section de clé d'objet reportDefinition
s'apparente à l'exemple suivant :
<object key="reportDefinition">
<setting key="id">22</setting>
<setting key="title" localizationKey="server.report_title.42">Rapport
de mise à jour de classification Records Manager</setting>
<setting key="desc" localizationKey="server.report_desc.42">Ce rapport dresse la liste des entités
qui ont changé de classification pendant une période spécifique.</setting>
<setting key="url">RMViewReport.jsp</setting>
<setting key="img">images/action/report.gif</setting>
<setting key="reportName" localizationKey="server.report_name.42">Classification Update.rpt</setting>
<list key="properties">
<object key="property">
<setting key="symbolicName">fileplan_browse</setting>
<setting key="required">0</setting>
</object>
<object key="property">
<setting key="symbolicName">start_date</setting>
<setting key="required">1</setting>
</object>
<object key="property">
<setting key="symbolicName">end_date</setting>
<setting key="required">1</setting>
</object>
<object key="property">
<setting key="symbolicName">report_type</setting>
<setting key="required">0</setting>
</object>
<object key="property">
<setting key="symbolicname">entity_type</setting>
<setting key="required">1</setting>
<list key="values">
<object key="value">
<setting key="id">RecordCategory</setting>
<setting key="value" localizationKey=serve.report_42.RecordCategory">Record
Category</setting>
</object>
<object key="value">
<setting key="id">RecordFolder</setting>
<setting key="value" localizationKey=serve.report_42.RecordFolder">Record Folder</setting>
</object>
<object key="property">
<setting key="symbolicname">classification_action</setting>
<setting key="required">1</setting>
<list key="values">
<object key="value">
<setting key="id">Downgrading</setting>
<setting key="value" localizationKey=serve.report_42.Downgrading">Downgrading</setting>
</object>
<object key="value">
<setting key="id">Declassification</setting>
<setting key="value" localizationKey=serve.report_42.Declassification">Declassification</setting>
</object>
</list>
</object>
</list>
</object>
</list>
</object>