Preconditions
- How to Create a Report
- Access to the Settings App
Report Variables for Grafana Dashboards
The following variables that are relevant for report creation can be set in the context of editing a report. Additionally, all variables of any type defined in Grafana can be overridden.
-
Use Report Variables
Use report variables to dynamically adjust your reports.
Layout Variables
Layout variables have a type of "Layout" in the m2v app and specify, for example, the layout of the header section of a report. These variables cannot be set in Grafana but only in the m2v app.
| Variable | Description | Default Value |
|---|---|---|
logo |
URL for logo in header and title page | Cloud logo |
language |
Language of corresponding reports (de or en) |
en |
title |
Title in header | Dashboard Title |
subtitle |
Subtitle in header | Dashboard Subtitle |
companyInfo |
Company address | Info about the selected company |
coverTitle |
Title on title page | Dashboard Title |
coverSubtitle |
Subtitle on title page | Dashboard Description |
coverPreparedBy |
Information about the author | empty |
coverOrientation |
Orientation of title page portrait/landscape |
portrait |
tableLimit |
Maximum number of records for tables | 50 |
csvDelimiter |
Delimiter for CSV files | , |
csvDateformat |
Date format for CSV files | Language-dependent (see here) |
| Variable | Description | Valid Values | Default Value |
|---|---|---|---|
printDate |
Print date in header | true, false |
true |
headerCompanyInfoPlacement |
Placement of company address | left, middle, right |
left |
headerTitlePlacement |
Placement of title | left, middle, right |
middle |
headerDatePlacement |
Placement of date | left, middle, right |
right |
footerPageCountPlacement |
Placement of page count | left, middle, right |
right |
Panel-Specific Variables
Panel-specific variables have a type of "Parameters" in the m2v app and specify, for example, whether a panel should be printed as an image or as a table. The following variables are available:
| Variable | Effect |
|---|---|
single |
The panel is printed separately on its own page |
portrait |
Changes the orientation of the single page to landscape, default portrait |
csv |
The panel is printed as a table and a CSV file is generated |
hidden |
The panel is not displayed in the report, standard for CSV-exported panels |
donthide |
Overrides the default hiding of a panel when it is exported to CSV |
Custom Variables
Note
Technically speaking, a new temporary dashboard must be created for an overridden variable. This dashboard will be deleted after successful report generation.
In the Report Details section, you have the option to override all variables defined in Grafana regardless of their type. This allows you, for example, to adjust the aggregation time range of values, the aggregation function, or other variables used for different purposes, without creating a new dashboard.