E-Mail Reporter - Nutzung¶

Das E-Mail Reporter Plugin dient dem Erstellen von zu versendenden Reports.

Die Daten für solche Reports stammen aus Portalen.

Der eigentliche Versand der E-Mail Reports wird vom Scheduler durchgeführt.

Ein E-Mail Report unterteilt sich in Basis-, Report- und E-Mail-Konfiguration:

Basis¶

Parameter	Bedeutung	Anmerkung
Name	Aussagekräftiger Name	Hiernach kann im Auswahl-Dialog gefiltert werden
Aktiv von	Ab wann soll dieser Report versendet werden?	Muss gültiges Datum im Format DD.MM.JJJJ sein
Aktiv bis	Bis wann soll dieser Report versendet werden?	Muss gültiges Datum im Format DD.MM.JJJJ sein

Reports¶

Im Abschnitt Reports wird festgelegt, aus welchen Portalen die zu versendenden Daten stammen.

Mit dem Hinzufügen-Button werden neue und mit dem Bearbeiten-Button werden bestehende Reports konfiguriert.

In beiden Fällen öffnet sich der Report-Dialog:

Mit dem Übernehmen-Button wird der Report für den Versand vorgemerkt. Mit dem Report löschen-Button können bestehende Reports aus dem Versand entfernt werden.

Parameter	Bedeutung	Anmerkung
Name	Aussagekräftiger Name	Erhöht bei vielen Reports die Übersichtlichkeit
Portal	Portal mit den gewünschten Daten
Gruppe	Gruppe im Portal
Zeile	Zeile in der Portalgruppe
Tabellen
Senden	Soll die Liste oder Pivot in den Report inkludiert werden?
Überschrift	Optional abweichende Überschrift
Anhang	Soll die Liste oder Pivot als Anhang versendet werden?	Wenn nicht angehakt, muss die Tabelle im E-Mail-Text eingebunden werden

E-Mail¶

Der E-Mail-Abschnitt konfiguriert die zu versendende E-Mail selbst. Zudem können mit Hilfe der Platzhalter Report-Daten direkt in den E-Mail-Text eingebettet werden.

Parameter	Bedeutung	Anmerkung
Empfänger	Hauptempfänger des E-Mail-Reports	Adressen für alle Empfänger sichtbar! Adressen können mit hinzugefügt werden (*1)
CC	Weitere Empfänger des E-Mail-Reports	Adressen für alle Empfänger sichtbar! Adressen können mit hinzugefügt werden (*1)
BCC	Verdeckte Empfänger des E-Mail-Reports	Adressen nicht für Empfänger sichtbar. Adressen können mit hinzugefügt werden (*1)
Betreff	Betreff der E-Mail
Platzhalter	Der gewählte Platzhalter wird an der aktuellen Cursor-Position im Text eingefügt	Wird bei Versand mit den Daten der referenzierten Tabelle ersetzt

*1: E-Mail Adressen hinzufügen

E-Mail-Adressen können aus Listen mit E-Mail-Spalte übernommen werden. Berücksichtig werden Spalten mit Name "E-Mail", "E-mail", "EMail", "Email", "email" sowie "eMail".

Versand¶

Die E-Mail kann manuell auf Wunsch oder geplant automatisch versendet werden.

Manuell¶

Der Versand der E-Mail kann hiermit jederzeit manuell angestoßen werden.

Automatisch¶

Hier wird konfiguriert, wann der Versand möglich / erwünscht ist (dies wird vom Scheduler beim Versand berücksichtigt).

Versandbereitschaft

Sollten die zu versendenden Daten nur an / nach bestimmten Zeitpunkten zur Verfügung stehen, kann der Versand hier darauf abgestimmt werden.

Mit dem Übernehmen-Button wird die Versandbereitschaft gesetzt, mit dem Nicht Automatisch Versenden-Button wird sie entfernt.

Parameter	Bedeutung	Anmerkung
Stunde	Zu welcher Stunde ist der Versand möglich?	Mehrfacheinträge möglich. Sind durch Komma zu trennen. Steht nicht zur Verfügung, wenn cron_interval=day
Tag im Monat	An welchen Tagen im Monat ist der Versand möglich?	Mehrfacheinträge möglich. Sind durch Komma zu trennen.
Wochentag	An welchen Wochentagen ist der Versand möglich?	Achtung: Steht zu `Tag im Monat` in einer oder-Beziehung ("entweder es ist `Tag im Monat` X oder `Wochentag` Y).
Monat	In welchen Monaten ist der Versand möglich?

Expertenansicht

Versandbereitschaft im CronFormat. Dies wird vom Scheduler als "Der Versand kann bei match erfolgen" (nicht "muss erfolgen") interpretiert.

Ein auf Systemebene ggf. konfigurierter CronJob für den Scheduler ist hiervon unabhängig, daher kann der tatsächliche Versandzeitpunkt abweichen.

Scheduler¶

Spezifischen Report senden¶

Es kann ein einzelner Report versendet werden:

Unter Angabe der Konfigurations-ID

emlrep-mailreporter --config /absoluter/pfad/zur/emlrep.ini --iid CONFIG_IID

Unter Angabe des Konfigurations-Namens

emlrep-mailreporter --config /absoluter/pfad/zur/emlrep.ini --name CONFIG_NAME

Alle Reports senden¶

Es können alle derzeit aktiven Reports versendet werden.

emlrep-scheduler --config /absoluter/pfad/zur/emlrep.ini

Tipp: Regelmäßiger Versand via CronJob

emlrep-scheduler nutzen für regelmäßigen Versand per CronJob

Versandbereitschaft wird berücksichtigt

Ein Report wird nur versendet, wenn dies lt. Versandbereitschaft möglich / erwünscht ist.