Deploying a report on Centreon MBI¶
Centreon MBI provides scheduling and publishing functionality for BIRT reports. Once you have designed your report, you will not need to use Eclipse BIRT to generate your reports. Non-technical users will be able to run the reports in a few clicks from the Centreon graphical user interface (GUI) without having to resort to Eclipse BIRT.
Steps for deploying a report on Centreon MBI:
Create the XML file describing the required parameters¶
Each RPTDESIGN file that you create contains different report parameters. To display them in the Centreon MBI GUI and be able to use them, you must define an XML file that will dynamically generate a parameter tab.
When creating a new report design on the interface, you must associate it with the XML parameter file. Three types of objects can be defined in this XML file:
- Text tags to allow users to type in their own text: <text></text>
- Selection tags: <select></select>
- Multi-select tags: <multiselect></multiselect>.
Each of these sets of markup tags has several possible attributes:
|id||Name of the parameter in the report (report parameter)||X||X||X|
|title||Description field displayed next to the parameter||X||X||X|
|data||Data to display in the parameter||X||X|
|size||Size of the text field||X|
Below are the possible values for the data attribute:
- liveservice = time period
Single- and multiple-selection lists are restricted through Centreon ACLs. Users with restrictions on Centreon resources will also be restricted on the Centreon MBI interface.
If you want to use our default date picker and use the date parameter (cyclical or on-demand) in your report, you must use the two “known” parameters, “dateStart” and “dateEnd”.
Below is an example of an XML file (Host-detail-2):
<?xml version="1.0" encoding="iso-8859-1"?> <objects> <select id="portrait_master_logo" data="logo" title="Portrait master page logo"/> <select id="landscape_master_logo" data="logo" title="Landscape master page logo"/> <select id="liveserviceID" data="liveservice" title="Select reporting live service" /> <text id="evolutionInterval" title="Number of month to show in trend graphs" size="5"/> <select id="One-hostID" data="host" title="Select the host to report" /> <select id="One-servicecategoryID_cpu" data="servicecategorie" title="Service category containing CPU service(s)" /> <multiselect title="Filter on CPU metrics to INCLUDE" id="metricNAME_cpu" data="metric"/> <multiselect id="servicecategoryID_storage" data="servicecategory" title="Service category containing Storage service(s)" /> <multiselect title="Filter on Storage metrics to EXCLUDE " id="metricNAME_storage" data="metric"/> <select id="One-servicecategory_memory" data="servicecategorie" title="Service category containing Memory service(s)" /> <multiselect title="Filter on Memory metrics to INCLUDE" id="metricNAME_memory" data="metric"/> </objects>
Deploy the report¶
On the reporting server¶
Copy your report design to the reporting server. The “reports” and “Resources” folders are found in the main Centreon MBI folder. The directory tree for your reports and resources must be same as in your Eclipse BIRT project.
On the monitoring server¶
In the “Reporting > Business Intelligence > Report designs” menu on Centreon, add the new report design, and define the following properties:
- A name for the report design
- The report location on the reporting server (relative path under /usr/share/centreon-bi/reports)
- An XML source file that will describe the report parameters of the previously created report design.
Running the report job¶
In the menu “Reporting > Business Intelligence > Jobs”, define a job to run your report design, and fill in all the specific report parameters.