Neuinstallation¶
- Schritt 1: Modul zur Installation hinzufügen
- Schritt 2: Modul im Shop aktivieren
- Schritt 3: Shopanpassungen installieren
- Schritt 4: TMP-Ordner leeren
- Schritt 5: Lizenzschlüssel eintragen
- Schritt 6: Cronjob einrichten
- Schritt 7: Nachträgliche Anpassung der Installationsumgebung
- Schritt 8: Schnellstart
Schritt 1: Modul zur Installation hinzufügen¶
Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des source- und vendor-Verzeichnisses) diesen Befehl aus, um das Modul Auftragsmanager zur Installation hinzuzufügen:
php composer require d3/ordermanager:^6.2.1.0 --update-no-dev
Note
Achten Sie darauf, dass Composer für die Installation die selbe PHP-Version verwendet, in der auch Ihr Shop ausgeführt wird. Sie erhalten sonst möglicherweise unpassende Modulpakete.
Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die Dokumentation von Composer.
Optional: Providerspezifische Installation¶
Manche Provider erfordern besondere Einstellungen für installierte Module. Treffen Sie bei der Installation auf spezielle Anforderungen, zu denen Sie Unterstützung benötigen, kontaktieren Sie uns bitte für weiteren Support.
Schritt 2: Modul im Shop aktivieren¶
Aktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ Auftragsmanager ] auf den Button [ Aktivieren ].
Alternativ können Sie die Modulaktivierung auch auf der Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des source- und vendor-Verzeichnisses) durchführen.
./vendor/bin/oe-console oe:module:activate d3ordermanager
Enterprise Edition
Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen.
Zur Aktivierung in einem bestimmten Shopmandanten verwenden Sie das --shop-id-Argument (...oe-console --shop-id 1 oe:module...)
Schritt 3: Shopanpassungen installieren¶
Direkt nach der Modulaktivierung startet der Assistent, der Sie durch die Shopanpassung führt. Darin können Sie verschiedene Optionen der Installation wählen.
Den Installationsassistenten finden Sie auch unter den Menüpunkten [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ].
Bei tiefgreifenden Änderungen an Ihrem Shop (z.B. Hinzufügen weiterer Sprachen oder Mandanten) rufen Sie den Installationsassistenten bitte erneut auf, um dann eventuell notwendige Nacharbeiten für das Modul ausführen zu lassen.
Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen.
Der Installationsassistent steht Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des source- und vendor-Verzeichnisses) aus:
./vendor/bin/d3modules_install
Schritt 4: TMP-Ordner leeren¶
Leeren Sie das Verzeichnis tmp über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des source- und vendor-Verzeichnisses) aus:
./vendor/bin/d3cleartmp
Note
Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können.
Schritt 5: Lizenzschlüssel eintragen¶
Das Modul verwendet Lizenzschlüssel, um die Lizenzverwaltung für Sie und auch für uns einfacher zu gestalten. Hierbei haben Sie je nach Modul die Wahl zwischen einer kostenfreien Testlizenz und einer Lizenz für den Einsatz im Livebetrieb.
Speziell der Auftragsmanager wird in unterschiedlichen (teilweise kostenfreien) Editionen für den Livebetrieb angeboten. Besuchen Sie unseren Moduleshop, um mehr darüber zu erfahren.
Rufen Sie zum Anfordern des Lizenzschlüssels die Modulverwaltung im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] auf. Klappen Sie den Eintrag des jeweiligen Moduls aus. Sofern erforderlich, können Sie hier den Lizenzassistenten starten, der schnell und einfach ihr Modul aktiviert.
./vendor/bin/oe-console d3:modcfg:license:set <shop id> <module id> <license key>
Schritt 6: Cronjob einrichten¶
Legen Sie den Cronjob für die automatische Bearbeitung der eingerichteten Aufträge an. Die für die Anlage benötigten Daten finden Sie im Adminbereich des Moduls unter [ (D3) Module ] -> [ Auftragsmanager ] -> [ Einstellungen ] -> [ Grundeinstellungen ]. Weitere Informationen zum Anlegen von Cronjobs finden Sie in unserer FAQ.
Warning
Sie sollten unbedingt den Aufruf von .sh-Dateien via Browser verhindern, so dass kein Unbefugter die Datei von außen aufrufen kann. Dazu können Sie z.B. die .htaccess-Datei des Shops um folgende Zeilen erweitern:
<Files *.sh>
Require all denied
</Files>
Updatefähigkeit¶
Bei individuellen Änderungen von Moduldateien empfehlen wir, jeweils die Überladungsmöglichkeiten des Shops dafür zu verwenden. So brauchen Sie die originalen Moduldateien nicht verändern und erhalten sich so die Updatefähigkeit des Shops und des Moduls. Beachten Sie, dass Moduldateien bei Updateinstallationen überschrieben werden.
Weitere Informationen zu den Überladungsmöglichkeiten verschiedener Dateien finden Sie in unserer FAQ.
Schritt 7: Nachträgliche Anpassung der Installationsumgebung¶
Die Installation prüft die Anforderungen des Moduls zum jeweiligen Zeitpunkt. Sollen später Einstellungen der Umgebung geändert werden (z.B. neue PHP-Version), sollte vorab über Composer geprüft werden, ob die bisherige Paketzusammenstellung weiterhin gültig ist und auch die neuen Anforderungen erfüllt werden. Unter Umständen ist eine Aktualisierung der Paketzusammenstellung nötig.
Schritt 8: Schnellstart¶
Das Modul Auftragsmanager bringt einen umfangreichen Adminbereich mit, in dem Sie die Konfigurationseinstellungen des Moduls setzen können. Über das Menü [ (D3) Module ] -> [Auftragsmanager] -> [Einstellungen] erreichen Sie die Einstellseiten. Arbeiten Sie idealerweise die Optionen einmal durch. Hinweise zu den einzelnen Einstellungen finden Sie in dem dahinter stehenden Fragezeichenfeld. Durch einen Klick darauf öffnet sich der Hinweistext.
Richten Sie nun die Aufgaben ein, die der "Auftragsmanager" für Sie durchführen soll. In der Standardinstallation finden Sie einige Aufgaben als Beispiel vorbereitet. Darin können Sie sich die möglichen Konfigurationen ansehen, diese auf Ihre Bedürfnisse anpassen und auch neue Aufgaben anlegen.
Testen Sie die Aufgaben mit dem modulweiten Debug-Schalter ([ (D3) Module ] -> [ Auftragsmanager ] -> [ Einstellungen ]) und / oder der Mailsende-Option an jeder Aufgabe ([ (D3) Module ] -> [ Auftragsmanager ] -> [ Aufgaben ] -> [ Stamm ]). Diese Optionen sind genauer im jeweils dahinter stehenden Fragezeichenfeld erklärt. Aktivieren Sie die Ausführung der Aufgaben bitte erst, wenn Sie sicher sind, dass alle Optionen richtig sind. Wir übernehmen keine Gewährleistung für evtl. falsche oder verlorene Daten bei fehlerhaft eingestellten Aufgaben.
Weitere Details zur Einrichtung des "Auftragsmanagers" entnehmen Sie bitte dessen Handbuch zum Modul.