Reports
In order to be able to use DataForge reporting, it is mandatory that the Zabbix server integration to which the user belongs has an s3 object storage configured.
The specific data that can be accessed depends on the permissions of the service user. DataForge Users with the appropriate permissions are capable of creating reports.
To receive the configured reports, you must subscribe to them.
There are two states in which a report card can be:
- Blue header and icons: The report is not subscribed.
- Green header and icons: The report is subscribed.
Create a new report
To create a new report, you must be logged in as (or impersonate) a DataForge user with the requisite permissions. Navigate to Reporting > Reports and click the blue plus:
- Name: Specify the name of the report.
- DataForge User group: Choose a DataForge user group, which defines the accessible data from Zabbix.
After completing the form, click Create.
Report configuration
The report configuration offers a variety of options:
- Name: The name of the report.
- Short Description: Configure the short description.
- Detailed Descrition: Configure the detailed description.
- Schedule mode: Determines the period of fetched data and the interval at which the report is sent out.
- Time of day: Specifies the delivery time.
- Text Items Limit: Specifies the maximum number of text items displayed in the report, with the most recent entries considered first.
- Problems Limit: Defines the maximum number of problems shown in the report, with the most recent entries considered first.
- Include table of contents page: Select whether the table of contents should be displayed in the PDF report or not.
- Widgets: Add and configure widgets in this section.
- JSON-Tranformers: Add JSON transformers to transform the JSON file structure. A JSON transformer will not affect the rendered PDF report.
Schedule mode
This setting defines the interval at which the report is generated and sent out.
- Hourly: Each full hour.
- Daily: Once a day at a user-defined time.
- Weekly: Weekly on a user-defined day and time.
- Monthly: Monthly at the first of the month.
- Quarterly: Quarterly, with four periods:
- January to March; Sent out on April 1st.
- April to June; Sent out on July 1st.
- July to September; Sent out on October 1st.
- October to December; Sent out on January 1st.
- Yearly: Annually on January 1st.
The schedule always utilizes data from the last completed interval, even if Render now is used.
Example:
- Schedule mode: Weekly
- Day of week: Monday
If Render now is used on a wednesday, DataForge will retrieve all recorded data from the last completed cycle, from monday before last to last monday.
Add widgets to the report
Click Add Widget to open the selection of widget types to add:
Add a widget to the list by clicking on the widget, the widget will show up in the widget section. It is possible to add multiple widgets and to a rearrange them. DataForge’s Reporting will take the widget order into account, as it determines the order of the widgets in the rendered report. If new widgets were added a Save button will appear in the top right corner. To save the changes, click Save:
After saving the widget selection you can configure the widget further by clicking the settings icon, or delete is by clicking the delete icon. When deleting a widget, make sure to Save the changes.
More information about and which data the various widgets can retrieve is covered in the Widgets chapter.
Clone reports
Reports can be created by cloning an existing report. To clone a report, access the context menu of the report and select Clone.
The new report requires a name, and to complete the cloning process, click Clone. Afterward, the cloned report will appear in the list.
Delete reports
To delete a report, open the context menu and select delete. DataForge will prompt you to confirm your decision before proceeding with the deletion. Once confirmed, the report disappears from the list and is deleted.