Installation für Agenturen

Bemerkung

Diese Seite richtet sich an Agenturen und technische Shop-Administratoren. Die tägliche Bearbeitung steht getrennt unter Bedienung für Shop-Betreiber.

Für OXID 6 und OXID 7 werden unterschiedliche Pakete ausgeliefert. Installieren Sie nur das zur Shop-Hauptversion und Template-Engine passende Paket.

Paketauswahl

Shop

Paket

Oberfläche

Technischer Hinweis

OXID 6

OXID-6-/Smarty-Ausgabe

Smarty-Storefront und klassischer Admin

Unterstützt ab OXID eShop 6.1; Installation im klassischen Modulverzeichnis.

OXID 7

OXID-7-/Twig-Ausgabe

Twig-Storefront und Twig-Admin

Unterstützt ab OXID eShop 7.1; Installation als Composer-Modul.

Warnung

Die OXID-6- und OXID-7-Pakete sind nicht austauschbar. Installieren Sie für OXID 6 die Smarty-Ausgabe und für OXID 7 die Twig-Ausgabe.

Vorbereitung

Vor der Installation sollten vorhanden sein:

  • vollständiges Backup von Shopdateien und Datenbank,

  • Test- oder Staging-System,

  • SSH- und Composer-Zugriff im Shop-Hauptverzeichnis,

  • ein gültiges, zur Shopversion passendes Modulpaket,

  • Datenbankrechte zum Anlegen von Tabellen und Indizes,

  • funktionierender OXID-E-Mail-Versand und

  • Zugriff auf Storefront und Admin für die technische Abnahme.

Prüfen Sie bei einem angepassten Theme vorab, ob dessen Footer den vom Standardtheme vorgesehenen Service-Block weiterhin ausgibt. Dort ergänzt das Modul den Link Vertrag widerrufen.

OXID 7 installieren

Das OXID-7-Paket verwendet Twig und wird unter vendor/ecs abgelegt.

1. Moduldateien kopieren

Kopieren Sie das Verzeichnis widerrufbutton vollständig nach:

vendor/ecs/widerrufbutton

Im Zielverzeichnis müssen unter anderem metadata.php, composer.json, services.yaml sowie die Ordner src und views liegen.

2. Namespace registrieren

Ergänzen Sie in der composer.json des Shop-Hauptverzeichnisses im Bereich autoload / psr-4 folgenden Eintrag:

"Ecs\\WiderrufButton\\": "vendor/ecs/widerrufbutton/src/"

Sind bereits andere Namespaces vorhanden, bleiben diese erhalten und der neue Eintrag wird mit einem Komma ergänzt:

{
    "autoload": {
        "psr-4": {
            "Vorhandener\\Namespace\\": "vendor/vorhandener/anbieter/modul/src/",
            "Ecs\\WiderrufButton\\": "vendor/ecs/widerrufbutton/src/"
        }
    }
}

Der Eintrag gehört nicht in die mitgelieferte vendor/ecs/widerrufbutton/composer.json. Ein zusätzlicher Eintrag unter require ist bei dieser manuellen Installation nicht notwendig.

3. Autoloader und Modul installieren

Führen Sie im Hauptverzeichnis des OXID-Shops aus:

composer dump-autoload
vendor/bin/oe-console oe:module:install vendor/ecs/widerrufbutton
vendor/bin/oe-console oe:module:activate ecs_widerrufbutton

oe:module:install registriert die Modulkonfiguration und stellt die Modul-Assets bereit. Alternativ kann die Aktivierung nach composer dump-autoload und oe:module:install im Shop-Admin unter Erweiterungen ‣ Module erfolgen.

Beim Aktivieren legt das Modul seine Datenbanktabellen an, leert den Template-Cache und aktualisiert die OXID-Datenbankansichten.

4. Cache leeren und Installation kontrollieren

Leeren Sie den Shopcache:

vendor/bin/oe-console oe:cache:clear

Prüfen Sie anschließend:

  • Das Modul steht unter Erweiterungen ‣ Module auf aktiv.

  • Der Footer zeigt den Link Vertrag widerrufen.

  • Bestellungen ‣ Widerrufe ist sichtbar.

  • An einer Bestellung steht der Tab § Widerruf zur Verfügung.

  • Die drei ecs_widerruf-Tabellen wurden angelegt.

OXID 7 aktualisieren

Deaktivieren Sie das Modul für den Dateiaustausch, ersetzen Sie den kompletten Ordner vendor/ecs/widerrufbutton durch das aktuelle OXID-7-Paket und führen Sie anschließend aus:

composer dump-autoload
vendor/bin/oe-console oe:module:install vendor/ecs/widerrufbutton
vendor/bin/oe-console oe:module:activate ecs_widerrufbutton
vendor/bin/oe-console oe:cache:clear

OXID 6 installieren

Das OXID-6-Paket verwendet Smarty und wird direkt im klassischen Modulverzeichnis abgelegt.

1. Moduldateien kopieren

Kopieren Sie das Verzeichnis WiderrufButton vollständig nach:

source/modules/ecs/WiderrufButton

2. Namespace registrieren

Ergänzen Sie in der composer.json des Shop-Hauptverzeichnisses im Bereich autoload / psr-4 folgenden Eintrag:

"Ecs\\WiderrufButton\\": "./source/modules/ecs/WiderrufButton/"

Sind bereits andere Namespaces vorhanden, bleiben diese erhalten und der neue Eintrag wird mit einem Komma ergänzt:

{
    "autoload": {
        "psr-4": {
            "Vorhandener\\Namespace\\": "./source/modules/vorhandenes/modul/",
            "Ecs\\WiderrufButton\\": "./source/modules/ecs/WiderrufButton/"
        }
    }
}

Der Eintrag gehört in die Projekt-composer.json und nicht in die mitgelieferte Modul-composer.json. Ein zusätzlicher Eintrag unter require ist nicht notwendig.

3. Autoloader und Modulkonfiguration installieren

Führen Sie im Shop-Hauptverzeichnis aus:

composer dump-autoload
vendor/bin/oe-console oe:module:install-configuration source/modules/ecs/WiderrufButton
vendor/bin/oe-console oe:module:activate ecs_widerrufbutton

Alternativ kann die Aktivierung nach der Installation der Modulkonfiguration im Shop-Admin unter Erweiterungen ‣ Module erfolgen.

4. Cache und Installation kontrollieren

Leeren Sie die temporären Shopdateien beziehungsweise den OXID-Cache mit dem in der jeweiligen OXID-6-Umgebung vorgesehenen Verfahren. Prüfen Sie danach:

  • Das Modul ist aktiv.

  • Der Footer zeigt den Link Vertrag widerrufen.

  • Die Widerrufsliste und der zusätzliche Bestell-Tab sind vorhanden.

  • Die drei ecs_widerruf-Tabellen wurden angelegt.

  • Storefront und Admin öffnen ohne Templatefehler.

Bei Linux-Systemen muss die Groß- und Kleinschreibung des Ordnernamens in Pfad, PSR-4-Eintrag und Konsolenbefehl identisch sein.

OXID 6 aktualisieren

Deaktivieren Sie das Modul für den Dateiaustausch, ersetzen Sie den kompletten Ordner source/modules/ecs/WiderrufButton durch das aktuelle OXID-6-Paket und führen Sie anschließend aus:

composer dump-autoload
vendor/bin/oe-console oe:module:install-configuration source/modules/ecs/WiderrufButton
vendor/bin/oe-console oe:module:activate ecs_widerrufbutton

Leeren Sie abschließend die temporären Shopdateien.

Datenbank und gespeicherte Daten

Die Aktivierung legt drei Tabellen an:

ecs_widerruf

Kopfdaten wie Bestellung, Shop, Eingangszeit, Status, Typ, Kundenangaben, Grund und Admin-Notiz.

ecs_widerruf_articles

Die zum Widerruf gespeicherten Bestellpositionen mit Artikelnummer, Titel und Menge.

ecs_widerruf_history

Historie zu Erstellung, Statuswechsel, E-Mail-Versand und Notizen.

Eine Deaktivierung entfernt diese Tabellen und vorhandene Widerrufe nicht. Das ist für Updates beabsichtigt. Soll das Modul endgültig entfernt werden, muss die Agentur Aufbewahrung, Export und datenschutzgerechte Löschung der gespeicherten Kundendaten mit dem Shop-Betreiber abstimmen.

Die vorhandenen Widerrufe, Moduleinstellungen und Historieneinträge bleiben bei einem normalen Update erhalten. Erstellen Sie trotzdem vor jedem Update ein vollständiges Backup von Shopdateien und Datenbank.

Technische Abnahme

Prüfen Sie mindestens folgende Punkte:

  1. Footer-Link auf Desktop und Smartphone sowie in allen aktiven Themes öffnen.

  2. Bestellung als Gast mit E-Mail, Nachname und Bestellnummer finden.

  3. Dasselbe mit einem angemeldeten Kunden und vorausgefüllten Kontodaten testen.

  4. Gesamte Bestellung sowie Teilwiderruf mit mindestens einer Position absenden.

  5. Eingangsbestätigung beim Kunden und neue Widerrufsmeldung am konfigurierten Admin-Empfänger prüfen.

  6. Bestellungen ‣ Widerrufe, Suche, Statusfilter und Link zur Bestelldetailansicht prüfen.

  7. Widerruf bestätigen und ablehnen, jeweils mit optionaler Kunden-E-Mail.

  8. Admin-Notiz, Historie und erneutes Senden einer Status-E-Mail kontrollieren.

  9. Deutsche und englische Storefront sowie das verwendete Admin-Theme testen.

Kontrollieren Sie außerdem, dass ein bestehender, nicht abgelehnter Widerruf eine zweite Kundeneinreichung verhindert. Nach einem abgelehnten Widerruf lässt das Modul eine neue Einreichung für dieselbe Bestellung zu.

Fehlerbehebung für Agenturen

Technische Fehlerbilder

Problem

Prüfung

Modul erscheint nicht im Admin.

Paketpfad, PSR-4-Namespace, composer dump-autoload und den zur OXID-Version passenden Installationsbefehl prüfen.

Footer-Link fehlt.

Aktivierung, Cache und Footer-Block des verwendeten Themes prüfen. Bei eigenen Themes kann eine angepasste Template-Erweiterung nötig sein.

Widerruf kann nicht gespeichert werden.

Vorhandensein und Struktur der drei ecs_widerruf-Tabellen sowie die Schreibrechte des Datenbankbenutzers prüfen.

SQL meldet unterschiedliche Kollationen.

ID-Spalten der Modultabellen mit den OXID-Bestelltabellen vergleichen. Das Paket enthält fix_ecs_widerruf_collation.sql als Arbeitshilfe. Vor Ausführung sichern und das Skript prüfen, da es auch Anweisungen für nicht zum Modul gehörende ecsdesk-Tabellen enthält.

Formular funktioniert, aber E-Mails fehlen.

OXID-Mailkonfiguration, Shop-Info-E-Mail, abweichenden Admin-Empfänger, Spam-Ordner und source/log/oxideshop.log prüfen.

Übergabe an den Shop-Betreiber

Übergeben Sie nach der Abnahme mindestens:

  • Link zur Bedienungsanleitung,

  • festgelegte Empfängeradresse für neue Widerrufe,

  • Verantwortlichkeit und Reaktionsweg für offene Fälle,

  • abgestimmte Bedeutung von Bestätigung und Ablehnung,

  • Hinweis auf die nicht automatisierte Erstattung, Retoure und Lagerkorrektur sowie

  • dokumentierte Lösch- und Aufbewahrungsregeln für Widerrufsdaten.