Développez vos rapports en utilisant le modèle fourni par Centreon

Utilisation du template generic_component

Pour assurer la compatibilité des rapports que vous développez avec Centreon MBI, vous devez démarrer le développement de tous vos rapports en utilisant le modèle que nous fournissons. Ce modèle s’appelle “generic_component_script.rpttemplate” et est stocké dans “/usr/share/centreon-bi/Resources/templates” (par défaut). Il est indispensable car il rajoute automatiquement du script nécessaire au fonctionnement de votre rapport sur notre plateforme.

Pour être en mesure d’utiliser ce modèle, vous devez :
  • Récupérer le fichier sur le serveur de reporting et le placer dans le dossier “Resources/template” de votre projet BIRT : “/Resources/templates/generic_component_script.rpttemplate”
  • Faire un clique droit sur ce fichier et cliquer sur “Register Template with New Report Wizard”
../_images/registerTemplate.png
  • Pour chaque nouveau rapport que vous créez, faites New->Report, choisissez un nom puis cliquez sur “Next” pour accéder à la fenêtre des modèles
  • Sélectionnez alors le modèle appelé “Component Template” puis cliquez sur “Finish”
../_images/componentTemplate.png

Définir la structure du projet

Il est important d’identifier et définir des normes pour :

  • l’arborescence des rapports et ressources
  • le nommage des dossiers et fichiers
  • le nommage de composants dans les bibliothèques, modèles et rapports.

Lorsque des normes basiques comme celles-ci ne sont pas respectées, il devient très difficile de maintenir et faire évoluer les projets

Les prochains points de ce chapitre abordent les normes définies depuis Centreon MBI 1.5.0.

Votre rapport est près à être développé et sera compatible avec Centreon MBI.

Rapports (RPTDESIGN)

  • Chaque rapport est stocké dans un dossier ou sous-dossier dont la racine est le dossier « reports ». Les noms de ces dossier sont définis selon le type des statistiques traitées :
    • Capacité
    • Disponibilité
    • Performance
  • Les rapports stockés à la racine du répertoire « reports » sont dépréciés depuis la version 1.5 de Centreon MBI
  • Chaque composant d’un rapport (composant graphique, dataset, …) est issu d’une bibliothèque BIRT. Le rapport réalise en majeure partie l’intégration de ces différents composants
  • Chaque rapport est créé à partir d’un modèle de rapport BIRT. Ce modèle contient un « scripting » facilitant la gestion des paramètres à sélection de valeurs multiples ainsi que la gestion des thèmes.

Ressources

Le dossier contenant les ressources partagées de Centreon MBI est organisé en sous-répertoires :

  • images : contient les images utilisées dans le rapport
  • templates : contient les modèles de rapports BIRT (.rpttemplate) utilisés pour la création de nouveaux rapports
  • translations: contient les fichiers de traduction des rapports
  • components : contient toutes les bibliothèques BIRT (.rptlibrary) organisées en sous-dossier selon une logique similaire au rapports (capacité, …).

Bibliothèques de composants

Certaines bibliothèques sont stockées directement dans le dossier « components », sans aucune classification par sous-dossiers. Ces fichiers contiennent des composants ré-utilisés dans des rapports mais également dans d’autres bibliothèques :

  • « datasources » : contient toutes les sources de données utilisées dans le projet. Évitez de définir des « data sources » dans plusieurs fichiers afin de simplifier la maintenance et la mise en production
  • « parameters » : contient tous les paramètres de rapports utiles
  • « masterpages » : stocke les différents master qui sont ré-utilisés dans les rapports

Du fait du grand nombre de composants créés dans chaque bibliothèque, il peut être compliqué de naviguer à travers ces fichiers pour retrouver un composant. Pour simplifier cette recherche, il est conseillé de suivre cette méthode :

  • Quel type de statistique recherchez vous ?

    ◦ Capacité ? Performance ? Disponibilité ? Ouvrez le sous-dossier correspondant à votre besoin.

  • Sur quel type d’objet souhaitez vous faire le rapport ?

    ◦ Hôte ? Un groupe d’hôtes ? Plusieurs groupes d’hôtes ? Vous trouverez cette information dans le nom du fichier « rtplibrary ».

  • Avez-vous besoin d’un « data set » ? Avec quels paramètres ?

    ◦ Tous les « data sets » sont listés dans le panneau « data explorer »

    ◦ le nom de chaque « data set » est préfixé d’un code. Chaque digit de ce code concerne un objet (hostgroup, host, service category, host category, metric, timeperiod, …) et varie de 0 à 2 :

    ▪ 0 : l’objet n’est pas utilisé en tant que paramètre

    ▪ 1 : une seule valeur est attendue

    ▪ 2 : une liste de valeur est attendue

  • Avez-vous besoin d’un composant graphique ? Avec quels paramètres ?

    ◦ Tous les composants graphiques sont listés dans le sous-menu « Report Items » de l’onglet « outline »

    ◦ Le nom de chaque composant commence avec un codage similaire aux noms des « data sets »

    ◦ Le nom de chaque composant est suffixé avec le type du composant : « chart », « table », « text », etc...

Warning

Attention, AUCUNE modification ne doit être faite sur les rapports et biblithèques standards.