# Review Reminder ## Modulbeschreibung Das **"Review Reminder"** Modul ermöglicht es, individuelle E-Mails an Benutzer zu versenden, um diese aufzufordern eine Bewertung für den Shop abzugeben. Sie können dabei den Zeitraum in Tagen festlegen, welcher ab der Bestellung oder den Versand des Artikels vergangen sein muss, damit der Benutzer eine E-Mail erhält, welche ihn auffordert eine Bewertung abzugeben. Außerdem ist es möglich festzulegen, dass hierfür nur Bestellungen ab einem bestimmten Datum berücksichtigt werden. Der Text der E-Mail kann in den (V)CMS-Snippets mit dem Ident, der mit `dd_review_reminder` anfängt bearbeitet werden. Das Modul ist erhältlich auf ## Systemvoraussetzungen ### PHP-Version OXID 4 & 5 * PHP 5.6 ### PHP-Version OXID 6 * PHP 7.0 (OXID 6.0.x) * PHP 7.1 (OXID 6.1.x) * PHP 7.2 - 7.4 (OXID 6.2.x - 6.3.x) * PHP 8.0 (OXID 6.3.x - 6.4.x) * PHP 8.1 (OXID 6.5.x) ### Webserver-Konfiguration * IonCube Loader (mind. v5.0) ### Kompatibel mit den OXID Versionen * OXID CE/PE 4.9.x bis 4.10.x * OXID EE 5.2.x bis 5.3.x * OXID CE/PE/EE 6.0.x bis 6.5.x ## Installation ### Ab OXID 6 1. Falls noch nicht geschehen, laden Sie bitte zunächst das digidesk Basis-Modul herunter und installieren Sie es gemäß der enthaltenen Installationsanleitung.\ Sie erhalten dieses unter:[ https://www.digidesk.de/produkte/basis-modul/](https://www.digidesk.de/produkte/basis-modul/) 2. Für dieses Modul erstellen Sie nun einen weiteren Ordner "reviewreminder" im Ordner "packages/digidesk", in den die heruntergeladene Zip-Datei entpackt wird. 3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus `composer require digidesk/reviewreminder -n` 4. Nun kann das Modul im OXID eShop Admin aktiviert werden. 5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren. ### Bis OXID 5.3.x/4.10.x 1. Falls noch nicht geschehen, laden Sie bitte zunächst das digidesk Basis-Modul herunter und installieren Sie es gemäß der enthaltenen Installationsanleitung. Sie erhalten dieses unter: [https://www.digidesk.de/produkte/basis-modul](https://www.digidesk.de/produkte/basis-modul/) 2. Fügen Sie den Inhalt des Ordnerverzeichnisses des Moduls "modules/digidesk/" via FTP/SFTP unter dem gleichnamigen Pfad in Ihren Shop ein. 3. Aktivieren Sie das Modul im OXID eShop Admin 4. Ggf. Tmp-Verzeichnis leeren und Views neu generieren 5. Bitte fahren Sie nun mit der Einrichtung des Moduls fort ## Update ### Ab OXID 6 1. Entpacken Sie die neue Modulversion in den Ordner "packages/digidesk/reviewreminder". 2. Deaktivieren Sie das Modul im OXID eShop Admin. 3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus: `composer update digidesk/reviewreminder` Die Frage, ob Dateien des Pakets überschrieben werden sollen, bestätigen Sie bitte mit "Y". 4. Aktivieren Sie das Modul im OXID eShop Admin. 5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren. ### Ab OXID 5.3.x/4.10.x 1. Bitte aktualisieren Sie das Basis-Modul gemäß der darin enthaltenen Installationsanleitung. 2. Deaktivieren Sie dieses Modul im OXID eShop Admin. 3. Fügen Sie den Inhalt des Ordners "modules/digidesk/" via FTP/SFTP unter dem gleichnamigen Pfad in Ihren Shop ein und überschreiben Sie dabei die vorhandenen Dateien des Moduls. 4. Aktivieren Sie dieses Modul im OXID eShop Admin. 5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren. ## Funktionsbeschreibung Das **"Review Reminder"** Modul ermöglicht es, individuelle E-Mails an Benutzer zu versenden, um diese aufzufordern eine Bewertung für den Shop abzugeben. Dabei wird nach Ablauf eines festgelegten Zeitraums nach der Bestellung oder Versand eine E-Mail an den Benutzer versendet, welche diesen auffordert eine Bewertung abzugeben. ## Einrichtung des Cronjobs Der Versand von den E-Mails an die Kunden kann mit einem Klick auf den Link unter den **Moduleinstellungen -> Stamm -> Manueller Versand** des Moduls oder durch Eingabe von einem Link im Browser wie im folgendem Beispiel angestoßen werden: `https://ihre-shopurl/?cl=dd_reviewreminder&key=123456789` Ersetzen Sie bitte **`https://ihre-shopurl`** und **`123456789`** mit Ihren Daten. Den Key finden Sie unter Moduleinstellungen vom Basis-Modul. Auf die Dauer empfehlen wir hierfür einen **Cronjob** anzulegen, damit die E-Mails in gewissen Zeitabständen automatisch versendet werden. Ab Modul Version 2.2.0 Um den Cronjob auszuführen muss folgender Befehl aus dem Hauptverzeichnis Ihres Shops ausgeführt werden: ``` php source/modules/digidesk/dd_reviewreminder/bin/cron.php --key=IHR_CRONKEY ``` Ersetzen Sie dabei **`IHR_CRONKEY`** durch den Key den Sie in den Modul-Einstellungen des **Basis-Moduls** definiert haben. Achten Sie dabei darauf, dass die auf der Kommandozeile verwendete PHP-Version der Version entspricht die in Ihrem Shop verwendet wird. Um diesen Cronjob automatisiert auszuführen empfehlen wir bei Linux Systemen **"**[**crontab**](https://wiki.ubuntuusers.de/Cron/)**"**. Für crontab sieht der Eintrag z.B. folgendermaßen aus: ``` 0 0 * * * php /source/modules/digidesk/dd_reviewreminder/bin/cron.php --key=IHR_CRONKEY ``` {% hint style="info" %} **Bitte beachten Sie:**\ Im oben stehenden Crontab Eintrag muss **\** durch den absoluten Pfad zum Hauptverzeichnis Ihres Shops ersetzt werden! {% endhint %} Dieses Beispiel startet den Cronjob Script einmal täglich um Mitternacht. ## Modul konfigurieren 1. Navigieren Sie im OXID eShop Admin zu ***Erweiterungen > Module*** 2\. Wählen Sie das Modul "**Review Reminder**" aus der Liste aus und öffnen Sie dann den Reiter "**Einstell.**" 3\. Unter dem Punkt "**Allgemeine Konfiguration**" sind die Optionen selbsterklärend ![](/files/u8sikosMZfFQU3174mVJ) 4\. Unter dem Punkt "**Test-Modus**" können Sie den Testmodus aktivieren und die noch nicht versandte E-Mails an eine bestimmte E-Mail Adresse senden, der Status der Datensätze wird dabei nicht verändert. ![](/files/CC9vFbjHPivr0uM1V1Hr) 5\. Unter dem Punkt "**Cronjob**" können Sie diverse Einstellungen bezüglich des Cronjobs vornehmen. ![](/files/fbDnwupYuy1WsCNceSOk) ## CMS-Seiten anpassen CMS Seiten beinhalten 4 Snippets und werden für die Bildung der E-Mails verwendet. Die Snippets mit der Anmerkung "Plain" sind reine Texte ohne Formatierung. 1. Navigieren Sie im OXID eShop Admin zu **Kun*****deninformation > CMS-Seiten*** 2. Sie haben dort die Möglichkeit, den Inhalt der E-Mail individuell anzupassen. Wählen Sie dazu einfach eine der CMS-Seiten zur Bearbeitung aus, um den Text im Editor anpassen zu können 3. Anschließend übernehmen Sie Ihre Änderungen mit dem "**Speichern**" Button ![](/files/HzTHBrnP2xIWgZVioUw3) ## Admin-Übersicht In der Listenansicht sehen Sie die Liste mit anstehenden Aufforderungen, falls diese noch nicht versendet wurden. Hier besteht die Möglichkeit diese aus der Liste aus einzeln manuell zu versenden. ![](/files/NWSD2oSC3YJCwGo2aDYK) ## Hilfe & Support Haben Sie Fragen oder benötigen Sie Hilfe bei der Installation? Gerne bieten wir Ihnen auch einen Installationsservice an. Kontaktieren Sie uns einfach über eine der unten stehenden Adressen. * E-Mail: **** * Telefon: **+49 (0) 5246 / 9099110** * Kontaktformular: [**http://www.digidesk.de/kontakt**](http://www.digidesk.de/kontakt) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.digidesk.de/moduldokumentationen/review-reminder.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.