Typo3

 

Integration mit Typo3

 

Einleitung

Das Modul überträgt die Daten von Newsletter-Interessenten von Typo3 nach Maileon. Seit Version 2.5.0 werden dabei auch keinerlei Daten der Kontakte mehr in Typo3 gespeichert was besonders die Einrichtung erleichtert, da somit auch der Informationsfluss von Maileon an Typo3 (DOI-Bestätiger und Abmelder) entfällt. Alle Parameter der Übertragung sind über Variablen in Typo3 einstellbar.

In den Beispielen wird die XQueue-Beispielinstanz http://typo3.xqueue.de verwendet.

Inbetriebname des Moduls

Installation und Vorbereitung

1. Plugin installieren
Hierzu muss das mitgelieferte Installationspackage verwendet werden. Das aktuelle Package wurde vor Typo3 9 und 10 entwickelt und getestet. Für ältere Versionen ist ein separates Installationspackage erhältlich. Die Extension muss im Verzeichnis /typo3conf/ext/ abgelegt werden und kann dann wie gewohnt im Typo3 Backend unter Tools → Extensions installiert werden.

2. Template einfügen (TypoScript)
Um ein statisches Template für das Plugin einzufügen, muss zunächst im Menü links „Template“ ausgewählt werden. Dann wählt man in der Seitenverwaltung das Seiten-Root-Element aus. Es ist darauf zu achten, dass, wie im Screenshot zu sehen ist, oben „Info/Bearbeiten“ ausgewählt ist. Dann kann über „Vollständigen Template-Datensatz bearbeiten“ das Plugin zum Template hinzugefügt werden.

Im nächsten Schritt wird unter dem Punkt „Enthält“ („Includes“) der Wert „Configuration for Xqueue Subscribe (xqueue_subscribe)“ der Liste der ausgewählten Objekte hinzugefügt.

3. Newsletter-Registrierung einfügen
Auf der Seite auf der ein Anmeldeformular angezeigt werden soll muss nun das Anmelde-Plugin angezeigt werden. Dazu wird an der entsprechenden Stelle auf den Button zum Hinzufügen neuer Inhaltselemente geklickt.

Im sich nun öffnenden Dialog muss unter „Plugins“ der Typ „General Plugin“ ausgewählt werden.

Anschließend kann der Inhaltsblock bearbeitet werden und unter „Plugin“ kann ausgewählt werden, ob es sich um ein An- oder Abmeldeformular handelt. Nach Auswahl des Typs kann auch festgelegt werden auf welche Seiten im Erfolgs- oder Fehlerfall weitergeleitet werden soll.

 

Konfiguration

Nach dem Einloggen im Backend findet sich die Konfiguration in den Konstanten des Templates. Am einfachsten kann die Konfiguration über den TypoScript Object Browser angepasst werden:

Hier können folgende Einstellungen durchgeführt werden: (1) apiKey: Maileon API-Key (notwendig) (2) doiMailingKey: Der DOI Mailing Schlüssel, soll nicht das in Maileon eingestellte Default-Mailing zum Einholen der Permission versendet werden. Dieser Wert kann auf Formularebene überschrieben werden. (3) debug: Flag um Debug-Ausgaben anzuzeigen. Mögliche Werte: 0, 1 (4) targetPermission: Ziel-Permission nach dem Klick auf den DOI-Link. Analog zur Maileon API kann 4 (DOI) oder 5 (DOI+ = DOI inklusive Erlaubnis zum Einzelnutzertracking) angegeben werden.

 

Das Anmeldeformular

Das Anmeldeformular kann in der YAML-Formular-Datei angepasst werden (xqueue_subscribe/Resources/Private/Forms/XqueueSubscribe.form.yaml). Auf Grund der Einbindung muss dies jedoch aktuell über das Dateisystem geschehen. Die Formularfelder folgen dabei einer bestimmten Nomenklatur:

– Standardfelder: die Namen von Standardfeldern müssen mit standard_ beginnen und einen der Standardfeldnamen1 benutzen. Die Feldnamen müssen großgeschrieben werden. Beispiel: standard_FIRSTNAME

– Customfelder: die Namen von Customfeldern müssen mit custom_ beginnen und einen der Feldnamen in Maileon anhängen. Hierbei ist die Groß-/Kleinschreibung aus Maileon Beispiel: custom_TestVariable

Sollte es eine der Variablen nicht geben, so wird der Kontakt abgelehnt. Bitte legen Sie alle verwendeten Customvariablen zuerst in Maileon an. Ist der Debug-Modus eingeschaltet, so wird nach dem Absenden im Fehlerfall eine Meldung angezeigt. Abbildung 1 zeigt ein Beispiel in dem ein Feld standard_Position angegeben wurde. Da es kein Standardfeld mit dieser Bezeichnung gibt, liegt ein Fehler vor.

Abbildung 1: Falsches Standardfeld bei der Anmeldung (Debugmodus)

Formulare mit verschiedenen DOI-Mailings
Seit Version 2.1.0 ist es möglich auf einer Seite den DOI-Schlüssel zu setzen, welcher bei Registrierung eines Kontaktes verwendet wird. Damit ist es möglich verschiedene Formulare mit verschiedenen DOI-Mailings zu verknüpfen. Ein DOI-Schlüssel wird als TypoScript-Konstante gesetzt: plugin.tx_xqueuesubscribe.doiMailingKey = …
Dies ist auf jeder beliebigen Seite innerhalb des TYPO3-Seitenbaums möglich und vererbt sich auf alle Unterseiten, sofern sie dort nicht wieder überschrieben wird.