Report-Variablen
Voraussetzungen
- Erstellung eines Reports
- Zugriff auf die Settings-App
Report-Variablen für Grafana-Dashboards
Folgende Variablen, die für die Report-Erstellung relevant sind, können im Zuge der Bearbeitung eines Reports festgelegt werden. Darüber hinaus können grundsätzlich alle in Grafana festgelegten Variablen jeglichen Typs überschrieben werden.
-
Report-Variablen verwenden
Nutzen Sie Report-Variablen, um Ihre Reports dynamisch anzupassen.
Layout-Variablen
Layout-Variablen haben in der m2v-App den Typ "Layout" und spezifizieren z.B. das Layout der Kopfzeile eines Reports. Diese Variablen können nicht in Grafana, sondern lediglich in der m2v-App festgelegt werden.
| Variable | Beschreibung | Standardwert |
|---|---|---|
logo |
URL für Logo in Kopfzeile und Titelblatt | Cloud logo |
language |
Sprache von zugehörigen Reports (de oder en) |
en |
title |
Titel in Kopfzeile | Dashboard Titel |
subtitle |
Untertitel in Kopfzeile | Dashboard Untertitel |
companyInfo |
Firmenadresse | Info zur gewählten Firma |
coverTitle |
Titel auf Titelblatt | Dashboard Titel |
coverShowCompany |
Firmenadresse auf Titelblatt | false |
coverSubtitle |
Untertitel auf Titelblatt | Dashboard Beschreibung |
coverPreparedBy |
Informationen zum Autor | leer |
coverOrientation |
Ausrichtung Titelblatt portrait/landscape |
portrait |
footerInfo |
Freitext in der Fußzeile | leer |
tableLimit |
Maximale Datensätze für Tabellen | 50 |
csvDelimiter |
Trennzeichen der CSV Dateien | , |
csvDateformat |
Datumsformat für CSV Dateien | Sprachabhängig (siehe hier) |
showTimezone |
Zeitzone im Report anzeigen |
| Variable | Beschreibung | Gültige Werte | Standardwert |
|---|---|---|---|
printDate |
Druckdatum in Kopfzeile | true, false |
true |
headerCompanyInfoPlacement |
Platzierung Firmenadresse | left, middle, right |
left |
headerTitlePlacement |
Platzierung Titel | left, middle, right |
middle |
headerDatePlacement |
Platzierung Datum | left, middle, right |
right |
footerPageCountPlacement |
Platzierung Seitenzahl | left, middle, right |
right |
footerInfoPlacement |
Platzierung Freitext Fußzeile | left, middle, right |
left |
Panelspezifische Variablen
Panelspezifische Variablen haben in der m2v-App den Typ "Parameters" und beziehen sich auf die Darstellung des Dashboards innerhalb des Reports. Werden diese Variablen in der m2v-App spezifiziert, überschreiben sie automatisch namensgleiche Werte, die potenziell als Datenquelle zuvor in Grafana festgelegt wurden.
Jedes Panel kann, über die Verwendung bestimmter Variablen, als einzelnes Bild oder als Tabelle zusätzlich ausgegeben werden. Folgende Variablen stehen zur Verfügung:
| Variable | Auswirkung |
|---|---|
single |
Das Panel wird zusätzlich in groß auf einer eigenen Seite gedruckt |
newPage |
Nach diesem Panel wird ein Seitenumbruch erzeugt |
portrait |
Ändert die Orientierung der einzelnen Seite ins Hochformat, Standardmäßig Querformat |
csv |
Für dieses Panel wird eine CSV Datei erzeugt |
hidden |
Das Panel wird im Report nicht angezeigt |
tablePrint |
Für dieses Panel wird eine Tabelle erzeugt und an den Report angehangen |
tableLimit |
Bestimmt die Anzahl der Datensätze, die in der Tabelle im Report ausgegeben werden |
csvLimit |
Bestimmt die Anzahl der Datensätze, die in der erzeugten CSV Datei ausgegeben werden |
Benutzerdefinierte Variablen
Hinweis
Technisch bedingt muss für eine überschriebene Variable ein neues temporäres Dashboard angelegt werden. Dieses Dashboard wird nach erfolgreicher Report Generation wieder gelöscht.
In den Reportdetails besteht grundsätzlich die Möglichkeit, alle in Grafana festgelegten Variablen unabhängig von ihrem Typ zu überschreiben. Dies ermöglicht beispielsweise die Anpassung des Aggregationszeitraums der Werte, der Aggregationsfunktion oder anderer für verschiedene Zwecke verwendeter Variablen, ohne dass ein neues Dashboard erstellt werden muss.
Platzhalter für Metadaten
Ist der Report mit einer Maschine verknüpft, können die Meta Daten der Maschine in den Report-Variablen verwendet werden. Hierfür müssen Sie den Englischen Schlüssel der Meta Daten Definition in folgendes Schema in eine Variable einfügen: ${MetaData_KEY}. Wenn der Englische Schlüssel beispielsweise Location ist, heißt der entsprechende Eintrag ${MetaData_Location} (Leerzeichen im Schlüssel müssen mit _ ersetzt werden).