Zum Inhalt

E-Mail Reporter - Installation

Grundsätzlich besteht der E-Mail Reporter aus mehreren Modulen:

  • Plugin: CortexEngine Plugin zur Konfiguration von Reports
  • Scheduler: Python Modul zum Versand konfigurierter Reports per E-Mail

Plugin

Nutzungslizenz benötigt!

Die gewünschte CortexEngine Instanz muss über eine Lizenz mit der Berechtigung UniplexEmailReporter verfügen!

Uniplex Plugin benötigt!

Dieses Plugin kann nur im Kontext des Uniplex Plugins genutzt werden!

Tipp: In der Starter Edition und der User Group Edition ist das Uniplex Plugin bereits vorinstalliert.

Remote-Admin

Plugin

Dieses Plugin wird wie üblich mittels des Cortex-IP Remote-Admin installiert.

So geht's: Plugin installieren

Remote Admin Übersicht

  • Im Hauptfenster des Cortex-IP Remote-Admin die Option Apps/Plugins auswählen (Bereich 3).

  • Über die Buttons Directory Import (bei Plugin in Ordner-Form) bzw. File Import (bei Plugin als XJZ-Datei) wird das Plugin ausgewählt und installiert:

    Verwaltung Plugins

Benutzer

Zudem muss allen gewünschten Benutzern das Plugin freigeschaltet werden.

Benötigte Berechtigung: UniplexEmailReporter

So geht's: Benutzerrechte setzen

Remote Admin Übersicht

  • Im Hauptfenster des Cortex-IP Remote-Admin die Option User auswählen (Bereich 3).

  • Im UserDialog den gewünschten Benutzer markieren und Edit auswählen:

    Benutzer Auswählen

  • Im UserInputDialog die gewünschte Berechtigungen setzen im Bereich options/applications:

    Benutzer Auswählen

Uniplex

Pluginvorlage

Nach erfolgter Installation in der CortexEngine muss das Plugin im Uniplex

sein.

So geht's: In Pluginvorlage freischalten
  • Öffnen Sie die Pluginvorlagen.

    Plugin Templates

    Mit dem Button Hinzufügen! Hinzufügen werden neue und mit dem Button Bearbeiten Bearbeiten werden bestehende Einträge konfiguriert.

  • Wählen Sie die gewünschte Vorlage und aktivieren Sie das E-Mail Reporter Plugin.

    Plugin Template Edit

    Im Dialogkopf kann mit Plus eine Vorlage erstellt und mit Select eine andere Vorlage gewählt werden. Mit Vorlage löschen wird die Vorlage entfernt.

    Parameter Bedeutung Anmerkung
    Name Aussagekräftiger Name der Pluginvorlage
    Verfügbare Plugintasten Plugins, die in der CortexEngine verfügbar sind. Aktivieren mit Plus
    Aktivierte Plugintasten Plugins, die für Benutzer mit dieser Pluginvorlage sichtbar sein sollen. Entfernen mit Minus
    Reihenfolge ändern mit Up und Down
Feld- und Datensatztypdefinitionen

Um Report-Konfigurationen im Uniplex verwalten zu können, werden dessen Felder und Datensatztypen benötigt.

  • Downloaden und entpacken Sie die Datei.
  • Importieren Sie die Felddefinitionen (in Datei !FId.json)
  • Importieren Sie die Datensatztypdefinitionen (in Datei #Dst.ctxexp)

Import getrennt durchführen

Der Import von Feldern und Datensatztypen muss getrennt erfolgen!

So geht's: Feld- und Datensatzdefinitionen importieren

Die Import-Funktion befindet sich im unten links in den Systemeinstellungen.

Sie öffnet den Import Konfigurationen-Dialog.

Import Konfiguration

  • Markieren Sie die zu importierenden Konfigurationen und bestätigen Sie mit dem Markierte Importieren-Button.
  • Im Dateiauswahl-Dialog wählen Sie die Datei mit den zu importierenden Konfigurationen aus.

Scheduler

Python Version 3.11

Das Scheduler-Modul benötigt Python in der Version 3.11 oder höher!

Der Scheduler ist ein auf Python basierendes Modul, welches den Versand von E-Mail Reports realisiert.

Er läuft außerhalb der CortexEngine auf Systemebene und kann entweder manuell bei Bedarf oder via CronJob regelmäßig gestartet werden.

pip install emlrep-scheduler-[version].tar.gz

Beispiel:
pip install emlrep-scheduler-2.0.2.tar.gz
Tipp: $PATH ergänzen

Um die Nutzung zu vereinfachen, wird empfohlen, das Modul im Systempfad zu ergänzen:

  • Installationsort finden
    pip show emlrep-scheduler
    
  • In $PATH aufnehmen (z. B. .zshrc oder .bashrc)
    export PATH="$PATH:[/absoluter/pfad/zum/installations/ordner]"
    

Konfiguration

Die Konfiguration erfolgt über die emlrep.ini. Diese ist in die folgenden Kategorien unterteilt:

Dataservice

Um die Reports für den Versand lesen zu können, benötigt der Scheduler Zugriff auf den CortexEngine Datenbestand.

Dieser Zugriff erfolgt über die Uniplex-Schnittstelle:

emlrep.ini
[DATASERVICE]
no_rec_found=Keine Datensaetze gefunden.
link=localhost:8888/Uniplex/updjsr.php
user=admin
password=admin
Parameter Beschreibung
no_rec_found Gewünschte Rückmeldung, wenn keine Reports gefunden wurden
link URL der updjsr.php in einer laufenden Uniplex-Instanz
user Login-Benutzername der verlinkten Uniplex-Instanz
password Login-Passwort der verlinkten Uniplex-Instanz
Mailserver

Für den E-Mail Versand wird ein Mailserver benötigt:

emlrep.ini
[MAILSRV]
hostname=mailserver.cortex-ag.com
user=cron-mailer@cortex-ag.com
passwd=passwort
from=Emailreport <no-reply@cortex-ag.com>
ssl=0
port=587
Parameter Beschreibung
hostname URL des Mailservers
user Login-Benutzername bei Mailserver
passwd Login-Passwort bei Mailserver
from gewünschte Absenderadresse
ssl Soll SSL für die Verbindung zum Mailserver genutzt werden? (0 = Nein, 1 = Ja)
port Zugriffsport für Mailserver
Administrator
emlrep.ini
[ADMIN]
error_emails=report.admin@cortex-ag.com
debug=False
cron_interval=day
Parameter Beschreibung
error_emails Empfängeradresse für administrative / debug E-Mails
debug Sollen E-Mails an die error_emails-Empfänger und nicht an die in den Reports definierten Empfänger gehen? ('False' = Nein, 'True' = Ja)
cron_interval Wie häufig soll der Scheduler ausgeführt werden? ('day' = 1x Täglich, 'hour' = 1x pro Stunde) (*1)

*1: Stunden-Input im Plugin

Wenn cron_interval = day - also "Versand 1x am Tag" - Konfiguriert ist, wird in der Plugin-UI der Stunden-Input ausgeblendet.

Konfiguration - Webserver

Der Webserver, welcher die gewünschte Instanz der CortexEngine bedient, benötigt den Pfad zur emlrep.ini-Datei.

Dieser wird dem Webserver in seiner httpd.ini-Datei mitgeteilt:

httpd.ini
[HTTPSRV]
.
.
.
SERVERVAR_EmailReporterINI=/absoluter/pfad/zur/emlrep.ini