Vous pouvez créer une définition de rapport ou utiliser l'un des six fichiers de définition fournis avec IBM® Enterprise
Records et stockés dans une librairie de plan de fichiers.
IBM Enterprise
Records comprend six définitions de rapport qui offrent une vue statistique des activités de différents utilisateurs. Ces définitions sont ajoutées à la librairie de plans de fichiers (FPOS) via un module complémentaire installé avec le logiciel. Les fichiers figurent dans
Records Management/Report Definitions, mais seulement quand ils sont configurés manuellement. Pour plus d'informations sur la configuration, voir la rubrique Configuration des définitions de rapport dans le
IBM Enterprise
Records Installation and Upgrade Guide. Chaque définition de rapport est un document XML et définit les métadonnées suivantes pour le rapport :
- Titre du rapport
- Description du rapport
- Entrée d'aide du rapport
- Nom de la table de base de données du rapport
- Nom du modèle de rapport
- Paramètres du rapport
- Requêtes du rapport
Titre du rapport
Le Titre du rapport représente le titre du rapport affiché par IBM Enterprise
Records.
<setting
key="title" localizationKey="server.report_title.n">titre_rapport</setting>
Description du rapport
La description est le texte affiché par IBM Enterprise
Records, décrivant brièvement l'objet du rapport. Par exemple : "Ce rapport affiche uniquement les actions qui ont été effectuées après avoir activé l'audit sur une catégorie d'enregistrement, dossier, volume ou enregistrement."
<setting
key="desc" localizationKey="server.report_desc.n">description</setting>
Entrée d'aide du rapport
L'entrée d'aide correspond au texte qu'IBM Enterprise
Records affiche dans la zone d'aide du rapport. Par exemple, "Le rapport généré répertorie uniquement les actions qui ont été effectuées après avoir activé l'audit."
<setting
key="entryhelp" localizationKey="server.entryhelp.n">entrée_aide</setting>
Nom de la table de base de données du rapport
Le nom de la table est un nom de table de base de données que le moteur de génération de rapport IBM Enterprise
Records utilise pour extraire les résultats à partir du référentiel IBM Enterprise
Records.
Ce nom est également utilisé pour générer les résultats dans une table de base de données intermédiaire que les applications du rapport peuvent utiliser. Par exemple, ActionPerformed.
<setting
key="db_table_name">nom_table</setting>
Nom du modèle de rapport
Le nom_rapport représente le nom du modèle de rapport créé dans une application de rapports.
<setting key="reportName" localizationKey="server.report_name.n">nom_rapport</setting>
Paramètres du rapport
Définit les paramètres de rapport tels que les emplacements de plan de fichiers, les actions, les événements, les calendriers, les dates et les types d'entité, et s'ils sont requis. Pour définir des paramètres de rapport, procédez comme suit :
- Sous <object key="reportDefinition">, définissez <list
key="report parameters">, si nécessaire.
- Sous la clé de la liste des paramètres de rapport, définissez la clé de paramètre de nom symbolique, le cas échéant, pour chacun des critères de rapport.
- 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 doit faire une sélection.
- Encadrez chaque paire de noms symboliques et de clés de paramètres requises dans la balise suivante : <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 à accéder à un emplacement de la librairie de plans de fichiers.
- fileplan_name : un plan de fichiers dans la librairie de plans de fichiers (FPOS).
- ros_name : un nom de librairie d'enregistrements (ROS).
- user_name : le nom d'utilisateur a terminé les activités.
- start_date : la date de début des critères du rapport.
- end_date : la date de fin des critères du rapport.
- disposal_schedule : le planning d'élimination associé à une entité.
- hold_name : la mise en attente d'enregistrement associée à une entité.
Un rapport utilise également des types d'entité tels que des critères. Pour utiliser des types d'entité :
- 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é est une catégorie d'enregistrement (RecordCategory), un dossier d'enregistrement (RecordFolder), un volume (Volume) ou un enregistrement (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é précédemment.
- Entité est une catégorie d'enregistrement, un dossier d'enregistrement, un volume ou un enregistrement.
Les environnements localisés nécessitent
localizationKey.
Par exemple, si le rapport inclut des statistiques relatives aux dossiers et catégories d'enregistrement, cette section du fichier XML doit être similaire à l'exemple suivant :
<object key="property">
<setting key="symbolicName">rm_entity_type</setting>
<setting key="required">1</setting>
<list key="values'>
<object key="value">
<setting key="id">RecordCategory</setting>
<setting key="value" localization Key="server.report_1.RecordCategory">Record Category</setting>
</object>
<object key="value">
<setting key="id">RecordFolder</setting>
<setting key="value" localization Key="server.report_1.RecordFolder">Record Folder</setting>
</object>
</list>
</object>
Requêtes du rapport
Chaque rapport fourni avec
IBM Enterprise
Records définit une ou plusieurs requêtes afin d'interroger différents types d'entité tels que la catégorie d'enregistrement, le dossier d'enregistrement, le volume ou l'enregistrement. Pour définir une requête de rapport, procédez comme suit :
- Sous <object key="reportDefinition">, définissez <list key="report queries">.
- Sous la clé de la liste des requêtes de rapport, définissez la requête, le cas échéant, pour chacun des critères de rapport.
- Suivez chaque clé de paramètre de requête et définissez un paramètre pour type_entité_rm pour indiquer que la requête est destiné à un type d'entité spécifique (RecordCategory, RecordFolder, Volume ou Record). Le paramètre type_entité_rm est facultatif, si la requête s'applique à tous les types d'entité.
- Encadrez les clés de paramètre de chaque requête et type d'entité dans la balise suivante
tag: <object key="query"></object>.
Par exemple :
<list key="report queries">
<object key="query">
<setting key="sql">SELECT EV.LastModifier, EV.DateCreated, EV.ClassDescription, EV.AuditActionType,RC.RecordCategoryName AS EntityName, RMF.PathName, RC.Aggregation FROM (Event EV INNER JOIN RecordCategory RC ON EV.SourceObjectID = RC.ID)INNER JOIN RMFOLDER RMF on RC.parent=RMF.This WHERE EV.DateCreated >= {?start_date} AND EV.DateCreated <= {?end_date} AND EV.LastModifier = '{?user_name}' AND RC.this INSUBFOLDER '/{?fileplan_name}'</setting>
<setting key="my_entity_type">catégorie_enregistrement</setting>
</object>
<object key="query">
<setting key="sql">SELECT EV.LastModifier, EV.DateCreated, EV.ClassDescription, EV.AuditActionType,RF.RecordFolderName AS EntityName,RMF.PathName, RF.Aggregation FROM (Event EV INNER JOIN RecordFolder RF ON EV.SourceObjectID = RF.ID)INNER JOIN RMFOLDER RMF on RF.parent=RMF.This WHERE EV.DateCreated >= {?start_date} AND EV.DateCreated <= {?end_date} AND EV.LastModifier = '{?user_name}' AND RF.this INSUBFOLDER '/{?fileplan_name}'</setting>
<setting key="my_entity_type">dossier_enregistrement</setting>
</object>
<list>