Skip to main content

Berichte automatisiert erstellen

Sie können Jobs anlegen, mit denen Berichte automatisiert erzeugt und in einem Ticket versendet werden.

So könnten Sie sich beispielsweise jeden Montag, um 6:00 Uhr über die Anzahl offener Störungstickets pro Organisation informieren lassen. Das nachfolgende Beispiel soll veranschaulichen, wie solch ein Job konfiguriert werden könnte.

Der Job hat folgende Aufgaben (in angegebener Reihenfolge):

  1. jeden Montag um 6:00 Uhr einen Bericht im CSV-Format auf Basis einer bestehenden Berichtsdefinition erstellt

  2. den Bericht als Artikelanhang generiert.

  3. ein neues Ticket versendet, welches den Bericht im Artikelanhang enthält.

Diese mit einem Job automatisch generierten Berichte werden - analog zu den manuell erstellten Berichten - in der Übersicht Berichte im Modul Berichte aufgeführt.

Vorbedingungen

Der Job benötigt zum Erstellen des Berichts eine bereits existierende Berichtsdefinition als Grundlage. Legen Sie dazu ggf. eine Berichtsdefinition an (s. auch: Wie erstelle ich eine Berichtsdefinition?)

Das Statement einer Berichtsdefinition könnte wie folgt lauten:

select o.name as "organisation", tt.name as "type", ts.name as "state", count(*) as "total"
   from organisation o, ticket_type tt, ticket_state ts, ticket t
      where t.type_id = tt.id
      and t.ticket_state_id = ts.id
      and t.organisation_id = o.id
      and tt.id in (${Parameters.TypeIDList})
      and o.id in (${Parameters.OrganisationIDList})
      and ts.id in (${Parameters.StateIDList})
   group by o.name, tt.name, ts.name
   order by o.name, tt.name, ts.name

Beispielkonfiguration des Jobs

  • Job Informationen

    • Job Typ: Reporting

    • Name: Name des Jobs (z. B. Wochenbericht)

    • Gültigkeit: gültig

  • Ausführungsplan

    • Wochentag(e): Montag

    • Zeit: 6:00 Uhr

    • Events: keine

  • Aktionen (in angegebener Reihenfolge)

    Informationen zu den im Job verwendeten Aktionen finden Sie in der Übersicht der Macro Actions

    1. Aktion: Bericht erstellen -  Erstellt den Bericht auf Basis der angegebenen Berichtsdefinition

      Zur Auswahl stehen die in der Berichtsdefinition festgelegten Parameter. Tragen Sie die vom Job zu verwendenden Parameterwerte ein, damit der Job diese beim Erstellen des Berichts setzen kann. 

      Sie können nur Ausgabeformate angeben, die bereits in der Berichtsdefinition festgelegt wurden.

      job-reporting_1MA-bericht_erstellen_start.png

    2. Aktion: Objekt zusammenstellen - Erstellt das Attachment-Objekt (hier: Artikelanhang)

      Diese Macro Action dient dazu, neue Objekte "zusammenzubauen", z. B. JSON Objekte. Hier wird der in der 1. Aktion ("Bericht erstellen") erzeugte Bericht als neues Attachmentobjekt (Artikelanhang) erstellt.

      job-reporting_2MA_objekt-zusammenstellen_start.png

      • Objekt: Deklaration des Variablennamens (${varReportAttachment}), in welchem das neue Attachmentobjekt gespeichert wird.

      • Definition: Der String, welcher das Attachmentobjekt erzeugt.

        {"Filename":"dummy.csv","ContentType":"${Report.Results:0.ContentType}","Content":"${Report.Results:0.Content|JSON}"}

        • "Filename":"dummy.csv"

          Name und Dateiendung des erzeugten Attachmentobjekts

        • "ContentType":"${Report.Results:0.ContentType}"

          MIME Type des Inhalts (hier: der MIME Type des Berichts).

          Infos dazu auch unter: https://wiki.selfhtml.org/wiki/MIME-Type/Übersicht

        • "Content":"${Report.Results:0.Content|JSON}"

          Inhalt des Attachmentobjekts mit Angabe der Pipe (hier: Inhalt von "dummy.csv").

          Die Angabe der Pipe mit JSON ist notwendig, damit der Inhalt valide im JSON-Format eingefügt und zitiert wird.

    3. Aktion: Macro ausführen - Führt ein Makro aus. (hier: neues Ticket anlegen).

      Diese Macro Action führt weitere Macros aus. Im Beispiel wird ein neues Ticket mit folgenden Informationen erstellt:

      • die erforderlichen Ticketangaben wie Status, Priorität, Betreff, Kanal etc.

      • durch Angabe der Variable ${varReportAttachment} wird das mit "Objekt zusammenstellen" erzeugte Objekt (dummy.csv) dem Ticket als Artikelanhang mitgegeben.

      job-reporting_3MA_macro-ausfuehren-start1.png
      job-reporting_3MA-macro-ausfuehren_start.png

Ergebnis

Nach Ausführung des Jobs existiert ein neues Ticket. Das Ticket enthält den Bericht im Nachrichtentext und im Artikelanhang die CSV-Datei des Berichts.

job-reporting_ergebnis-start1.png

Anmerkung

Die Validierung der Macro Actions erfolgt erst bei Ausführung des Jobs.

Hinweise zu eventuellen Fehlern finden Sie im kix.log (Menü System > Logs) oder im job.log (Detailansicht des Jobs > Tab Historie).

In diesem Abschnitt: