Leitfaden für das Dashboard


Dieser Artikel soll einen Überblick über das Thema Dashboard geben.


Anmelden und Erstellen eines neuen Dashboards

Benutzer können sich mit ihren persönlichen Anmeldedaten am Dashboard anmelden, wenn der Benutzer die entsprechende Rolle hat. Weitere Informationen zu Rollen und Rollen für das Dashboard insbesondere: https://tim-doc.atlassian.net/wiki/spaces/DE/pages/228525411

Es ist auch möglich, sich über das System in das Dashboard einzuloggen, indem Sie auf das Symbol "Dashboard" in der linken Seitenleiste klicken. Ein Klick auf die Schaltfläche führt zu einer Weiterleitung und automatischem Login in das Dashboard. Die Schaltfläche ist nur sichtbar, wenn der Benutzer die entsprechende Rolle hat.

Einmal im Dashboard eingeloggt, ist es möglich, die angezeigten Informationen für den Benutzer zu individualisieren. Ein neues Dashboard kann generiert werden, indem Sie im Menü "Dashboards" "Neu" auswählen.

Es erscheint ein Popup-Fenster mit der Aufforderung, einen Namen für das neue Dashboard einzugeben. Best Practices haben gezeigt, dass jedes Dashboard und spätere Widgets ein individuelles Label erhalten sollten. 

Sobald Sie auf die Schaltfläche "OK" im Popup-Fenster klicken, erscheint das Dashboard auf der linken oberen Seite.

Einmal erstellte Widgets können dem Dashboard hinzugefügt werden.


Hinzufügen und Erstellen von Widgets 

Ein Dashboard kann beliebig viele Widgets enthalten. Ein Widget kann fast jede Information anzeigen und muss von einem Dashboard-Administrator definiert werden. Es ist nicht möglich, ein Konsolen-Widget hinzuzufügen (mit dem alle vorhandenen Informationen verarbeitet werden können), wenn der aktuelle (angemeldete) Benutzer keine Administratorrechte hat.

Weitere Informationen zu den Diagrammtypen und Strukturen, die im System verwendet werden können, finden Sie in den folgenden Informationen: https://tim-doc.atlassian.net/wiki/spaces/DE/pages/228229895

 

Die Entwicklung von Widgets erfordert Kenntnisse in SQL, die auch den Standards von MySQL oder Oracle SQL oder MSSQL-Syntax entsprechen. Für weitere Informationen, welche SQL-Syntax verwendet wird, wenden Sie sich bitte an den Ansprechpartner. 

SELECT lastname, email FROM view_identity WHERE identityType = 'user';

In diesem Beispiel bietet das Widget eine Übersicht über alle vorhandenen Benutzer im System. Bitte beachten Sie die https://tim-doc.atlassian.net/wiki/spaces/DE/pages/228164844 , um auf weitere Beispiele zuzugreifen.

Ein Widget, das die gewünschten Inhalte bereitstellt, kann gespeichert und schließlich anderen Nutzern zu ihrem eigenen Vorteil zugänglich gemacht werden. Um ein neues Widget zu erstellen, klicken Sie auf "Widgets hinzufügen". und wählen Sie "Konsole". 

Der Dashboard-Pool wird erweitert und ein leeres Widget angezeigt. In den Leerraum der Konsole wird die SQL-Anweisung "SELECT lastname, email FROM view_identity WHERE identityType = 'user';" eingefügt. Wenn Sie auf die Schaltfläche 'Ausführen' klicken, wird die Anweisung ausgeführt und das Ergebnis der Abfrage angezeigt. 


So speichern Sie ein Widget

Um ein Widget zu speichern, klicken Sie auf die Schaltfläche "Save a Widget". 

Dem Widget muss ein benutzerdefinierter Name gegeben werden. In diesem Beispiel heißt das Widget "All Users".

Unter dem Menü 'Add Widgets' wird das neu erstellte Widget angezeigt und kann ausgewählt werden.


Layout und Anordnung

Mehrere Widgets können dem Dashboard hinzugefügt werden. Die Anordnung der Widgets kann automatisch durchgeführt werden, indem das gewünschte Layout aus dem Menü ausgewählt wird, wie in der Vorschau gezeigt. Die Layoutauswahl wirkt sich immer auf das Design des Dashboards aus, auf das derzeit zugegriffen wird.

Wenn sich ein Widget im Dashboard nicht ordnungsgemäß befindet, kann es problemlos auf eine andere Kachel verschoben werden. Die genaue Größe und Form des Widgets wird dann entsprechend dem vordefinierten Layout festgelegt. Zusätzlich ist es möglich, das Widget per Drag & Drop abzulegen, bis es sich in der gewünschten Position befindet. In diesem Beispiel wird das untere linke Widget 'cockpit-w2' per Drag & Drop auf die rechte Seite gezogen. 

 


Widget-Menü

Symbol-Funktion

Symbol

Funktion

Symbol

Funktion

Mit dieser Schaltfläche im Menü können die Widget-Informationen grafisch in einem Diagramm dargestellt werden.

Diese Schaltfläche im Menü setzt den gesamten Inhalt des Widgets in eine einfache Tabellenansicht zurück.

Diese Schaltfläche im Menü exportiert den gesamten Inhalt des Widgets in eine einzige Datei im Excel-Format.

Diese Schaltfläche ändert die Größe des Widgets, das mit der größtmöglichen Breite angezeigt werden soll.

Diese Schaltfläche öffnet den Druckerdialog des lokalen Computers.

Mit dieser Schaltfläche kann der Benutzer den Diagrammtyp konfigurieren.

Mit dieser Schaltfläche kann der Benutzer ein Widget aus dem Dashboard entfernen oder löschen.

 


Grafische Analyse von Widgets

Möchte der Nutzer die Widget-Informationen grafisch darstellen, kann dies einfach und flexibel umgesetzt werden. Für eine korrekte Umsetzung müssen x- und y-Achsen erstellt werden. Im aktuellen Beispiel ist dies nicht möglich, da eine Achse nicht allein auf der Grundlage von Entitäten wie "Nachname" und "E-Mail" erstellt werden kann. Um das Diagramm zu erstellen, muss ein neues Widget generiert werden, das anzeigt, wie viele Benutzer an jedem Wochentag generiert wurden.

 

SELECT DATENAME(weekday,creationtime) AS Tag, COUNT(DATENAME(weekday,creationtime)) AS NUMBER FROM view_identity GROUP BY DATENAME(weekday,creationtime);​

 

Diese kann wie gewohnt gespeichert und dann dem Dashboard hinzugefügt werden.

Wenn Sie das Widget ausführen, wird die Anzahl der Benutzer zurückgegeben, die am jeweiligen Wochentag erstellt wurden.

Ein Klick auf die Schaltfläche Diagramm öffnet eine Konfiguration für das Diagramm, in der die Werte für die x- und y-Achse zugewiesen werden können.

Nach dem Zuweisen der Werte wird durch Klicken auf die Schaltfläche "Zeichnen" das Diagramm angezeigt.

Als nächstes kann das Diagrammsymbol / die Diagrammfunktion verwendet werden, um die x- und y-Achse einzustellen. Wenn ein bestimmter Diagrammtyp gewünscht wird, wird dieser über die Konfigurationseinstellungen des Widgets geändert. Wenn eine Analyse als ungültig erachtet wird, weil ein Wert zu weit außerhalb der Norm liegt, kann dies durch Auswahl und Löschung der entsprechenden Gruppe aus der Legende entfernt werden.

 


Arbeiten mit Variablen

Das Dashboard ermöglicht die Anzeige von Widgets basierend auf der Auswahl des Werts einer bestimmten Variablen. Zum Beispiel sollte im ersten Beispiel nicht jeder Benutzer vom Widget angezeigt werden. Vielmehr sollte der Benutzer die anzuzeigenden Informationen auswählen können. Um diese Funktion zu aktivieren, muss das Widget wie folgt geändert werden:

SELECT lastname, email FROM view_identity WHERE identityType = :identType;

 

Innerhalb des Dashboards werden die angezeigten Variablen immer durch ": Variablenname" identifiziert.

Im zweiten Schritt wird der gewünschte Inhalt der Variablen definiert. Dazu müssen folgende Menüpunkte ausgewählt werden: Dashboards → Einstellungen → Variablen

Mit einem Klick auf den Button "Add Variable" wird ein Eingabefeld angezeigt, welches die Definition der Variablen ermöglicht. Folgende Felder stehen nun zur Verfügung:

Feld

Beschreibung

Feld

Beschreibung

Name

Geben Sie hier den Namen der Variablen ein.

Type

Dies zeigt an, ob die Ausgabe als Buchstaben, Zahlen oder Datumsangaben formatiert ist.

Returns

Dies zeigt an, ob das Ergebnis eine einzelne Ausgabe oder eine Liste mehrerer Ausgaben ist.

Query

Der Inhalt einer Variablen kann innerhalb dieses Feldes mithilfe der SQL-Syntax definiert werden.

Execute

Dies zeigt die Testergebnisse der Variablen.

Remove

Diese Funktion löscht die komplette Variable aus dem System.

 

Der Name der Variablen für das Beispiel lautet identType. Der SQL für die Abfrage:

 

Nach einem Klick auf den Button 'Speichern' kann die Variable innerhalb der Widget-Konfiguration durch Klick auf den Button 'OK' definiert und bestätigt werden. 

Die neuen Inhalte werden an das System und die variablen Einstellungen angepasst. Die Auswahl sieht nach dem Speichern des Widgets wie unten dargestellt aus:

 


Sperren von Variablen

Wenn dasselbe Widget von mehreren Entitäten, z.B. mehreren Abteilungen, verwendet werden soll, kann eine gesperrte Variable im Widget implementiert werden. Dadurch wird sichergestellt, dass der Endbenutzer die Variable nicht ändern kann.

Wenn die Variable gesperrt wurde, kann der Benutzer ihren Wert nicht ändern. Im vorliegenden Screenshot wäre beispielsweise standardmäßig immer der Wert 'USER' ausgewählt.

Dies kann nur vom Eigentümer des Widgets geändert werden. Dadurch ist es möglich, ein Widget für mehrere Dashboards zu verwenden und gleichzeitig sicherzustellen, dass verschiedene Benutzer nur Zugriff auf die Informationen haben, für die sie berechtigt sind.


Verwenden globaler Variablen

Globale Variablen können innerhalb des Dashboards verwendet werden. Die folgenden Variablen gehören zu dieser Kategorie:

Variable

Befund

Variable

Befund

:CURRENT_USER_NAME

Dies gibt den Namen des aktuell angemeldeten Benutzers zurück.

:CURRENT_USER_ID

Dadurch wird die UserID des aktuell angemeldeten Benutzers bereitgestellt.

:CURRENT_USER_DEPARTMENT

Dies zeigt die Abteilung an, zu der der Benutzer gehört.

:CURRENT_CLIENT_NAME

Dies gibt den Namen des Clients an.

:CURRENT_CLIENT_ID

Dadurch wird die aktuelle ClientID bereitgestellt.

:CURRENT_TIMESTAMP

Dies zeigt den aktuellen Zeitstempel an.

:CURRENT_EMAIL

Zeigt die aktuell registrierten E-Mail-Adressen an.

:CURRENT_USER_GROUPS_NAMES

Diese zeigt in Anführungszeichen (",") an, zu welchen Gruppen der aktuelle Benutzer gehört.

:CURRENT_USER_GROUPS_NAME1

Dies zeigt die erste Gruppe, zu der der angemeldete Benutzer gehört.

:CURRENT_USER_GROUPS_NAME2

Dies gibt Auskunft über jede zweite Gruppe, in der der aktuell angemeldete Benutzer Mitglied ist.

und so weiter

 


Vordefinierte Dashboards genehmigen

Wenn ein Dashboard mit allen erforderlichen Widgets und Einstellungen erstellt wurde, kann dieses an alle Personen verteilt werden, die mit dem System zusammenarbeiten. Benutzer dieser Gruppe können sich dann beim Dashboard anmelden und haben Zugriff auf die Widgets und Widget-Einstellungen. Der autorisierte Zugriff kann dann gewährt werden, indem Sie im Dashboard-Menü "Einstellungen" auswählen und auf die Schaltfläche "Konfiguration" auf dem jeweiligen Dashboard klicken.

Der Benutzer kann dann die gewünschten Gruppen innerhalb des Systems auswählen (während er die Taste "Crtl" gedrückt hält) und ihnen die Berechtigung für das Dashboard erteilen.


Konfigurieren von Berichten

Bei Bedarf kann das Dashboard Widgets in einem Bericht exportieren. Diese Berichte können in regelmäßigen Abständen an bestimmte Benutzer/Gruppen gesendet werden. Dazu muss eine Word-Datei mit einer Tabelle erstellt werden. Der Name der zu exportierenden Widgets sollte in der ersten Zelle platziert werden.

${widget.nameofthewidget}

 

Erstellen Sie zunächst eine Word-Datei mit der unten angezeigten Struktur.

Durch Auswahl von "Einstellungen" im Dashboard-Menü und Klick auf die Schaltfläche "Konfiguration" auf dem jeweiligen Dashboard kann ein automatisch erstellter Bericht konfiguriert werden.

Wechseln Sie in den Reiter 'Berichte' und laden Sie die zuvor generierte Word-Datei hoch. 

Durch Klicken auf die Schaltfläche "Konfigurieren" des jeweiligen Berichts kann der Benutzer die E-Mail-Empfänger und -Inhalte sowie das Intervall für den Versand des Berichts konfigurieren.

 

Element

Beschreibung

Element

Beschreibung

1

Zeigt den Betreff einer generierten E-Mail an.

2

Zeigt den Inhalt einer generierten E-Mail an.

3

Aktiviert oder deaktiviert den Bericht.

4

Zeigt das Datum an, an dem der erste Bericht gesendet werden soll.

5

Zeigt an, wie oft der Bericht gesendet werden soll, falls aktiviert.

6

Nimmt die Zeit vom Eintrag in der dashboard.properties. Mehr dazu unter Automatische Berichte generieren.

7

Die Empfänger können entweder aus Benutzern oder Gruppen ausgewählt werden.

 


Automatische Berichte generieren

Um die Berichte automatisch versenden zu können, muss die dashboard.properties konfiguriert werden. Dazu müssen die folgenden Werte entsprechend angepasst werden. ^ Name ^ Beschreibung ^ ^ timerInterval ^ Wie oft sollte ich überprüfen, ob ein Bericht erforderlich ist| ^ timerIdentityName ^ Benutzername, der den entsprechenden Eintrag im EMail_queue (z.B. Wiki/Dashboard) erstellt| ^ timerIdentityPassword ^ Das Benutzerkennwort | ^ emailSender ^ Hier kann die Engine eingegeben werden, mit der die Mails versendet werden sollen.  | ^ morningReportHours ^ Gibt die Uhrzeit (in Stunden) an, zu der der Bericht morgens gesendet werden soll (die Serverzeit wird als Grundlage verwendet). Ein Wert von 10 bedeutet 10:00 Uhr | ^ eveningReportHours ^ Gibt die Uhrzeit (in Stunden) an, zu der der Bericht am Abend gesendet werden soll (die Serverzeit wird als Grundlage verwendet).