Installation für Agenturen

Diese Anleitung richtet sich ausschließlich an Agenturen und technische Shop-Administratoren mit Datei-, Composer-, Konsolen- und Datenbankzugriff. Einstellungen und tägliche Abläufe für Shop-Betreiber sind unter Bedienung für Shop-Betreiber beschrieben.

Paket passend zur OXID-Hauptversion wählen

Verwenden Sie ausschließlich das zur Shop-Hauptversion gehörende Paket:

Paketauswahl
Shop	Ausgabe	Ziel
OXID eShop 7 ab 7.1	Twig	`vendor/ecs/adminlists`
OXID eShop 6 ab 6.1	Smarty	`source/modules/ecs/AdminLists`

Warnung

Die OXID-6- und OXID-7-Pakete sind nicht austauschbar. AdminLists verändert Bestell-, Kunden- und Artikeldaten direkt aus den Admin-Listen und führt auf Wunsch SQL-Massenänderungen an der Artikeltabelle aus. Sichern Sie vor Installation und Update mindestens die Projekt-composer.json, die Shopdatenbank, die OXID-Konfiguration und den vorhandenen Modulordner.

Voraussetzungen

Prüfen Sie vor der Installation:

Das OXID-7-Paket verlangt PHP ab Version 8.0; maßgeblich bleiben die höheren Anforderungen der eingesetzten OXID-Version.
Ein vollständiges Datenbankbackup und ein Wiederherstellungsweg wurden geprüft.
Der Webserver-PHP-Prozess benötigt Schreibrechte auf das Compile-Verzeichnis.
Optional: Die Spalte „Fällig“ und die rote Überfällig-Markierung in der Bestelliste setzen ein aktives easyDocuments-Modul (ecs_easydocuments) ab Version 2.4.4 voraus.
Optional: Für die Versandart „Zustimmung mit ShippingMailConsent“ bei der E-Mail-Übermittlung an Paketdienste muss das entsprechende eComStyle-Modul installiert sein, das das Feld ecsmailconsent an der Bestellung pflegt.

OXID 7 installieren

1. Moduldateien kopieren

Kopieren Sie das vollständige Twig-Paket nach:

vendor/ecs/adminlists

Prüfen Sie danach insbesondere metadata.php, composer.json, services.yaml, assets, src und views des ausgelieferten OXID-7-Pakets.

2. Namespace in der Projekt-composer.json registrieren

Ergänzen Sie in der composer.json des Shop-Hauptverzeichnisses unter autoload / psr-4:

"Ecs\\AdminLists\\": "vendor/ecs/adminlists/src/"

Vollständiges Beispiel mit einem vorhandenen Namespace:

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

Der Eintrag gehört in die Projekt-composer.json, nicht in die Datei des Moduls. Vorhandene Namespaces bleiben erhalten. Ein zusätzlicher Eintrag unter require für das Modul selbst ist bei dieser manuellen Installation nicht notwendig.

3. Autoloader und Modul installieren

Führen Sie im Shop-Hauptverzeichnis aus:

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

Alternativ kann die Aktivierung nach oe:module:install im Admin unter Erweiterungen ‣ Module erfolgen.

4. OXID-7-Installation kontrollieren

Prüfen Sie mindestens:

Das Modul ist im Admin sichtbar und aktiv; die Moduleinstellungen zeigen die vier Gruppen „Bestelliste“, „Kundenliste“, „Artikelliste“ und „Artikelliste CSV“.
Die Bestellübersicht zeigt die erweiterte Liste mit Spaltenfiltern, Ordnerauswahl und den CSV-Export-Schaltern der aktivierten Paketdienste.
Die Benutzerliste zeigt Gruppenauswahl und Umsatzspalte, die Artikelliste die editierbaren Eingabefelder.
Der Shopcache wurde geleert.

OXID 6 installieren

1. Moduldateien kopieren

Kopieren Sie das vollständige Smarty-Paket nach:

source/modules/ecs/AdminLists

Prüfen Sie mindestens metadata.php, composer.json, Controller, Core, Model und views. Die Klassen des Smarty-Pakets liegen direkt im Modulordner, nicht in einem src-Unterverzeichnis.

2. Namespace in der Projekt-composer.json registrieren

Ergänzen Sie in der composer.json des Shop-Hauptverzeichnisses unter autoload / psr-4:

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

Vollständiges Beispiel:

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

Alle vorhandenen Namespaces bleiben erhalten. Ein zusätzlicher Eintrag unter require ist für die manuelle 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/AdminLists
vendor/bin/oe-console oe:module:activate ecs_adminlists

Leeren Sie anschließend die temporären Shopdateien beziehungsweise den OXID-Cache mit dem in der jeweiligen OXID-6-Umgebung vorgesehenen Verfahren.

4. OXID-6-Installation kontrollieren

Prüfen Sie mindestens:

Modul und Moduleinstellungen sind im Admin sichtbar.
Bestell-, Benutzer- und Artikelliste zeigen die erweiterten Ansichten ohne Smarty-Fehler.
Die OXID-Views wurden aktualisiert und die temporären Shopdateien geleert.

Datenbankänderung und Aktivierungsereignisse

Das Modul legt keine eigenen Datenbankfelder oder Tabellen an. Bei der Aktivierung leert es das Compile-Verzeichnis und regeneriert die Datenbank-Views. Bei der Deaktivierung entfernt es verbliebene Template-Block-Einträge des Moduls aus oxtplblocks, leert das Compile-Verzeichnis und regeneriert die Views erneut:

DELETE FROM oxtplblocks WHERE OXMODULE = 'ecs_adminlists';

In die Bestelltabelle schreibt das Modul ausschließlich vorhandene OXID-Felder wie oxpaid, oxsenddate und oxfolder. Die Versand-CSV-Exporte lesen Liefer- und Rechnungsadresse, Bestellpositionen sowie Shopdaten, ohne sie zu verändern. Für die Funktionen werden keine zusätzlichen Felder benötigt; optionale Zusatzspalten wie ecsbillpayto oder ecsmailconsent stammen aus den genannten Partnermodulen.

Modul aktualisieren

OXID 7 aktualisieren

Deaktivieren Sie das Modul für den Dateiaustausch. Ersetzen Sie den vollständigen Ordner vendor/ecs/adminlists durch das aktuelle OXID-7-/Twig-Paket. Führen Sie danach aus:

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

OXID 6 aktualisieren

Deaktivieren Sie das Modul und ersetzen Sie source/modules/ecs/AdminLists vollständig durch das aktuelle OXID-6-/Smarty-Paket. Führen Sie danach aus:

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

Leeren Sie anschließend die temporären Shopdateien.

Nach jedem Update

Prüfen Sie die Moduleinstellungen; neue Paketvorgaben setzen vorhandene Betreiberwerte nicht automatisch zurück.
Öffnen Sie Bestell-, Kunden- und Artikelliste und testen Sie Filter, Spaltenauswahl und einen CSV-Export.
Testen Sie die Statusaktionen (bezahlt, versandt, Ordnerwechsel) an einer Testbestellung.

Datenaufbewahrung bei Deaktivierung

Eine normale Deaktivierung stellt die OXID-Standardlisten wieder her und bewahrt sämtliche Bestell-, Kunden- und Artikeldaten auf. Das Modul speichert keine eigenen Datensätze; die Moduleinstellungen bleiben in der OXID-Konfiguration erhalten und werden bei einer erneuten Aktivierung wieder verwendet. Es gibt keine automatische Bereinigung der Moduleinstellungen.