Mandantenkonfiguration

Einleitung

Die Newsletter sowie die Newsletterkonfiguration eines Mandanten werden im Maildistributor definiert. Der Maildistributor stellt eines REST-Schnittstelle zur Verfügung, die

• einen Abruf der Newsletter bzw. der Newsletterkonfiguration eines Mandanten sowie
• eine An- oder Abmeldung für einen Newsletter

ermöglicht.

Für eine An- bzw. Abmeldung eines Newsletters müssen entsprechende Formulare im Webauftritt konfiguriert werden. Die Schritte zur Konfiguration eines Newsletter werden im Abschnitt Newsletter Formulare beschrieben.

Der abschließende Abschnitt CAE-Konfiguration geht auf die notwendige Anbindung des Maildistributor REST-Interfaces ein.

Newsletter Formulare

Die Formulare für die Anmeldung bzw. Abmeldung an einem Newsletter werden mit Hilfe des GSB-Formularbaukastens erstellt und können anschließend in den Webauftritt eingebunden werden. An dieser Stelle wird lediglich die Maildistributor-spezifischen Konfiguration der Formular-Actions und -Formfiller beschrieben.

Anmeldung

Die Standardlösung enthält eine exemplarische Newsletterkonfiguration, die um die Anbindung des Maildistributors erweitert werden kann. Hierzu wird zunächst die im Anmeldeformular verlinkte Formular-Action (Dokument /standardlsg/SiteGlobals/Forms/_components/Actions/Newsletter_Bestellen) für die Anbindung des Maildistributors erweitert. Hierfür steht die Formularaction de.materna.cms.cae.forms.action.NewsletterSubscribeActionRest zur Verfügung, die in der Formularproperty Java-Klasse definiert werden muss.

Der für die Registrierung gewünschte Newsletter wird in der Property listName definiert.

Der folgende Screenshot verdeutlicht dies exemplarisch für den Newsletter standardlsg_newsletter (im Screenshot markiert). Die restlichen Parameter sowie die Properties konfigurieren die Mail, die während der DoubleOptIn-Registrierung generiert wird.

Bestätigen der Anmeldung

Nach Registrierung für einen Newsletter erhält der Abonnent eine E-Mail mit einem Bestätigungslink (Double-Opt-In Registrierung). Nach Aufruf des Bestätigungslinks ist sein Abonnement bestätigt und er erhält ab sofort Newsletter-Mails. Die Bestätigung wird ebenfalls über eine Formular-Action umgesetzt und muss analog zur Registrieren-Action definiert werden. In der Standardlösung ist dies im Dokument /standardlsg/SiteGlobals/Forms/_components/Actions/Newsletter_Bestaetigen definiert. In diesem Dokument müssen die Java-Klasse de.materna.cms.cae.forms.action.NewsletterConfirmActionRest und Listenname (listName) wie oben angepasst werden.

Abmeldung

Die Abmeldung wird analog zur Anmeldung konfiguriert. In der Standardlösung muss die im Abmeldeformular verlinkte Formular-Action (Dokument /standardlsg/SiteGlobals/Forms/_components/Actions/Newsletter_Abbestellen) für die Anbindung des Maildistributors erweitert werden. Hierfür steht die Formularaction de.materna.cms.cae.forms.action.NewsletterSubscribeActionRest zur Verfügung, die in der Formularproperty Java-Klasse definiert werden muss.

Der für die Registrierung gewünschte Newsletter wird in der Property listName definiert.

Der folgende Screenshot verdeutlicht dies exemplarisch für den Newsletter standardlsg_newsletter (im Screenshot markiert).

Bestätigen der Abmeldung

Nach Abmeldung für einen Newsletter erhält der Abonnent eine E-Mail mit einem Bestätigungslink (Double-Opt-Out Verfahren). Nach Aufruf des Bestätigungslinks ist sein Abonnement gelöscht und er erhält ab sofort keine Newsletter-Mails mehr. Die Bestätigung wird ebenfalls über eine Formular-Action umgesetzt, die bereits bei der Bestätigen der Anmeldung-Action definiert worden ist.

Formfiller

Newsletter können zu bestimmten Themen bzw. in bestimmten Ausgabeformaten (HTML und/oder Text) angeboten werden. Um den Nutzern eine Registrierung für ein bestimmtes Format und Thema zu ermöglichen, kann das Anmeldeformular entsprechend erweitert werden. Die vom Newsletter unterstützten Ausgabeformate und Themen können per FormFiller aus der Newsletterdefinition (Maildistributor Datenbank) ermittelt und im Formular zur Auswahl angeboten werden. Relevant für die Anbindung des Maildistributors sind die folgenden Eigenschaften:

• Formular-Füll-Klasse wird auf den Wert de.materna.cms.cae.forms.formfiller.MailmanUserAttributeFormFillerRest gesetzt
• Eigenschaften für Formular-Füllklasse enthalten im Parameter listName den Namen des Newsletters, attributeName enthält den Namen des für das Format bzw. Thema zu verwendenden Attributs und defaultValues enthält den Namen des Standardwertes.

Der folgende Screenshot skizziert dies anhand der Konfiguration des Ausgabeformats (attributeName=Format) für den Newsletter standardlsg_newsletter :

CAE-Konfiguration

Die CAE-Webapplikation der Liveumgebung benötigigt für die Verbindung zum REST-Service des Maildistributors noch die Konfiguration des REST-Endpunktes. Diese wird für die An- und Abmeldung der Abonnenten für eine Mailingliste benötigt und über eine Build-Property der CAE-Webapplikation definiert. Die im Release mitgelieferten Beispielproperties build_ml_webapp_cae.properties bzw. build_rl_webapp_cae.properties enthalten bereits eine exemplarische Definition:

• cae_restMailDist_uriBase=

Der Servername maildist.domain.example sowie der Port, unter dem das Rest-Interface angesprochen werden kann, muss ggf. noch an die umgebungsspezifische Konfiguration angepasst werden.