BI Generatoren

Für die Bereitstellung der Daten für das Business Intelligence Modul setzen wir einen Datenspeicher gemäss dem Datawarehouse Konzept ein, z.T. auch "OLAP Cube" genannt. Je nach Selektion der Dimensionen wird dann sinngemäss ein Schnitt aus einem Würfel geschnitten.

Im Wesentlichen besteht das Datawarehouse aus einer grossen Datentabelle (Cube) mit vorberechneten Datenwerten. Dadurch wird ein effizienter, Businesslogik unabhängiger Zugriff auf die BI Daten und somit eine performante Anzeige auch mit grossen Datenmengen ermöglicht.

Die Berechnung erfolgt zeitlich unabhängig und mit voller Businesslogik Unterstützung via regelmässiger geplanter Aufgaben. So kann die Berechnung bei Bedarf in einzelnen Paketen (z.B. einzelne Monate) in eigenen Prozessen geschehen oder sogar parallelisiert werden.

Die Berechnungslogik wird in "Generatoren" genannten Python Scripts definiert. Diese sind auf den Kennzahlen hinterlegt. Um den Code eines Generators einzusehen, klicken Sie auf den Button mit den drei Punkten beim Feld Generator auf der Kennzahl:

Der Generator muss für die Kennzahlen, auf denen er hinterlegt ist, eine Berechnung enthalten. Der interne Name der Kennzahl muss also mit den vom Generator zurückgelieferten Werten übereinstimmen.

Standard BI Generatoren

Vertec liefert standardmässig folgende Generatoren mit:

Daten berechnen

Die Daten werden regelmässig über eine (oder mehrere) geplante Aufgabe in der Nacht berechnet. Die geplanten Aufgaben finden Sie im Ordner Einstellungen > Customizing > Geplante Aufgaben.

Bei diesem Vorgang werden alle bei den aktiven Kennzahlen hinterlegten Generatoren angestossen und die Werte für den Zeitraum von Januar des vorletzten Jahres bis zum Ende des nächsten Jahres berechnet.

Auf der Aufgabe ist im Status sichtbar, ob die Berechnung erfolgreich war oder fehlgeschlagen ist. Im Ausgabefenster wird die Rückmeldung der Berechnung angezeigt.

Eine Vertec App muss dafür nicht laufen, nur ein laufender Vertec Cloud Server ist Voraussetzung. Für die Berechnung wird auf der geplanten Aufgabe ein Benutzer hinterlegt, welcher für die Berechnung verwendet wird. Dieser Benutzer muss über Administratoren-Rechte verfügen, damit die Berechnungen durchgeführt werden können.

Zeitpunkt der Ausführung

Unter Nächste Ausführung wird angezeigt, wann die geplante Aufgabe das nächste Mal ausgeführt wird:

Im Cloud Abo kann die Zeit auf der Oberfläche nicht verändert werden. Die Berechnung erfolgt immer über Nacht, in einem Zeitfenster zwischen 23 Uhr und 5 Uhr.

Bei On-Premises kann das Zeitfenster mit den Parametern Special Task Scheduler Range Start und Special Task Scheduler Range End im Vertec.ini-File gesetzt werden. 

Berechnung manuell anstossen

Eine BI-Berechnung kann auch manuell angestossen werden. Hier gibt es zwei Varianten:

• Geplante Aufgabe jetzt ausführen: Dafür wird im Kontextmenü der geplanten Aufgabe der Menüpunkt Jetzt ausführen geklickt:
  

  

  Dadurch wird die Berechnung aller Generatoren auf allen aktiven Kennzahlen angestossen.

  Achtung: Die Berechnung wird direkt in der laufenden Vertec App gestartet und nicht wie bei der zeitgesteuerten Ausführung in einem separaten Task Runner Prozess. Das sollte nicht im laufenden Betrieb gemacht werden, da die Berechnung sehr lange dauern und Vertec dadurch blockiert sein kann.

• Anstossen der Berechnung eines Generators: Auf den einzelnen Kennzahlen kann die Berechnung manuell angestossen werden, indem im Kontextmenü Kennzahlen neu berechnen gewählt wird:
  

  

  Dabei wird der auf der Kennzahl hinterlege Generator angestossen und die entsprechenden Kennzahlen neu berechnet. Es kann jeweils das Datumsintervall noch gesetzt werden:

  

  Am Ende kommt eine Meldung, welche Kennzahlen berechnet wurden.

  Einmal berechnete Werte für einen Zeitraum und die betroffenen Kennzahlen bleiben im System vorhanden.

  Bei einer Neuberechnung der Daten werden bereits vorhandene Werte nur für diesen Zeitraum und die betroffenen Kennzahlen gelöscht und dann die neuen Werte eingefügt. Alle anderen Werte bleiben bestehen.

Python Methoden zur Berechnung der BI Daten

Es gibt zwei Python Methoden für die Berechnung der BI Daten.

vtcapp.processbi("2018-01", "2020-02", "OffersGenerator.OffersGenerator")

Generatoren erweitern / erstellen

Generatoren können auch erweitert bzw. neue Generatoren geschrieben werden. Dafür erzeugen Sie im Ordner Einstellungen > Berichte & Scripts > Scripts einen neuen Scripteintrag und verfassen den Generator-Code als Python Script.

Die Bezeichnung des Scripteintrags ist der Modulname. Zusammen mit dem Klassennamen des Generators bildet er die Generator-ID. Diese können Sie bei den BI Kennzahlen, die durch den Generator berechnet werden, als Generator angeben:

Modulnamen müssen eindeutig sein. Sie überschreiben also nicht einen bestehenden Generator, indem Sie ein Modul gleichen Namens verfassen, sondern indem Sie einen neuen Generator erstellen und auf den entsprechenden Kennzahlen hinterlegen.

BI Generatoren Code ab Vertec 6.8

Ab Vertec Version 6.8 gibt es ein eingebautes Modul namens vtcbi mit folgenden Klassen:

• BiGenerator: Neue Basisklasse für Generatoren
• Measure: Klasse, die eine Kennzahl beschreibt
• Dimension: Klasse, die eine Dimension beschreibt

Das Modul vtcbi wird auch als Stub File ausgeliefert. 

Das Modul bzw. die Klassen müssen im BI Generator Script importiert werden:

from vtcbi import BiGenerator, Measure, Dimension

BIGenerator

Measure

Die BI Kennzahlen (Measures) werden innerhalb eines Generators wie folgt definiert:

Measure(InternalName: string, Description: string, Unit: integer, [IsCutOffDateValue: boolean=False])

from vtcbi import BiUnit

Dimension

Die Dimensionen werden wie die Kennzahlen innerhalb eines Generators definiert:

Dimension(order: integer, type: string[, role: string]

Order	Reihenfolge der Dimension auf der Kennzahl. Muss der Reihenfolge auf der Kennzahl entsprechen:
Type	Hier wird der Klassenname der Dimension angegeben.
Role	Optional. Hier kann der Rollenname der Dimension angegeben. Der hier übergebene Wert wird als NV (Native) des Rollenfelds verwendet (MLString).

Beispiel

Als Beispiel wird ein Generator erzeugt, der produktive und unproduktive Leistungen getrennt anzeigen soll.

Mit generate_range() wird dabei der gesamte Zeitraum kalkuliert. Das store_values() sorgt selbst für die richtige Summierung und Einsortierung.

from vtcbi import BiGenerator, Measure, Dimension, BiUnit

class ProductiveGenerator(BiGenerator):

    prodServices = Measure("ProdServices", "Productive Services", BiUnit.Hours)
    unprodServices = Measure("UnprodServices", "Unproductive Services", 1)
    project = Dimension(1, "Projekt")
    projectmanager = Dimension(2, "Projektbearbeiter", "as project manager")
    user = Dimension(3, "Projektbearbeiter")
    
    def generate_range(self, startdate, enddate):
        # calc leistsums for the whole period, grouped by month, project and user
        leistsums = vtcapp.evalocl("TimSession.allInstances->first->groupLeistungen('{}', '{}', 'MONTH, PROJEKT, BEARBEITER')".format
            (vtcapp.datetostrgerman(startdate), vtcapp.datetostrgerman(enddate)))
            
        for leistsum in leistsums:    
            self.project = leistsum.evalocl("projekt")
            self.projectmanager = leistsum.evalocl("projekt->oclAsType(Projekt).projektleiter")
            self.user = leistsum.evalocl("bearbeiter")
            self.prodServices = leistsum.evalocl("(minutenintOffen + minutenIntVerrechnet)-(minutenintOffenUnprod + minutenIntVerrechnetUnprod)")
            self.unprodServices = leistsum.evalocl("minutenintOffenUnprod + minutenIntVerrechnetUnprod")
            self.store_values(None, leistsum.evalocl("datum"))

BI Generatoren Code vor Vertec 6.8

Die Deklaration des Generators ist wie folgt:

class <Generatorname>(object):

Auf das Generator-Objekt kann im Script jederzeit über self zugegriffen werden. Innerhalb des Generators stehen folgende Methoden zur Verfügung:

def get_dimensions(self):
    return ['Projekt', 'Projektbearbeiter']

def get_dimensions(self):
    return ['Projekt', 'Projektbearbeiter', 'Projektbearbeiter']

def get_measures(self):
    return ['OffersQuantity']

yield((project, project.projektleiter), (OffersQuantity,))

yield ((project), turnover_tuple, project.waehrung)