Das Chart-Widget
Konfigurationsschlüssel | home |
Chart-Widgets können Statistiken grafisch darstellen. Die Darstellung kann als Balken-, Torten- oder Liniendiagramm erfolgen.
Abb.: Die initialen Chart-Widgets im Home Dashboard
Als Datenbasis für das Chart-Widget dient eine Berichtsdefinition. Deren zuletzt erstellter Bericht wird in der Statistik angezeigt. Voraussetzung dafür ist, dass in der Berichtsdefinition als Ausgabeformat CSV festgelegt ist. In KIX Pro ist auch JSON möglich. Andere Ausgabeformate können vom Chart-Widget nicht verarbeitet werden.
Das periodische Erstellen der Berichte und damit die Aktualisierung der Statistiken erfolgt durch den initialen Job Periodic Reports. Auf diese Weise werden auch die Charts im Home Dashboard erzeugt.
Die Statistik wird nicht angezeigt, wenn der Bericht nicht ausgewertet werden kann. Der Inhalt im Widget ist dann leer. Es wird lediglich der Hinweis "No report available" angezeigt. Gründe dafür können sein:
Es existiert kein Bericht zur gewählten Berichtsdefinition
Die Berechtigungen für den Bericht fehlen
Die Berichtsdaten konnten nicht ausgewertet werden
Der Bericht liegt nicht im CSV-Format (oder JSON) vor
Die initialen Chart-Widgets sind in die Konfiguration des Home Dashboards eingebettet (SysConfig-Schlüssel Home). Sie befinden sich innerhalb des Konfigurationsblocks "content:[...]".
Jedes Chart-Widget besteht aus einem Widget-Rahmen und der Widget-Konfiguration, welche wiederum die Konfiguration des Chart-Widgets nebst Angaben zur Datenbasis (Berichtsdefinition) und zur Formatierung des Charts (CSV Mapping) beinhaltet.
Abb.: Konfiguration des Chart-Widgets Anzahl offener Tickets nach Prioritäten im Konfigurationsschlüssel des Home Dashboards
Die Konfiguration des Chart-Widgets benötigt folgende Parameter:
Abb.: Konfigurationsparameter im Chart-Widget
Parameter | Beschreibung |
|---|---|
reportDefinitionID | Die ID der Berichtsdefinition (Datenbasis des Charts) Sie können die ID ändern, um auf einen eigenen Bericht zu verweisen. Geben Sie die ID der entsprechenden Berichtsdefinition an. |
reportOutputFormat | Das Ausgabeformat des zu verwendenden Berichts gemäß Berichtsdefinition. |
useReportTitle | Verwendung des Namens der Berichtsdefinition als Widget-Titel, sonst Titel aus Widget-Konfiguration |
formatConfiguration | Spezifische Konfiguration für das Ausgabeformat Die Angaben erfordern detaillierte Kenntnisse der Berichtsdefinition (z. B. Ergebnis des Berichts, welche Daten in welcher Form enthalten sind). Nachfolgend für CSV:
|
Tipp
Die Parameter (Attribute) der Widget-Konfiguration finden Sie unter: Allgemeine Widget-Attribute
Die Chart-Konfiguration definiert die Darstellung des Charts. Nachfolgend aufgeführt sind die initial verwendeten Konfigurationsparameter. Weitere Parameter finden Sie auf unter: https://www.chartjs.org/docs/latest/configuration/.
Abb.: Parameter der Chart Konfiguration
Parameter | Beschreibung |
|---|---|
type | Festlegung des Diagrammtyps
|
options | Enthält Optionen zur Anzeige der Legende im Widget und zur Skalierung der X/Y-Achsen. Weitere Parameter sind möglich.
|
Konfigurationsschlüssel | default-color-configuration |
Sie können die in den Diagrammen verwendeten Farben individuell festlegen, um sie bswp. an Ihre Corporate Identity oder an die Farben der Ticketpriorität anzupassen.
Öffnen Sie dazu den oben erwähnten Konfigurationsschlüssel. Ändern Sie die Farbangaben nach Bedarf und/oder reduzieren Sie die verwendeten Farben. Sie können die Farben als Hexadezimalzahlen (#8D23A8) oder die CSS-Farbnamen ( z. B.: lightcoral) angeben.
Die Verwendung von Farben wird in der angegebenen Reihenfolge von oben nach unten priorisiert.
Abb.: Geänderte Farbangaben für Charts
Sie können eigene Berichte erstellen und als Statistik in einem Chart-Widget bereitstellen. Konfigurieren Sie dazu eine Berichtsdefinition mit Ausgabeformat CSV.
Soll der Bericht in regelmäßigen Zeitabständen automatisch erstellt und aktualisiert werden, aktivieren Sie in der Berichtsdefinition die Checkbox Periodische Erstellung.
Initial erfolgt die Erstellung periodischer Berichte durch den Job Periodic Reports. Alternativ können Sie einen eigenen Job dafür anlegen.
Ist die Checkbox nicht aktiviert, muss der Bericht manuell oder durch einen anderen event- oder zeitbasierten Job erzeugt und aktualisiert werden.
Geben Sie in der Berichtsdefinition unter Max. Reports an, wie viele Berichte vorgehalten werden sollen. Dadurch werden überzählige, ältere Berichte automatisch gelöscht.
Welcher Bericht in welchem Chart-Widget angezeigt wird und wie die grafische Darstellung erfolgt, ist in der Konfiguration des jeweiligen Widgets definiert.
Die Personalisierung des Home Dashboards in KIX Start lässt keine Auswahl der anzuzeigenden Berichte zu. Für die Anzeige eigener Berichte muss daher die Konfiguration eines der bestehenden Chart-Widgets manuell geändert werden:
Navigieren Sie im Admin Modul zu und öffnen Sie den Konfigurationsschlüssel .
Optional: Kopieren Sie den Quellcode im Feld Wert in einen externen JSON-Editor, um ihn besser editieren zu können.
Navigieren Sie im Konfigurationsblock
content:[...]zum Konfigurationsblock eines der 3 Chart-Widgets:Offene Tickets nach Priorität:
"instanceId": "home-dashboard-ticket-chart-widget-priorities" [...]Offene Tickets nach Status:
"instanceId": "home-dashboard-ticket-chart-widget-states" [...]Erstellte Tickets innerhalb der letzten 7 Tage:
"instanceId": "home-dashboard-ticket-chart-widget-new" [...]
Ändern Sie innerhalb der Chart-Widget-Konfiguration die ID (Nummer) der Berichtsdefinition.
Geben Sie dazu am Parameter
reportDefinitionIDdie ID der Berichtsdefinition an, deren Daten im Chart angezeigt werden sollen. Damit ändern Sie den Verweis auf die Datenbasis des Charts.
Achtung
Durch Angabe der ID im Parameter
reportDefinitionIDwird global auf eine Berichtsdefinition verwiesen, ohne Prüfung von Berechtigungen.Die Verantwortung für die Bereitstellung an berechtigte Personengruppen obliegt dem Administrator bzw. dem Report Manager!
Weitere wichtige Infos zu Rollen und Berechtigungen von Berichten finden Sie unter: Rollen und Berechtigungen für das Berichtswesen
Die ID einer Berichtsdefinition können Sie der Statuszeile im Fußbereich Ihres Browserfensters entnehmen. Führen Sie dazu den Mauszeiger über eine Reportdefinition.
Optional können Sie im Parameter
chartConfiguration:{...}die Darstellung des Charts ändern.
Weiterführende Informationen zu den Konfigurationsparametern finden Sie unter: Parameter des Chart-Widgets und Parameter der Chart-Konfiguration.
Optional können Sie das CSV Mapping im Abschnitt
formatConfiguration:{...}anpassen.Minimieren Sie den Quellcode im JSON-Editor und kopieren Sie ihn zurück ins Feld Wert des Konfigurationsschlüssels.
Speichern Sie Ihre Änderungen und klicken Sie in der Übersicht der Konfigurationsschlüssel auf , um die Ansicht im Home Dashboard zu aktualisieren. Danach kann das Chart-Widget den Bericht als Statistik darstellen.