Inhaltsverzeichnis

 

 

Das Berichtswesen ist ein geeignetes Mittel, um Daten zu verdichten, aufzubereiten und an Dritte weiterzugeben. i-doit verfügt daher über einen Report Manager, der vollumfänglich Daten aus der IT-Dokumentation verarbeiten kann.

Überblick

Der Report Manager ist über die Hauptnavigationsleiste unter Extras → Report Manager zu erreichen. Im Navigationsbaum auf der linken Seite erscheinen die Punkte Reports, Online Repository und Views, auf die im folgenden eingegangen wird. Sollte der Report Manager bzw. die Punkte im Navigationsbaum nicht oder nur unvollständig erscheinen, liegt das an fehlenden Berechtigungen.

Report auswerten

Die selbst erstellten Reports befinden sich unter dem Punkt Reports. Nach dem Setup von i-doit befinden sich daher noch keine Reports in diesem Bereich.

Beim Klicken auf einen Report in der Liste, wird dieser mit den aktuellen Daten ausgeführt. Die Ergebnisliste eines Reports ist in i-doit tabellarisch aufgebaut. Reports fokussieren sich stets auf Objekte und deren Attribute. Pro Ergebniszeile steht daher ein Hauptobjekt im Fokus, zu dem beliebige Attribute wie Beziehungen zu anderen Objekten angegeben sein können. Durch einen Klick auf eine Zeile wird das dementsprechende Objekt geladen.

Die Tabelle bietet verschiedene Funktionalitäten (Spaltensortierung, nach einer Spalte filtern, Pagination). Weiterhin lässt sich ein Report in verschiedene Formate exportieren (Klartext, CSV, XML und PDF). Für die Weiterverarbeitung mit einem Tabellenkalkulationsprogramm o. ä. bietet sich der Export ins CSV-Format an.

Aus einem Report lässt sich ein Objekt vom Typ Objektgruppe generieren. Deren gleichnamige Kategorie sind die Objekte aus dem Report statisch zugeordnet. Alternativ ist es möglich, eine Objekt vom Typ Objektgruppe anzulegen, deren Objektzuweisung dynamisch sind. Dazu wählt man in der Kategorie Typ die entsprechende Einstellung aus und wählt einen Report. Von nun an enthält diese Objektgruppe immer die aktuelle Liste an Objekten, die der zugeordnetete Report als Ergebnis liefert. Dies geschieht also zur Laufzeit.

Reports kategorisieren

Reports können kategorisiert werden. Standardmäßig werden sie der Kategorie Global zugeordnet, die standardmäßig zur Verfügung steht und nicht gelöscht werden kann. Der Vorteil der Kategorisierung liegt im Berechtigungskonzept: Pro Katagorie kann angegeben werden, wer darauf zugreifen darf. Befindet man sich auf der Seite Reports, können über den Punkt Kategorien neue Kategorien erstellt oder bestehende bearbeitet werden. Hilfreich hierbei ist das optionale Beschreibungsfeld.

Hinweis

Sollte es nicht möglich sein, Report-Kategorien zu erstellen und/oder zu bearbeiten, ist es ratsam, die Berechtigungen hierfür zu überprüfen und sicherzustellen, dass der aktuell eineloggte User über die Berechtigungen hierfür verfügt.

Report erstellen oder bearbeiten

Reports können kopiert werden. Hierzu markiert man einen Report und klickt auf den Button Duplizieren. Gelöscht wird ein Report über den Button Purge. Dieser Schritt ist unwiderruflich.

Zum Erstellen eines Reports bieten sich zwei Arten an, die im folgenden näher erläutert werden.

Abfrage-Editor

Der Abfgrage-Editor bietet eine grafische Oberfläche, um einen neuen Report zu erstellen oder einen bestehenden zu bearbeiten. Er wird über den Button Neu aufgerufen. Alternativ findet man neben diesem Button in dem Drop-Down-Feld den Button Abfrage-Editor. Soll ein bestehender Report bearbeitet werden, muss die Checkbox neben dem Report ausgewählt und einer der oben genannten Buttons geklickt werden.

Essentiell ist der Titel und die Kategorie. Zudem ist es oftmals hilfreich eine kurze Beschreibung zu hinterlegen.

Über die Buttons Prüfen kann der Report getestet werden. In einem Popup werden maximal 25 Ergebnisse präsentiert.

Ausgabe

Im Bereich Ausgabe hat man die Möglichkeit, die Spalten der Ergebnisliste zu definieren. Dazu wählt man die gewünschten Attribute aus den drei Kategorietypen Global, Spezifisch und Benutzerdefiniert aus. Jedes Attribut definiert eine Spalte. Die Reihenfolge der Spalten lässt sich per Drag'n'Drop festlegen.

Nach einigen ausgewählten Attributen kann automatisch sortiert werden, sobald der Report ausgeführt wird. Dazu dient die Radiobox neben dem ausgewählten Attribut. Ist kein Attribut ausgewählt, wird nach der Objekt-ID sortiert.

Wird als Attribut eine Objektreferenzierung ausgewählt, können über die eingeblendete Lupe weitere Attribute des in Beziehung stehenden Objekts ausgewählt werden. Dazu öffnet sich beim Klick auf die Lupe eine weitere Abfrage nach dem oben beschriebenen Prinzip. Diese Unterabfragen können selbstverständlich wiederum zu Unterabfragen gemacht werden (rekursiv).

Weiterhin gibt es folgende Optionen:

OptionBeschreibung
Objekte mit leeren Verknüpfungen anzeigen?Diese Option bezieht sich auf Unterabfragen zu Objekten, die in Beziehung stehen. Sollte das Attribut, das diese Beziehung repräsentiert, leer sein, d. h., es steht kein Objekt in Beziehung, wird das Ergebnis leer sein, wenn die Option auf Nein steht. Andernfalls bleibt die Zelle im Ergebnis leer.
Beziehungsobjekte mit ausgeben?Hinter jeder Beziehung zwischen zwei Objekten steht ein Beziehungsobjekt. Wenn diese Option auf Ja steht, wird das Beziehungsobjekt ebenfalls im Ergebnis angezeigt.
SortierungNach einigen ausgewählten Attributen kann automatisch sortiert werden, sobald der Report ausgeführt wird. Mit dieser Option lässt sich zusätzlich einstellen, ob die Sortierung auf- oder absteigend geschieht.

Bedingungen

Über den Punkt Bedingungen können gewünschte Konditionen angegeben werden. Um auf ein bestimmtes Attribut zu prüfen, wird dieses mit der passenden Kategorie ausgewählt. Daraufhin wird die logische Abfrage konstruiert: Welchem Wert muss das Attribut entsprechen (oder nicht)? Typische Angaben wie =, !=, <, > usw. sind hier möglich und richten sich nach dem Feldtypen des Attributs. Ebenfalls richtet sich die Auswahl nach dem ausgewählten Attribut.

Einfache Verschachtelungen mit und oder oder sind möglich, indem über den +-Button und Konditionsblöcke weitere Bedingungen angegeben werden. Über den --Button werden Bedingungen entfernt. Leere Konditionsblöcke werden automatisch entfernt.

Möchte man Bedingungen setzen, die auf Attribute von Objekten, die in Beziehung stehen, abzielen, wählt man das Attribut mit der Objektbeziehung aus und setzt die Bedingung auf Verknüpftes Attribut. Daraufhin kann man in einem Unterkonditionsblock weitere Bedingungen angeben.

 

SQL-Editor

Jeder Report lässt sich über den SQL-Editor erstellen oder bearbeiten – also auch diejenigen, die mit dem Abfrage-Editor erstellt worden sind. Auf der Übersichtsseite der Reports klickt man entweder das Drop-Down-Feld neben Neu oder selektiert einen bestehenden Report und klickt das Drop-Down-Feld neben Bearbeiten an und wählt den Punkt SQL-Editor.

Wechsel zwischen Abfrage- und SQL-Editor

Wird ein Report mit dem SQL-Editor erstellt oder bearbeitet, ist die nachträgliche Bearbeitung mit dem Abfrage-Editor nicht mehr möglich. Hintergrund: Im SQL-Editor steht das volle Spektrum von SQL zur Verfügung. Da der Abfrage-Editor auf ein Subset von SQL beschränkt ist (was in den meisten Fällen reicht), könnte durch diese Differenz die erstellt Abfrage zerstört werden.

Im Formularfeld SQL-Abfrage wird die Abfrage in SQL geschrieben. Kenntnisse über die Datenbank-Struktur von i-doit sind hier vonnöten. Wichtig ist, dass man immer Objekte abfragt und als erste (unsichtbare) Spalte die ID des Objektes selektiert:

SELECT obj_main.isys_obj__id AS '__id__' FROM isys_obj AS obj_main;

Die Spalten-Namen können multilingual angegeben werden und werden von i-doit bei der Echtzeitabfrage automatisch übersetzt:

obj_main.isys_obj__title AS 'LC__UNIVERSAL__TITLE###1'

Komplexe Reports gestalten

 Um komplexe Reports zu gestalten, die viele Features von SQL ausreizen, bietet sich folgende Vorgehensweise an:

  1. Erstellen des Reports mit dem Abfrage-Editor (so weit es geht)
  2. Report kopieren
  3. Kopie mit dem SQL-Editor nachbearbeiten

Vorteile sind, dass man nicht unbedingt die Datenbank-Struktur von i-doit kennen muss und dass man den vorbereiteten Report immer noch mit dem Abfrage-Editor bearbeiten kann.

Online Repository

Im Internet sind bereits einige vorgefertigte Reports zum Download verfügbar. Über den Punkt Online Repository kann man diese direkt ausführen oder erst lokal speichern. Eine bestehende Internetverbindung ist dazu nötig.

Report Views

Report Views bieten über die oben genannten Reports zusätzliche Funktionen und Ansichten. Neue können nicht angelegt, bestehende nicht bearbeitet oder gelöscht werden.

Auswahl von nützlichen Report Views:

  • QR Codes: Aufbereiten und Drucken von mehreren Labels gleichzeitig, die einen QR-Code sowie weitere Informationen und  ein Logo enthalten können.
  • Geräte in einem Standort (Listenformat)
  • Netzwerkverbindungen
  • Offene Kabelverbindungen

Reports automatisiert exportieren

Bestehende Reports können automatisiert als Datei exportiert werden, ohne das ein Benutzer manuell eingreifen muss. Dies geschieht über das Kommandozeilen-Werkzeug von i-doit, den Controller. Der passende Controller Handler lautet report. Wird der Controller ohne weitere Angaben aufgerufen, erscheint die Hilfe:

Example: 
./controller -u USERNAME -p PASSWORD -i TENANT_ID -m report -r REPORT_ID -d ABSOLUTE/PATH/FOR/EXPORT -f FILE_NAME -t csv

Parameters: 
-r:   ID of the report.
-d:   Path to export the report into.
-f:   Optional parameter for the file name. Default is the title of the report.
-t:   Optional parameter for the file type. Possible options are: csv, txt, pdf, xml. Default: csv

Der Controller Handler report erwartet folgende Parameter:

  • -r: Die ID des Reports. Die ID ist unter Extras → Report Manager → Reports zu finden.
  • -d: absoluter oder relativer Pfad, wo die Datei gespeichert werden soll
  • -f: Dateiname des Reports
  • -t: Export-Format: csv, txt, pdf oder xml

Die Automatisierung kann beispielsweise durch einen Cronjob erledigt werden.

Report-basierte Benachrichtigung

i-doit kann bei positiven Reports, also Reports mit Ergebnissen, passende E-Mails versenden.

Rechte vergeben

Benutzern und Benutzergruppen (in i-doit vertreten durch die Objekttypen Personen und Personengruppen) können Rechte für den Report Manager vergeben werden. Konfigurieren lässt sich dies über Verwaltung → Rechtesystem → Rechtevergabe → Report Manager. Folgende Rechte lassen sich vergeben:

  • Neue Reports erstellen
  • Online Repository
  • Report Views
  • Kategorien
  • Reports in Kategorien
  • Reports