Benutzerhandbuch. v2.2

Transkript

1 v XQueue GmbH. Alle Rechte vorbehalten. Dokumentation für das XQueue System Diese Dokumentation darf ohne vorherige schriftliche Genehmigung durch die XQueue GmbH weder teilweise noch ganz reproduziert, in Datenbanken gespeichert oder in irgendeiner Form übertragen werden. Der Inhalt dieser Dokumentation dient ausschließlich zu Informationszwecken, kann jederzeit geändert werden und stellt keine Verpflichtung seitens der XQueue GmbH dar. Für Fehler der in dieser Dokumentation enthaltenen Informationen wird keine Haftung übernommen. XQueue GmbH, Christian-Pleß-Str , Offenbach am Main 2017 XQueue GmbH. Alle Rechte vorbehalten. Seite 1 von 13

2 Inhalt und Ziel Dieses Dokument beschreibt die genauen Funktionen der Erweiterung von XQueue für Typo3 Typ Version 2.2 Autor Marcus Beckerle Erstellt Letzte Änderung XQueue GmbH. Alle Rechte vorbehalten. Seite 2 von 13

3 Einleitung Das Modul synchronisiert Kundendaten zwischen Typo3 und Maileon. Newsletter-Anmelder werden von Typo3 nach Maileon synchronisiert und DOI-Bestätigungen/Abmeldungen werden aus Maileon an Typo3 übergeben. Alle Funktionen sind über ein Konfigurationspanel in Typo3 einstellbar. In den Beispielen wird die XQueue-Beispielinstanz verwendet XQueue GmbH. Alle Rechte vorbehalten. Seite 3 von 13

4 Inbetriebname des Moduls Installation und Vorbereitung 1. Plugin installieren Hierzu muss das mitgelieferte Installationspackage verwendet werden. Das aktuelle Package wurde mit Version entwickelt und getestet. Für ältere Versionen ist ein separates Installationspackage erhältlich. 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 man auf Vollständigen Template- Datensatz bearbeiten klicken um das Template hinzuzufügen. Im nächsten Schritt fügt man unter dem Punkt Enthält den Wert XQueue Subscribe (xqueue_subscribe) der Liste der ausgewählten Objekte hinzu XQueue GmbH. Alle Rechte vorbehalten. Seite 4 von 13

5 3. Newesletter-Registrierung einfügen Unter der Startseite (oder wo das Anmeldeformular angezeigt werden soll) muss 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 kann zunächst eine beliebige Struktur (zur Seite passend) angelegt werden. Im Beispiel wird nur ein Wrapper und darin das Anmeldeformular hinzugefügt. Als Wrapper nutzen wir ein Element vom Typ Form XQueue GmbH. Alle Rechte vorbehalten. Seite 5 von 13

6 Im Menü Plug-In muss das Formular für das XQueue Newsletter-Plugin ausgewählt werden. Im Beispiel wird einfach das beigefügte Formular gewählt. 4. Erstellen einer CMS-Seite die angezeigt wird, sollte in Maileon zum Beispiel beim Registrieren des Klicks auf den Double-Opt-In-Bestätigungslink ein Fehler auftreten. Diese benötigt keine Registrierung des Plugins, eine reine Seite die anzeigt Es ist ein Fehler aufgetreten reicht. Der Name der Seite ist egal, im Beispiel wird sie Anmeldung Fehler benannt XQueue GmbH. Alle Rechte vorbehalten. Seite 6 von 13

7 5. Erstellen einer CMS-Seite mit einem Text der nach dem Klick auf den Double-Opt-In-Link in der Bestätigungsmail angezeigt werden muss. Hier muss zunächst eine Seite vom Typ Plug-In einfügen erstellt werden. Im Menü Plug-In wird dann das XQueue Newsletter-Plugin ausgewählt und auf Typ Aktivierung gestellt XQueue GmbH. Alle Rechte vorbehalten. Seite 7 von 13

8 6. Schließlich muss noch eine Seite Abmeldeseite angezeigt werden, welche nach einer Abmeldung angezeigt wird. Auch hier muss das Plugin hinzugefügt werden, da auch diese Information in Typo3 vermerkt werden muss. Der Typ des Plugins heißt dann Abmeldung. Konfiguration Nach dem Einloggen unter findet sich die Konfiguration unter Template Root-Seite Konstanten-Editor Kategorie=PLUGIN.TX_XQUEUESUBSCRIBE XQueue GmbH. Alle Rechte vorbehalten. Seite 8 von 13

9 Hier können folgende Einstellungen durchgeführt werden: (1) Maileon API-Key (notwendig) (2) Wenn bei jeder Registrierung eine an einen kontrollierenden Mitarbeiter gesendet werden soll, kann dies hier eingestellt werden (3) UID für das Typo3 Verzeichnis in dem Newsletter-Empfänger angezeigt werden (dies dient der grafischen Übersicht) (4) UID für die Gruppe in die Newsletter-Empfänger hinzugefügt werden sollen (hier könnte man z.b. mit TypoScript auf alle Empfänger zugreifen) (5) Debug Ausgaben Abbildung 1: Einstellungen für Maileon 2017 XQueue GmbH. Alle Rechte vorbehalten. Seite 9 von 13

10 Im Beispiel lautet der Name des Verzeichnisses Newsletter Anmeldungen und die ID davon ist 162, siehe Abbildung 2. Abbildung 2: Gruppe der Newsletter-Anmelder Das Anmeldeformular Das Anmeldeformular kann in der YAML-Formular-Datei angepasst werden (xqueue_subscribe/resources/private/forms/xqueue_subscribe.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 Standardfeldnamen 1 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 3 zeigt ein Beispiel in dem ein Feld standard_position angegeben wurde. Da es kein Standardfeld mit dieser Bezeichnung gibt, liegt ein Fehler vor. Abbildung 3: Falsches Standardfeld bei der Anmeldung (Debugmodus) XQueue GmbH. Alle Rechte vorbehalten. Seite 10 von 13

11 Einstellungen die in Maileon vorzunehmen sind Abbildung 4: Maileon-Seitenverwaltung In der Seitenverwaltung (Abbildung 4) müssen diese URLs für die Abmeldeseite, die Bestätigungsseite und die Fehlerseite eingetragen werden. Abmeldeseite (ID der Seite im Beispiel ist 165): ID]&cs=[CONTACT CHECKSUM] DOI-Bestätigungsseite (ID der Seite im Beispiel ist 163): ID]&cs=[CONTACT CHECKSUM] DOI Fehlerseite (ID der Seite im Beispiel ist 164): Die Seiten müssen in Maileon den entsprechenden Funktionen zugewiesen werden. Anschließend kann man noch optional einen Abmelder-Webhook auf die Abmeldeseite einrichten, damit sichergestellt wird, dass auch automatische Abmeldungen übertragen werden: ID]&cs=[CONTACT CHECKSUM] Hinweis: Weiterhin ist zu beachten, dass in Maileon ein DOI-Mailing erstellt und unter Einstellungen Double-Opt-In als Standard konfiguriert wird XQueue GmbH. Alle Rechte vorbehalten. Seite 11 von 13

12 Übersicht der Kontakte Wählt man in Typo3 die Gruppe der Newsletter-Anmelder über die Listenfunktion aus (Abbildung 5), so wird eine Übersicht über Kontakte und deren Stati dargestellt. (1) Liste (2) Newsletter Anmeldungen Hier wird mit den Icons (3) angezeigt, ob ein Kontakt schon den Link in der DOI Mail angeklickt hat. Ein rotes Symbol am Kontakt-Icon oder eine erloschene Glühbirne zeigt an, dass der Kontakt noch nicht bestätigt hat. Abbildung 5: Übersicht der Kontakte in Typo XQueue GmbH. Alle Rechte vorbehalten. Seite 12 von 13

13 Brauchen Sie Unterstützung bei der Installation? Die Datenstruktur von Typo3 kann je nach Pluginauswahl stark variieren. Wir haben das Plugin von der Internetagentur i-group ( nach bestem Wissen und Gewissen entwickeln lassen. Sollte es dennoch zu unerwarteten Schwierigkeiten kommen helfen wir Ihnen gerne weiter. Wenden Sie sich bitte an unseren Kundendienst: 2017 XQueue GmbH. Alle Rechte vorbehalten. Seite 13 von 13