Zielgruppe Site AdminVersion: GSB10.1Eventdispatcher Performer

Der Eventdispatcher entscheidet auf Basis von Regelsätzen, ob das aktuell publizierte Dokument neben der Publikation auf die Livesite auch als Newsletter versandt werden soll. Die Entscheidung ob bei einer Publikation eines Dokumentes ein Newsletter generiert wird, kann mandantenspezifisch festgelegt werden, indem für einzelne Newsletter die Regelsätze individuell definiert werden. Ein Regelsatz definiert bspw. den zu berücksichtigenden Dokumenttyp, den Ablagepfad eine Themenkategorisierung sowie weitere Eigenschaften/Werte des publizierten Dokumentes. 

Der Eventdispatcher registriert einen Eventlistener im GSB Repository um Contentänderungen erkennen und entsprechend verarbeiten zu können. Die Events werden dann gegen mandantenspezifische Regelsätze geprüft, um ggf. eine Newslettergenerierung anzustoßen. Der Eventdispatcher kommuniziert mit dem GSB Repository und mit dem Maildistributor. Die Erweiterung stützt sich hierauf wie folgt:

• Die mandantenspezifischen Regelsätze für die Prüfung der Events werden im GSB Repository des Mandanten abgelegt. Ein einzelner Regelsatz wird hierbei im weiteren Text als Performer bezeichnet, da es sich hier um einen definierten und bekannten Begriff handelt .
• Die Übergabe des generierten Newsletters an den Maildistributor wird um die für die Speicherung der Events benötigten Informationen erweitert.

Neue Newsletter können durch den SiteAdmin im Adminportal einfach angelegt und bestehende Newsletterdefinitionen können hier auch bearbeitet und geändert werden. Sie haben hier die Möglichkeit unter "Komponenten -> EventDispatcher Performer" die Möglichkeit, die Newsletterdefinitionen und EventDispatcher-Konfigurationen selbständig als Self-Service zu definieren.

Die ebenfalls notwendige Erstellung der entsprechenden Eventdispatcher-Konfiguration erfordert eine Aktualisierung der Konfiguration in der Basis des Mandanten, die über ein Deployment auf der Produktivplattform aktiviert wird. D.h. die Konfiguration kann nicht analog zur Erstellung oder Bearbeitung einer Newsletterdefinition im Adminportal durch die SiteAdministratoren durchgeführt werden.

Ablagestruktur

Die Performerdefinitionen werden als GSB Dokumente im Content des Mandanten definiert, um diese einfach durch einen berechtigten SiteAdmin anpassen zu können.

Das Basisverzeichnis für die Ablage der Dokumente ist <CUSTOMER>/SiteGlobals/_extensions/configs/eventdispatcher.

Unterhalb des Eventdispatcher-Ordners werden dann die mandantenspezifischen Performer abgelegt. Hierbei gilt, dass jeder Performer in einem eigenständigen GSB Dokument definiert wird. Ein Performer korrespondiert hierbei zu einer Newsletterdefinition (über die Dokumente als Push-Newsletter verschickt werden). Es empfiehlt sich daher die „Performer-Dokumente“ entsprechend der zugeordneten Newsletterdefinitionen zu benennen (bspw. standardlsgPressReleaseNewsletter).

Performer Dokumente

Ein einzelner Performer wird als eigenständiges GSB-Dokument gespeichert. Als zugrundeliegender Dokumenttyp wird GenericScriptEnt verwendet. Um eine Bearbeitung der Dokumente im GSB Editor zu ermöglichen wird ein dedizierter SubType (GenericScriptEnt-ED_Performer) definiert in dem die benötigten Properties für die Performer-Definition wie folgt konfiguriert sind:

• Beschreibung (Property description): Textuelle Beschreibung des Performers, die durch den SiteAdmin individuell erfasst werden kann. Diese Beschreibung hat lediglich einen mandanteninternen Dokumentationscharakter
• Testmodus (Property showDOMTime): Boolescher Wert über den definiert werden kann, ob der Performer sich aktuell im Test- oder Produktivmodus befindet.
• Performer-Definition (Property sourceCode): Die im GSB 7 eingesetzten Performer-Definitionen können in diese Property übernommen werden. Die Beschreibung der Performer-Konfiguration findet sich in der GSB-Doku und gilt auch für die Performer im Content eines Mandanten.

Performer im Adminportal

Übersicht

Alle Performer-Definitionen des Mandanten sind auf der Übersicht in einer tabellarischen Darstellung aufgeführt. Neben dem Namen des Performers werden noch die kurze textuelle Beschreibung sowie die Konfiguration des Testmodus ausgegeben.

Über die drei Buttons hinter dem Namen eines Performers können folgende Aktionen aufgerufen werden:

• Bearbeitung des Performers (Icon: Stift)
• Anzeige von Statistikdaten des Performers (Icon: Diagramm)
• Ausgabe des Ereignisprotokolls des Performers (Icon: Klemmbrett)
• Löschen des Performers

Weiterhin können hier auch neue Performer über den Button „Performer hinzufügen“ angelegt werden.

Bearbeitung

Nach Auswahl eines Performers im Dropdown „ausgewählter Performer“ kann dieser bearbeitet werden. Der folgende Screenshot vermittelt einen Überblick über die Bearbeitungsmöglichkeiten:

Der Name des Performers wird initial beim Anlegen eines neuen Performers vergeben. Der Name dient der eindeutigen Identifikation des Performers und kann nach dem Erstellen nicht angepasst werden.

• Die Beschreibung des Performers enthält eine kurze textuelle Beschreibung. Diese wird ausschließlich für interne Zwecke verwendet. Die Beschreibung kann bspw. durch die zuständigen Administratoren zur einfacheren Identifikation eines Performers mit Hinweisen zur fachlichen Verwendung bzw. zur zugrundeliegenden Mailingliste gefüllt werden.
• Um einen Performer beim Neuanlegen nicht scharf schalten zu müssen, kann dieser zunächst noch in einem Testmodus betrieben werden. Performer im Testmodus prüfen die publizierten Dokumente anhand der im Performer definierten Regeln, lösen bei positiver Prüfung aber (noch) kein Mailing aus. Stattdessen erzeugen Sie nur ein entsprechendes Event, welches dann in der Performerstatistik bzw. im Ereignislog eingesehen werden kann. So können die Regelsätze für die Prüfung vor der eigentlichen Produktivschaltung eines Performers getestet werden,
• Die eigentliche Performerdefinition findet sich dann in dem Multiline-Texteingabefeld Definition. Die Definition eines Performers (im Content) entspricht der Definition, wie sie bisher auch in der Basis des Mandanten abgelegt worden ist.

Statistikdaten

Folgend finden Sie einen Überblick über die Statistikdaten eines Performers:

Die Statistik zeigt die Publikationsevents von Dokumenten, die „positiv“ durch den ausgewählten Performer geprüft worden, sind im zeitlichen Verlauf. D.h. es werden hierbei die generierten Newsletter bzw. bei Performern im Testmodus die erzeugten Einträge des Ereignisprotokolls angezeigt. Zu besseren Unterscheidbarkeit der produktiv generierten Newsletter und des Testmodus werden die beiden Kurven mit unterschiedlichen Farben gekennzeichnet.

Hinweis:
Der Screenshot dient nur der Verdeutlichung des Aufbaus und der Funktionalität der Anzeige der Statistikdaten und ist dem Portlet für Mailinglisten entnommen worden. Da produktiver- und Testmodus eines Performers nicht gleichzeitig aktiv sein können, werden sich beide Kurven sich bspw. zeitlich nicht überlappen können.

Ereignisprotokoll

Das Ereignisprotokoll eines Performers ist ein zentrales Ereignisprotokoll in dem alle Ereignisse des Performers aufgeführt werden. Hierbei kann es sich sowohl um Generierungen im Testmodus als auch einen produktiven Versand handeln. Die Filter ermöglichen eine zielgerichtete Filterung auf relevante Ereignisse.

Die tabellarische Übersicht des Ereignisprotokolls kann nach Datum/Uhrzeit, Testmodus (ja/nein), Newsletter-Liste und GSB-Dokument gefiltert werden. Weiterhin steht bei einem langen Protokoll eine Paginierung zur Verfügung, mit der ein Nutzer sich seitenweise durch das Ereignisprotokoll bewegen kann.

Aktivierung Performer

Die Aktivierung eines neuen oder geänderten Performers erfolgt dynamisch nach dem Speichern und Zurückgeben des zugehörigen Performer-Dokuments im Content-Repository des Mandanten. Eine Publikation der Dokumente ist nicht erforderlich, da der Eventdispatcher in der Redaktionsumgebung betrieben wird. Der im Eventdispatcher genutzte Eventlistener registriert die entsprechend Events und stößt anschließend ein Neuladen der Performer an.

Diese sind somit direkt aktiv und werden anschließend unmittelbar durch den Eventdispatcher für eine Generierung von Push-Newslettern genutzt.