Dokumentation. CleverReach Modul für Joomla!

Transkript

1 Dokumentation CleverReach Modul für Joomla!

2 CleverReach Modul für Joomla! Version 1.0 Seite 1 von 9 Inhalt Informationen zu diesem Dokument... 2 Änderungsnachweis... 2 Ergänzende Dokumente... 2 Einleitung... 3 Zweck des Dokumentes... 3 Geltungsbereich und Abgrenzungen... 3 Hauptteil... 3 Installation per Download... 3 Installation per Webadresse... 3 Zuweisen des Moduls an eine Position im Template... 4 Konfigurieren des Moduls... 7 Bekannte Probleme... 8 Einsatz mehrerer Module... 8 Windows-Cache... 8 Anhänge... 8 Abbildungs- und Tabellenverzeichnis... 8 Abbildungsverzeichnis... 8 Tabellenverzeichnis... 8 Index... 8 Glossar... 8

3 CleverReach Modul für Joomla! Version 1.0 Seite 2 von 9 Informationen zu diesem Dokument Dokumentenklasse Dokumentation Dokumententitel CleverReach Modul für Joomla! Dokumentennummer Verantwortlicher Martin Mlinski Dateiname Dokumentation.docx Erstellung begonnen am Letzte Bearbeitung am Letzter Ausdruck am Vertraulichkeitsstufe Öffentlich Bearbeitungsstatus Fertiggestellt Versionsnummer 1.0 Freigegeben am Freigegeben durch Martin Mlinski Änderungsnachweis Version Bearbeiter Datum Bearbeitungsstatus Anmerkung Martin Mlinski Erste Veröffentlichung Martin Mlinski Fertiggestellt Erweitert um neue Option Ergänzende Dokumente Dokumentennummer Titel des Dokuments Version Verantwortlicher

4 CleverReach Modul für Joomla! Version 1.0 Seite 3 von 9 Einleitung Zweck des Dokumentes Dieses Dokument beschreibt die Installation als auch die Konfiguration des CleverReach Moduls für Joomla! Geltungsbereich und Abgrenzungen Vergewissern Sie sich stets, dass Sie vor Änderungen im System ein aktuelles Backup erstellt haben. Matic-Tec.de übernimmt keine Haftung für Fehler die durch die Installation oder Nutzung dieser Dokumentation oder des Moduls entstehen. Dieses Dokument erhebt keinen Anspruch auf Vollständigkeit. Hauptteil Installation per Download Auf der Projektseite befindet sich der Button zum Download des Installationspaketes. Laden Sie es auf Ihren Computer. Melden Sie sich im Backend Ihrer Joomla! Installation an und klicken Sie in der oberen Menüleiste auf Erweiterungen > Erweiterungen. Klicken Sie auf den Button Durchsuchen, wählen Sie das heruntergeladene Paket von Ihrem Computer und klicken Sie anschließend auf den Button Hochladen & Installieren Nach erfolgter Installation gibt Joomla! Ihnen eine Rückmeldung, ob die Installation erfolgreich war. Installation per Webadresse Melden Sie sich im Backend Ihrer Joomla! Installation an und klicken Sie in der oberen Menüleiste auf Erweiterungen > Erweiterungen. Geben Sie im Eingabefeld URL zum Paket folgende URL ein und klicken Sie auf den Button Installieren :

5 CleverReach Modul für Joomla! Version 1.0 Seite 4 von 9 Nach erfolgter Installation gibt Joomla! Ihnen eine Rückmeldung, ob die Installation erfolgreich war. Zuweisen des Moduls an eine Position im Template Ist das Modul erfolgreich installiert, müssen Sie ein Modul im Backend Ihrer Joomla! Installation erstellen und es einer Position im Template zuordnen. Standardmäßig wird nach der Installation von Joomla bereits ein Modul eingerichtet, welches Sie dann nur noch konfigurieren müssen. Um es manuell zu erstellen gehen Sie wie folgt vor. Klicken Sie in der oberen Menüleiste auf Erweiterungen > Module. Klicken Sie dann auf den Button Neu. Wählen Sie als Modultyp CleverReach.

6 CleverReach Modul für Joomla! Version 1.0 Seite 5 von 9 Vergeben Sie einen Namen für das Modul und klicken Sie auf den Button Position wählen. Wählen Sie Ihr Template aus der Auswahlliste und anschließend die gewünschte Position.

7 CleverReach Modul für Joomla! Version 1.0 Seite 6 von 9 Damit wäre das bereit zum Speichern. Im nächsten Abschnitt wird beschrieben, wie das Modul zu konfigurieren ist.

8 CleverReach Modul für Joomla! Version 1.0 Seite 7 von 9 Konfigurieren des Moduls Damit die Verbindung zum CleverReach System funktioniert muss das Modul konfiguriert werden. Zusätzlich muss die SOAP Erweiterung für PHP aktiviert sein. Zunächst müssen Sie den API Key für Ihren Account im Modul hinterlegen. Um den API Key zu erhalten, melden Sie sich im Administrationsbereich von CleverReach an und klicken Sie oben rechts im Menü Account auf API. Auf der folgenden Seite klicken Sie dann auf den Button Neuen API Key erstellen. Geben Sie einen Verwendungszweck an. Zusätzlich müssen Sie für die jeweiligen Gruppen Schreib- und Leseberechtigungen setzen. Nun sollte der API Key erscheinen. Kopieren Sie den API Key und fügen Sie ihn in den Moduleinstellungen in das Feld für den API Key. Klicken Sie anschließend auf Speichern. Dies ist notwendig damit Ihre Gruppen aus CleverReach abgerufen werden. Wählen Sie anschließend die gewünschte Gruppe aus der Liste und klicken Sie auf Speichern. Dieser Gruppe werden Empfänger bei der Anmeldung zugeordnet. Sollte die Liste keine Gruppe anzeigen, überprüfen Sie den API Key. Prüfen Sie auch, ob eine Gruppe im CleverReach System erstellt ist. Anschließend wählen Sie ein Formular aus der Liste. Dieses Formular wird für den Versand der Opt-In Mails verwendet. Sollte die Liste keine Formulare anzeigen, prüfen Sie, ob Sie ein Formular im CleverReach System für die Gruppe angelegt haben. Das Feld Empfänger Quelle können sie mit einem beliebigen Text füllen. Dieser Text wird zum Empfänger gespeichert. So können sie besser nachvollziehen wo die Anmeldung des Empfängers zustande gekommen ist. Geben Sie zum Beispiel MeinJoomla ein, wissen Sie dass der Empfänger sich über dieses Modul angemeldet hat. Die Option Datenschutz akzeptieren fügt bei der Wahl Ja im Frontend eine Checkbox, inkl. Link zur Datenschutzseite, zum Formular hinzu. Diese Checkbox muss dann gesetzt sein, damit sich ein Empfänger anmelden kann. Aus der Auswahlliste Datenschutzseite wählen Sie einen Menüpunkt, der auf die Datenschutzbestimmungen verlinkt. Das Feld Text über Formular kann mit einem beliebigen Text versehen werden. Dieser erscheint im Frontendüber dem Formular.

9 CleverReach Modul für Joomla! Version 1.0 Seite 8 von 9 Bekannte Probleme Einsatz mehrerer Module Sollte das Modul mehr als einmal hinzugefügt werden, kommt es zu dem Problem, dass die Gruppe die Liste vom bereits erstellten Modul anzeigt. Es ist daher wichtig, dass für alle Module derselbe API Key verwendet wird. Dies ist aktuell eine Einschränkung im Joomla Framework. Windows-Cache Wenn Joomla auf einem Windows Server mit IIS und dem PHP Modul Wincache betrieben wird, darf nur der normale Cache aktiviert sein. Der erweiterte Cache führt zu einer fehlerhaften Verarbeitung des Moduls. Zusätzlich sollte grundsätzlich die Cachefunktion in den Moduleinstellungen deaktiviert werden. Anhänge Keine Anhänge vorhanden Abbildungs- und Tabellenverzeichnis Abbildungsverzeichnis Es konnten keine Einträge für ein Abbildungsverzeichnis gefunden werden. Tabellenverzeichnis Es konnten keine Einträge für ein Abbildungsverzeichnis gefunden werden. Index Keine Indexeinträge gefunden. Glossar Das nachstehende Glossar erläutert die im Dokument verwendeten Fachbegriffe und Abkürzungen. Begriff / Abkürzung Erklärung