Installation für Agenturen

Bemerkung

Diese Seite richtet sich an Agenturen und technische Shop-Administratoren. Für die Konfiguration im Shop-Admin wechseln Sie zu Bedienung und Einstellungen.

Verwenden Sie ausschließlich das Paket, das zur eingesetzten OXID-Hauptversion passt.

Welches Paket wird benötigt?
Shop	Modulversion	Modultechnik	Unterstützte Themes	Installation
OXID 6	1.0.x	Smarty-Modul im klassischen Modulverzeichnis	Wave und Flow	Dateien kopieren, Namespace registrieren, Modulkonfiguration installieren
OXID 7	2.0.x	Composer-Modul mit Twig-Erweiterungen	Apex mit Twig-Admin-Theme	Dateien kopieren, Namespace registrieren und über `oe-console` installieren

Warnung

Die Pakete für OXID 6 und OXID 7 sind nicht austauschbar. Ein OXID-6-Paket darf nicht in OXID 7 installiert werden und umgekehrt.

Vorbereitung

Vor der Installation sollten folgende Punkte geklärt sein:

vollständiges Backup von Shopdateien und Datenbank,
Test- oder Staging-System für die erste Installation,
Schreibzugriff auf das Shopprojekt,
Composer-Zugriff im Hauptverzeichnis des Shops und
Datenbankrechte zum Anlegen beziehungsweise Ändern von Spalten und Ansichten.

Die Aktivierung ergänzt automatisch folgende Datenbankfelder:

oxmanufacturers.ECSEULABELNAME
oxmanufacturers.ECSEULABELYEARS
oxmanufacturers.ECSEULABELURL
oxarticles.ECSEULABELYEARS

Vorhandene Felder werden erkannt und nicht doppelt angelegt.

OXID 7 installieren

Voraussetzungen

OXID eShop 7.x
PHP ab 8.1
OXID Twig Component 2.x
Apex-Storefront und Twig-Admin-Theme

1. Moduldateien kopieren

Kopieren Sie das Verzeichnis eu-labels vollständig nach:

vendor/ecs/eu-labels

Bei Linux-Systemen muss die Groß- und Kleinschreibung exakt stimmen. Im Zielverzeichnis müssen unter anderem metadata.php, composer.json sowie die Ordner src, views und out liegen.

2. Namespace registrieren

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

"Ecs\\EuLabels\\": "vendor/ecs/eu-labels/src/"

Sind bereits andere Namespaces eingetragen, werden diese beibehalten und der neue Eintrag wird mit einem Komma ergänzt:

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

Der Eintrag gehört nicht in die mitgelieferte vendor/ecs/eu-labels/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/eu-labels
vendor/bin/oe-console oe:module:activate ecs_eulabels

oe:module:install registriert die Modulkonfiguration und stellt die Assets für den Shop bereit. Die Modul-ID für Aktivierung und Support lautet immer ecs_eulabels.

Alternativ kann die Aktivierung nach composer dump-autoload und oe:module:install im Shop-Admin unter Erweiterungen ‣ Module erfolgen.

4. Cache leeren und Installation kontrollieren

Leeren Sie zunächst den Shopcache:

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

Prüfen Sie anschließend:

Das Modul steht unter Erweiterungen ‣ Module auf aktiv.
Das Modul wird als aktiv angezeigt.
Die Bereiche für Gewährleistungslabel, GARAN-Label und Bestellbestätigung sind sichtbar.
Bei Herstellern und Artikeln erscheinen die neuen GARAN-Felder.
source/out/modules/ecs_eulabels ist vorhanden beziehungsweise korrekt verknüpft.
Detailseite, Warenkorb und letzter Bestellschritt lassen sich fehlerfrei öffnen.

OXID 7 aktualisieren

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

composer dump-autoload
vendor/bin/oe-console oe:module:install vendor/ecs/eu-labels
vendor/bin/oe-console oe:module:activate ecs_eulabels
vendor/bin/oe-console oe:cache:clear

Die vorhandenen Moduleinstellungen sowie Hersteller- und Artikelwerte bleiben bei einem normalen Update erhalten.

OXID 6 installieren

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

1. Moduldateien kopieren

Kopieren Sie das Verzeichnis EuLabels vollständig nach:

source/modules/ecs/EuLabels

Bei Linux-Systemen muss die Groß- und Kleinschreibung exakt stimmen. Im Zielverzeichnis müssen unter anderem metadata.php, composer.json sowie die Ordner Controller, Core, Model, views und out liegen.

2. Namespace registrieren

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

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

Sind bereits andere Namespaces eingetragen, werden diese beibehalten und der neue Eintrag wird mit einem Komma ergänzt:

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

Der Eintrag gehört nicht in die mitgelieferte Modul-composer.json. Ein zusätzlicher Eintrag unter require ist bei dieser manuellen Installation 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/EuLabels
vendor/bin/oe-console oe:module:activate ecs_eulabels

Alternativ kann die Aktivierung nach dem Aktualisieren des Autoloaders 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 Umgebung vorgesehenen Verfahren. Prüfen Sie danach:

Das Modul ist aktiv.
Die Datenbankfelder und Datenbankansichten wurden angelegt beziehungsweise aktualisiert.
Die Modul-Assets unter source/modules/ecs/EuLabels/out sind erreichbar.
Wave oder Flow zeigt Detailseite, Warenkorb und Checkout ohne Templatefehler.
Die zusätzlichen Hersteller- und Artikelfelder sind im Admin sichtbar.

OXID 6 aktualisieren

Deaktivieren Sie das Modul für den Dateiaustausch, ersetzen Sie anschließend den kompletten Modulordner durch das passende OXID-6-Paket und führen Sie danach erneut aus:

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

Leeren Sie abschließend die temporären Shopdateien. Die in der Datenbank gespeicherten GARAN-Werte werden durch Deaktivierung und Update nicht entfernt.

Technische Abnahme

Führen Sie unabhängig von der Shopversion mindestens folgende Prüfungen durch:

Körperlichen Artikel auf Detailseite, im Warenkorb und im letzten Bestellschritt öffnen.
Digitalen Artikel beziehungsweise rein digitalen Warenkorb gegenprüfen.
Kompakte und vollständige Darstellung testen.
Einen Artikel mit wirksamer Herstellergarantie prüfen.
Eine Testbestellung einschließlich Kunden-E-Mail und SVG-Anhängen durchführen.
Deutsche und eine weitere aktive Shop-Sprache testen.
Darstellung auf Desktop und Smartphone kontrollieren.

Übergabe an den Shop-Anwender

Nach der technischen Abnahme benötigt der Shop-Anwender keine Server- oder Composer-Zugänge. Für die fachliche Einrichtung genügt die Seite Bedienung und Einstellungen.