Branding

Konfiguration

Newsletter sind Dokumente, welche eine Reihe von Dokumenten oder sonstige Nachrichten zusammenstellen und an einen Kreis von Interessenten per Mail verschicken. Ein typischer Anwendungsbereich sind wöchentliche Newsletter mit den wichtigsten Nachrichten und ggf. einer redaktionell bearbeiteten Einleitung. Auf der WebSite des Mandanten kann sich jeder Interessent über ein Formular in die Liste eintragen.

Dieser Mechanismus wird nicht in diesem Dokument beschrieben; der Workflow schickt lediglich eine Mail mit dem erzeugten Newsletter an eine beliebige, konfigurierbare Mailadresse. In den meisten Fällen ist dies eine Verteileradresse der Newsletter-Software (Majordomo, Mailman)

Häufig sind dabei einige Arbeitsschritte immer gleich, etwa das Zusammenstellen der zu verschickenden Dokumente, das Eintragen einer Kopfzeile, der Mailadresse für den Verteiler, usw. Auch werden Newsletter meist in regelmäßigen Abständen versandt, womit sich schließlich ein konfigurierbarer Workflow für diese Routineaufgaben anbietet.

Dabei kann man zwischen zwei getrennten Aufgaben unterscheiden:

  1. Das schablonenhafte, immer wiederkehrende Erzeugen eines Newsletter-Entwurfs anhand bestimmter Regeln und Vorlagen
  2. Die redaktionelle Bearbeitung eines konkreten Newsletters und das Verschicken

Dementsprechend bieten sich auch zwei einzelne, aber ineinandergreifende Workflows an. Die erste Stufe wird initial konfiguriert und läuft nach einem Start selbstständig im Hintergrund ab. Hier wird zu den festgelegten Zeitpunkten (oder auch einmalig, je nach Bedarf) anhand der Schablonen ein konkreter Newsletter erzeugt und mit automatisch ermittelten Dokument-Fragmenten befüllt. Diese „Rohform“ wird in der zweiten Stufe auf Wunsch einer Redakteursgruppe (oder sofort den Qualitätsbeauftragten) vorgelegt und ggf. nachbearbeitet. Nach der Abnahme kann der Newsletter gerendert und versandt werden.

Beteiligte Dokumenttypen

Der Newsletter-Typ wurde bereits erwähnt. Für die Regeln wird eine Newsletter-Konfiguration erstellt, welche die notwendigen Informationen aufnimmt (Zyklus, Mailadressen, Query, Vorlagen-Newsletter, Namensgebung, ...).

Diese Konfiguration muss der ersten Stufe (NewsletterCreateSubWorkflow) als Parameter mitgegeben werden. Daraufhin sind keine weiteren Aktionen mehr notwendig.

In der Konfiguration kann auf eine Query verwiesen werde, welche bei Ausführung eine Menge an Dokumenten (Fragmenten) liefert. Dies ist eine Standard-CoreMedia-Query, welche als Dokument abgelegt wird. Diese Query kann z.B. alle Dokumente vom Typ „News“ in einem bestimmten Ordner liefern, welche als Referenzen in das zu erzeugende Newsletter-Dokument gesetzt werden.

Abbildung 1 zeigt die Beziehungen der Dokumenttypen untereinander und die Verwendung in Workflows im Überblick.

Newsletter Dokumenttypen Abbildung 1: Beziehungen der Dokumenttypen untereinander

ConfigNewsletter

Dieser abstrakte Dokumenttyp dient zur Konfiguration einer Newsletter-Art. Konkrete Unterklassen können auf spezielle Features einer Newsletter-Engine eingehen, oder sie benutzen die hier definierten Parameter (Mailman, Majordomo,...)

Folgende Parameter werden hier eingestellt:

PropertyBeschreibung
startDateDatum der ersten automatischen Newslettererstellung. Falls nicht angegeben, wird Newsletter sofort erstellt.

Falls die Werte timeoutValue und timeoutUnit gesetzt sind, erfolgt eine entsprechende periodische Erstellung des Newsletters, bis das Datum in endDate erreicht ist.Ist kein timeoutValue gesetzt, erfolgt eine einmalige Ausführung.Ist kein Wert in endDate gesetzt, erfolgt eine unendlich häufige Ausführung. Ist kein Wert oder Datum in der Vergangenheit in startDate gesetzt, erfolgt eine sofortige Ausführung.

endDateLetzte Ausführung der automatischen Newslettererstellung. Falls nicht angegeben, periodische Erstellung nach Wert in timeoutvalue.
timeoutValueWert des Ausführungsintervalles, z.B. alle 24 Stunden.
timeoutUnitDie Zeiteinheit des Ausführungsintervalls, z.B. alle 24 Stunden. Siehe hierzu Klasse DoctypeConstants in der generierten JavaDoc-Api für ein Mapping der Integer-Werte auf tatsächliche Zeiteinheiten.
receiverEmailPlainDie Emailadresse, die die letztendliche Verteilung der Plain-Text-Emails übernimmt.
receiverEmailHtmlDie Emailadresse, die die letztendliche Verteilung der HTML-Emails übernimmt.
senderEmailAbsenderadresse, die in Newsletter-Emails stehen soll.
adminEmailEmailadresse des Newsletteradministrators
namingSchemaNamensschema der erzeugten Newsletter-Dokumente im CoreMedia-Repository. Die Token ${D}$ und ${T}$ werden durch das aktuelle Datum bzw. die aktuelle Uhrzeit ersetzt. Beispiel: Bundesliga_Newsletter_${D}$_${T}$
approveTypeArt der Bearbeitung/Freigabe (direkte Publikation = 2, Publikation durch Approver = 1, manuelle Bearbeitung durch Redakteur = 0).
periodicityOptionale, textuelle Beschreibung des Ausführungsintervalls, z.B. jeden 1. Sonntag im Monat.
directorySchemaWie sollen die erzeugten Newsletter-Dokumente unterhalb des Zielordners abgelegt werden?

0 - (Defaultwert- keine weiteren Ordner)
1 - /
2 - //
3 - ///Newsletter>
Für ein Mapping der Int-Werte siehe die JavaDoc-Dokumentation der Klasse DoctypesConstants.

includeQueriesOptionale CoreMedia-Query zur Zusammenstellung der für die Erstellung des Newsletters notwendigen Dokumente. Werden mehrere Queries angegeben, so wird die Vereinigungsmenge aller Einzelsuchergebnisse gebildet.
excludeQueriesCoreMedia-Query, die optional von der Zusammenstellung auszuschließende Dokumente beschreibt. Diese werden aus der Ergebnismenge der includeQueries herausgefiltert. Werden mehrere Queries angegeben, wird die Vereinigungsmenge aller über die excludeQueries gefundenen Dokumente herausgefiltert.
newsletterLocationIn dem Ordner des verlinkten (Dummy-)Dokuments werden die automatisch generierten Newsletter-Dokumente abgelegt (vgl. namingSchema und directorySchema).

Zur Auswahl des Orders müssen ConfigString-Dokumente ausgewählt werden, die in den entsprechenden Ordner mit dem Namen "_folderIndicator" hinterlegt worden sind.

prototypeDer (notwendige) Newsletter-Prototyp, dessen Felder in den tatsächlichen, dynamisch generierten Newsletter übertragen werden.

Newsletter

Dieser Dokumenttyp wird anhand der Konfiguration vom NewsletterCreateWorkflow erzeugt und anhand des Newsletter-Prototyps mit beliebigen Werten vorbelegt. Ein Newsletter ist (bis auf die genannte Ausnahme des Prototyps) immer ein konkreter Newsletter, der generiert und verschickt werden kann. Ein Redakteur erstellt, überarbeitet oder überprüft die optionale Dokumentenliste und den Newsletter-Text. Hier werden nur ausgewählte Properties beschrieben, welche direkt den Erstellungsprozess und die Workflows betreffen.

PropertyBeschreibung
configuration(Nicht editierbarer) Verweis auf das ConfigNewsletter-Dokument, anhand dessen dieser Newsletter erzeugt wurde. Dies ist notwendig, da nur in diesem Dokument die Notwendigen Informationen für die Generierung und den Versand vorhanden sind.
documentCompntsDie Assoziation modelliert auf der Basis des Composite Patterns den Aufbau von zusammengesetzten Dokumenten.

Konkret ist dies eine Liste von Textfragmenten (z.B. News der letzten Woche), die anhand der Query (im NewsletterCreateWorkflow) vorbereitet und vom Redakteur weiterbearbeitet werden kann.

Query

Zur automatischen Zusammenstellung der gewünschten Textfragmente im Newsletter müssen Regeln formuliert werden. Dies geschieht am einfachsten mit der Standard-Query, welche die SCI bereitstellt. Die Query wird unter einem aussagekräftigen Namen abgespeichert und der Übersicht halber im Ordnerbereich der Newsletter platziert.

Es werden dynamische Queries unterstützt (s. eigenes Kapitel im Workflow-Konzept).