M0035 Archivierung für Gambio
Handbuch
1. Wofür Sie das Modul einsetzen
Ein Shop, der einige Jahre läuft, schleppt eine wachsende Menge an Altdaten mit sich herum: Bestellungen aus längst abgeschlossenen Geschäftsjahren, dazu die passenden Rechnungen und Lieferscheine, und vor allem jede einzelne E-Mail, die der Shop je verschickt hat – inklusive Anhängen. Diese Daten müssen aufbewahrt werden, sie müssen aber nicht dauerhaft in der Shopdatenbank stehen.
Genau das leistet das Modul: Es nimmt einen von Ihnen gewählten Bereich, packt alles Zusammengehörige in eine Archivdatei und entfernt es anschließend aus der Datenbank. Brauchen Sie die Daten später doch wieder, holt dasselbe Modul sie aus dem Archiv zurück in den Shop.
1.1 Was archiviert wird
Bei Bestellungen wird nicht nur der Bestellkopf gesichert, sondern alles, was daran hängt: die bestellten Artikel mit ihren Eigenschaften und Mengeneinheiten, der Statusverlauf, die Summenzeilen, die Zahlungsdaten der gängigen Zahlarten, Sendungsnummern, Widerrufe sowie die im Shop erzeugten Rechnungs- und Lieferschein-PDFs. Auch Kundenuploads aus dem Produkt-Konfigurator wandern mit ins Archiv.
Bei E-Mails werden die Nachricht selbst, die zugehörigen Kontaktdaten und sämtliche Dateianhänge gesichert. Die Anhänge liegen anschließend nicht mehr im Uploadordner des Shops, sondern im Archiv.
1.2 Was das für Ihren Shop bedeutet
Eine kleinere Datenbank ist spürbar schneller – bei der Bestellübersicht im Adminbereich, bei Auswertungen und bei jedem Backup. Und ein Uploadordner, der nicht mehr jede Mailanlage der letzten acht Jahre enthält, spart Platz und Sicherungszeit.
Damit ausgelagerte Daten trotzdem greifbar bleiben, führt das Modul ein durchsuchbares Verzeichnis über alle Archive und kann deren Inhalt anzeigen, ohne sie dafür zurückholen zu müssen. Für die alltägliche Nachfrage genügt das – die Wiederherstellung brauchen Sie nur, wenn die Daten tatsächlich wieder im Shop stehen sollen.
2. Einstellungen
2.1 Wo Sie die Einstellungen finden
Die Einstellungen liegen im Adminbereich im Menü „Xycons-Module“ unter „Kundenkonto / Setups“. Dort finden Sie einen Reiter mit dem Modultitel „Archivierung“.
2.2 Modulstatus
Über den Modulstatus schalten Sie das Modul insgesamt ein oder aus. Im ausgeschalteten Zustand passiert nichts: Es wird weder archiviert noch wiederhergestellt, und die Arbeitsoberfläche weist Sie mit einem rot hinterlegten Hinweis darauf hin. Nach der Installation ist das Modul bewusst ausgeschaltet – Sie entscheiden, wann es losgeht.
2.3 Ziel-Pfad des Archivordners
Dieses Feld können Sie nicht ändern – es zeigt Ihnen nur an, wo die Archivdateien liegen. Den Ordner bestimmt und erzeugt das Modul selbst, ebenso die benötigte Unterstruktur. Sie müssen weder Verzeichnisse von Hand anlegen noch Dateirechte setzen.
Der Ordner liegt innerhalb Ihres Shopverzeichnisses. Das ist Absicht: Viele Hostingpakete installieren den Shop direkt in das Kontoverzeichnis, sodass es dort schlicht kein „außerhalb“ gibt. Ein Ablageort, den ein Teil der Betreiber gar nicht bereitstellen kann, wäre keine Hilfe.
Geschützt wird die Ablage deshalb auf drei Wegen:
- Der Ordnername enthält eine Zufallskennung, die bei Ihrer Installation einmalig vergeben wurde. Er lässt sich nicht erraten.
- Das Modul legt in jedem Archivordner Sperrdateien ab, die einen Zugriff über den Browser unterbinden und eine Verzeichnisauflistung verhindern.
- Es prüft laufend, ob diese Sperrdateien noch vorhanden und unverändert sind, und stellt sie andernfalls sofort wieder her – etwa nach einem Serverumzug oder einer unvollständigen Rücksicherung.
2.4 Sicherheitsdatum für Bestellungen und E-Mails
Mit den beiden Sicherheitsdaten ziehen Sie eine Grenze, hinter die niemand versehentlich greifen kann. Tragen Sie ein Datum ein, werden Bestellungen beziehungsweise E-Mails, die jünger als dieses Datum sind, grundsätzlich nicht archiviert – auch dann nicht, wenn jemand versucht, einen größeren Bereich auszuwählen.
Das ist der wirksamste Schutz gegen den klassischen Fehlgriff, bei dem versehentlich das laufende Geschäftsjahr mit ins Archiv wandert. Lassen Sie die Felder leer, wenn Sie keine Begrenzung wünschen.
Im Setup folgen darunter noch zwei weitere Gruppen: die Einstellungen für den automatischen Betrieb (Kapitel 7.1) und die Aufbewahrungsfrist (Kapitel 8.1). Beide sind so vorbelegt, dass sich zunächst nichts von selbst tut – Sie schalten sie bewusst frei.
3. Die Arbeitsoberfläche
Die eigentliche Arbeit findet nicht im Setup statt, sondern auf einer eigenen Seite. Sie erreichen sie im Adminbereich über das Xycons-Menü mit dem Eintrag „Archivierung“. Dort gibt es vier Reiter:
- E-Mails und Bestellungen – hier wird archiviert und wiederhergestellt (Kapitel 4 und 5).
- Archiv – hier suchen Sie in bereits ausgelagerten Daten und sehen sie an, ohne sie zurückzuholen (Kapitel 6).
- Aufbewahrung – hier sehen Sie abgelaufene Aufbewahrungsfristen und das Protokoll aller Vorgänge (Kapitel 8).
Die beiden erstgenannten Reiter sind gleich aufgebaut. Oben sehen Sie eine Übersicht, was sich derzeit überhaupt bearbeiten lässt:
- Archivierbar – der Bereich, der aktuell in der Datenbank liegt und ausgelagert werden kann. Ist ein Sicherheitsdatum gesetzt, ist dieser Bereich bereits entsprechend beschnitten und ein Hinweis nennt Ihnen das wirksame Datum.
- Wiederherstellbar – der Bereich, für den im Archivordner tatsächlich Archivdateien vorliegen.
Darunter wählen Sie den gewünschten Bereich von/bis, entscheiden sich für Archivieren oder Wiederherstellen und lassen sich mit der Schaltfläche „Vorschau ermitteln“ zunächst anzeigen, wie viele Datensätze betroffen wären. Erst danach erscheint die Schaltfläche START.
4. E-Mails archivieren und zurückholen
E-Mails werden nach Datum ausgewählt und tageweise verarbeitet. Öffnen Sie den Reiter „E-Mails“.
4.1 Archivieren
Das Modul schlägt Ihnen als Startdatum den Tag der ältesten vorhandenen Mail und als Enddatum den Tag der jüngsten Mail vor – Letzteres unter Berücksichtigung des Sicherheitsdatums. Über die beiden Datumsfelder wählen Sie den gewünschten Zeitraum.
Wählen Sie „Archivieren“ und lassen Sie die Vorschau ermitteln. Sie sehen dann, wie viele E-Mails im gewählten Zeitraum liegen. Mit START beginnt der Lauf: Für jeden Tag entsteht eine Archivdatei, die alle Mails dieses Tages samt Anhängen enthält; anschließend werden die Daten aus dem Shop entfernt.
4.2 Wiederherstellen
Wählen Sie „Wiederherstellen“ und den Zeitraum, den Sie zurückholen möchten. Die Vorschau zeigt Ihnen, wie viele Mails in den vorhandenen Archivdateien dieses Zeitraums stecken. Mit START werden sie wieder in den Shop eingespielt, die Anhänge landen zurück im Uploadordner.
Die Archivdatei bleibt dabei erhalten. Sie wird lediglich umbenannt und mit dem Zeitpunkt der Wiederherstellung gekennzeichnet, damit Sie später sehen, was bereits zurückgeholt wurde.
5. Bestellungen archivieren und zurückholen
Bestellungen werden nicht nach Datum, sondern nach Bestellnummer ausgewählt. Öffnen Sie den Reiter „Bestellungen“.
5.1 Archivieren
Als Von-/Bis-Werte sind die kleinste und die größte archivierbare Bestellnummer vorbelegt. Ist ein Sicherheitsdatum gesetzt, reicht der obere Wert nur bis zur letzten Bestellung, die alt genug ist.
Wählen Sie „Archivieren“, lassen Sie die Vorschau ermitteln und starten Sie den Lauf. Für jede Bestellung entsteht eine eigene Archivdatei, die die Bestellung mit allem Zubehör enthält – einschließlich der zugehörigen Rechnungs- und Lieferschein-PDFs, die dabei aus dem Exportordner des Shops entfernt werden.
5.2 Wiederherstellen
Wählen Sie „Wiederherstellen“ und den Nummernbereich. Das Modul berücksichtigt dabei nur Bestellnummern, für die auch tatsächlich eine Archivdatei vorliegt – Lücken im Bereich stören also nicht. Nach dem Lauf steht die Bestellung wieder vollständig im Shop, die Belege liegen wieder im Exportordner.
Existiert eine Bestellung mit derselben Nummer bereits wieder im Shop, wird sie nicht überschrieben; die Wiederherstellung überspringt sie.
6. Das Archiv durchsuchen und ansehen
Ausgelagerte Daten sollen auffindbar bleiben, ohne dass Sie sie dafür jedes Mal in den Shop zurückholen müssen. Genau dafür gibt es den Reiter „Archiv“.
6.1 Suchen
Wählen Sie zunächst den Bereich – Bestellungen oder E-Mails. Bei Bestellungen können Sie nach Bestellnummer, Kundenname oder E-Mail-Adresse suchen; zusätzlich lässt sich der Zeitraum eingrenzen. Bei E-Mails wird nach dem Datumsbereich gesucht, da ein Tagesarchiv immer alle Nachrichten dieses Tages enthält.
Die Trefferliste zeigt Ihnen zu jeder Bestellung Datum, Name, E-Mail-Adresse und Summe – all das steht im Verzeichnis und muss nicht erst aus der Archivdatei geholt werden. Wurde ein Archiv bereits einmal wiederhergestellt, steht das ebenfalls dabei.
6.2 Ansehen, ohne wiederherzustellen
Mit „Ansehen“ öffnet sich ein Fenster mit dem Inhalt des Archivs. Bei einer Bestellung sehen Sie Kundendaten, Anschrift, Zahlungs- und Versandart, alle Positionen, die Summenzeilen, den Statusverlauf und eine Liste der enthaltenen Belege. Bei einem Tagesarchiv sehen Sie alle Nachrichten dieses Tages mit Betreff, Absender, Empfänger, Text und den Namen der Anhänge.
Das ist eine reine Leseansicht: Es wird ausschließlich aus der Archivdatei gelesen, an Ihrem Shop ändert sich dabei nichts. Für die allermeisten Nachfragen – „Was stand in der Bestellung?“, „Wurde die Mail wirklich verschickt?“ – reicht das völlig aus, und Sie sparen sich die Wiederherstellung.
Brauchen Sie die Daten doch wieder im Shop, nutzen Sie wie gewohnt den Reiter „Bestellungen“ beziehungsweise „E-Mails“ mit der Aktion „Wiederherstellen“.
6.3 Das Verzeichnis neu aufbauen
Damit die Suche etwas findet, führt das Modul ein Verzeichnis der vorhandenen Archive. Beim Archivieren wird es automatisch mitgeschrieben. In zwei Fällen sollten Sie es einmal von Hand neu aufbauen lassen:
- Sie haben schon vor dem Update mit älteren Modulversionen archiviert – diese Archive kennt das Verzeichnis noch nicht.
- Sie haben Archivdateien von Hand verschoben, ausgelagert oder wieder zurückkopiert.
Die Schaltfläche „Verzeichnis neu aufbauen“ liest dafür alle vorhandenen Archivdateien einmal durch. Bei Bestellarchiven wird nur der Bestellkopf gelesen, die großen Belege bleiben unangetastet – der Vorgang ist deshalb auch bei vielen Archiven zügig erledigt.
7. Automatisch archivieren lassen
Das Aufräumen von Hand hat einen Nachteil: Man denkt nicht daran. Deshalb kann das Modul die Archivierung selbst übernehmen und in Ruhe im Hintergrund abarbeiten, was zu alt geworden ist.
7.1 Einstellungen
Alle Einstellungen dazu finden Sie im Setup:
| Einstellung | Bedeutung |
|---|---|
| Automatik (Cronjob) | Schaltet den selbsttätigen Lauf grundsätzlich ein oder aus. |
| Bestellungen aufbewahren (Monate) | Bestellungen, die älter sind, werden automatisch archiviert. „0“ heißt: Bestellungen bleiben unberührt. |
| E-Mails aufbewahren (Monate) | Dasselbe für E-Mails. „0“ heißt: E-Mails bleiben unberührt. |
| Bestellungen je Lauf | Wie viele Bestellungen pro Durchlauf höchstens verarbeitet werden. |
| Maiitage je Lauf | Wie viele Tage an E-Mails pro Durchlauf höchstens verarbeitet werden. |
Die beiden Mengenangaben bestimmen, wie groß die Häppchen sind. Kleine Werte belasten den Server kaum, brauchen dafür mehr Durchläufe – bei einem täglichen Cronjob und 25 Bestellungen je Lauf sind das rund 750 Bestellungen im Monat, die ganz von selbst verschwinden.
7.2 Den Cronjob einschalten
Zusätzlich zum Setup muss der Cronjob selbst aktiv sein. Sie finden ihn in der Shopverwaltung unter „Cronjobs“ unter dem Namen „Archivierung Cronjob“. Empfohlen ist ein täglicher Aufruf; nachts stört er am wenigsten.
Ist nichts zu tun, beendet sich der Lauf sofort wieder. Er belastet den Shop also nicht, wenn gerade nichts anfällt.
7.3 Was die Automatik nicht tut
Zwei Dinge sind bewusst ausgeschlossen:
- Die Sicherheitsdaten gelten weiter. Haben Sie ein Sicherheitsdatum hinterlegt, wird immer die strengere der beiden Grenzen angewendet. Die Automatik kann Ihre Sperre also nicht aushebeln.
- Es wird nichts gelöscht. Die Automatik archiviert – sie räumt niemals Archivdateien weg. Darüber entscheiden ausschließlich Sie (siehe Kapitel 8).
Was der Cronjob getan hat, steht anschließend im Protokoll und zusätzlich im Cronjob-Log des Shops.
8. Aufbewahrungsfristen und Protokoll
Archive wachsen mit den Jahren ebenfalls an. Irgendwann sind Daten so alt, dass Sie sie nicht mehr aufbewahren müssen – und je nach Datenlage auch nicht mehr aufbewahren sollten. Der Reiter „Aufbewahrung“ hilft Ihnen dabei, den Überblick zu behalten.
8.1 Abgelaufene Fristen
Im Setup hinterlegen Sie unter „Aufbewahrungsfrist (Jahre)“, wie lange Archive aufgehoben werden sollen. Voreingestellt sind zehn Jahre. Die Seite listet Ihnen dann alles auf, was diese Frist überschritten hat – mit Bereich, Nummer, Datum, Name und Dateigröße.
Welche Fristen für Ihr Unternehmen gelten, hängt von der Art der Daten ab und ist nichts, was ein Modul für Sie entscheiden kann. Handelsbriefe, Rechnungen und steuerlich relevante Unterlagen unterliegen eigenen Aufbewahrungspflichten. Sprechen Sie die Frist im Zweifel mit Ihrem Steuerberater ab, bevor Sie etwas löschen.
8.2 Das Protokoll
Unterhalb der Fristenliste finden Sie das Protokoll. Es hält jeden Vorgang fest: was archiviert, was wiederhergestellt, was gelöscht wurde, wann das geschah, wer es ausgelöst hat – bei automatischen Läufen steht dort „Automatik“ – und welche Archivdatei betroffen war. Auch Fehler landen hier, etwa wenn ein automatischer Lauf an einer beschädigten Altbestellung hängen bleibt.
Über die Auswahl darüber blenden Sie einzelne Vorgangsarten gezielt ein. Angezeigt werden die 300 jüngsten Einträge.
9. Der Archivordner
Im Archivordner legt das Modul zwei Unterordner an: einen für Bestellungen und einen für E-Mails. Darin liegen die Archivdateien, jeweils eine je Bestellung beziehungsweise je Tag. Zusätzlich legt das Modul in jedem dieser Ordner Schutzdateien ab, die einen Zugriff über den Browser unterbinden – und stellt sie wieder her, falls sie einmal verloren gehen. Wo der Ordner liegt, sehen Sie im Setup (Kapitel 2.3).
Die Archivdateien sind gewöhnliche ZIP-Dateien. Sie können sie also problemlos auf einen anderen Datenträger verschieben und bei Bedarf zurückkopieren – das Modul findet sie wieder, sobald sie im Archivordner liegen. Umbenennen sollten Sie sie allerdings nicht, denn am Dateinamen erkennt das Modul, welche Bestellung beziehungsweise welcher Tag darin steckt. Haben Sie Dateien von Hand bewegt, bauen Sie anschließend einmal das Verzeichnis neu auf (Kapitel 6.3).
10. Tipps aus der Praxis
Die Bestellnummer zu einem Datum finden
Bestellungen wählen Sie über Nummern aus, denken aber meist in Jahren. Die passende Grenze finden Sie im Adminbereich unter „Toolbox“ → „SQL“ mit folgender Abfrage:
SELECT MAX(orders_id) AS MaxID FROM orders WHERE date_purchased <= '2023-12-31';
Das Ergebnis ist die höchste Bestellnummer, die noch zu diesem Datum gehört – also genau der Wert, den Sie als „bis“ eintragen.
In Etappen arbeiten
Sie müssen nicht alles auf einmal erledigen. Gerade beim ersten Einsatz ist es angenehmer, zunächst ein einzelnes Jahr zu archivieren, das Ergebnis in Ruhe anzusehen und erst danach weiterzumachen. Das Modul merkt sich nichts zwischen den Läufen – jeder Lauf ist für sich abgeschlossen.
Erst die Probe, dann der große Lauf
Archivieren Sie zu Beginn einen ganz kleinen Bereich, etwa fünf alte Bestellungen, und stellen Sie diese anschließend gleich wieder her. So sehen Sie an einem überschaubaren Beispiel, dass beide Richtungen in Ihrer Installation sauber funktionieren, bevor Sie größere Mengen bewegen.
Der richtige Zeitpunkt
Ein Archivierungslauf beansprucht Datenbank und Dateisystem. Legen Sie größere Läufe deshalb in eine Zeit, in der wenig im Shop los ist, und führen Sie sie nicht parallel zu einem Backup oder einem Shopupdate aus.
11. Wenn etwas nicht funktioniert
Statt der Bedienfelder erscheint ein roter Hinweis zur Systemprüfung
Dann kann das Modul den eingestellten Ablageordner nicht anlegen oder nicht beschreiben. Prüfen Sie im Setup, ob der Pfad stimmt und vollständig ist, und lassen Sie gegebenenfalls Ihren Hoster die Schreibrechte für diesen Ordner setzen.
Ein roter Hinweis meldet, das Modul sei ausgeschaltet
Schalten Sie den Modulstatus im Setup ein. Solange das Modul aus ist, bleiben alle Funktionen wirkungslos.
Ein roter Hinweis meldet, die Archivablage sei über das Internet erreichbar
Dann beachtet Ihr Webserver die Sperrdateien nicht – bei nginx ist das der Normalfall. Bitten Sie Ihren Hoster, den Zugriff auf das im Setup angezeigte Archivverzeichnis serverseitig zu sperren. Bis dahin schützt Sie noch der nicht erratbare Ordnername, aber verlassen sollten Sie sich darauf nicht.
Ein roter Hinweis meldet, die Archivablage lasse sich nicht beschreiben
Das Modul kann seinen Ordner im Shopverzeichnis nicht anlegen oder nicht hineinschreiben. Lassen Sie Ihren Hoster die Schreibrechte für das Shopverzeichnis prüfen. Bis dahin ist keine Archivierung möglich.
Die Vorschau meldet „Keine Kandidaten in diesem Bereich“
Im gewählten Bereich liegt nichts, was sich bearbeiten ließe. Beim Archivieren bedeutet das meist, dass das Sicherheitsdatum greift; beim Wiederherstellen, dass für diesen Bereich keine Archivdateien vorliegen. Die Übersicht am Seitenanfang zeigt Ihnen, welche Bereiche tatsächlich zur Verfügung stehen.
Ein Hinweis auf den Testmodus erscheint
Ohne vollwertige Lizenz lassen sich pro Lauf höchstens zehn Bestellungen und jeweils nur ein einzelner Tag an E-Mails bearbeiten. Das genügt zum Ausprobieren; für den produktiven Einsatz benötigen Sie eine Lizenz.
Die Suche meldet, das Verzeichnis sei noch nicht vorhanden
Klicken Sie im Reiter „Archiv“ einmal auf „Verzeichnis neu aufbauen“. Das ist bei einer Installation nötig, die bereits vor dem Update archiviert hat.
Die Suche findet ein Archiv, das Ansehen meldet aber „Archivdatei fehlt“
Dann steht das Archiv im Verzeichnis, die Datei liegt aber nicht mehr im Archivordner – etwa weil sie auf ein anderes Laufwerk ausgelagert wurde. Kopieren Sie die Datei zurück oder bauen Sie das Verzeichnis neu auf, damit es dem tatsächlichen Bestand entspricht.
Die Automatik archiviert nichts
Drei Dinge müssen zusammenkommen: der Modulstatus muss eingeschaltet sein, die Automatik im Setup ebenfalls, und es muss mindestens eine Aufbewahrungszeit größer als „0“ eingetragen sein. Zusätzlich muss der Cronjob in der Shopverwaltung aktiv sein. Im Protokoll und im Cronjob-Log des Shops sehen Sie, ob und mit welchem Ergebnis der Lauf stattgefunden hat.
Ein Lauf wurde versehentlich unterbrochen
Das ist unkritisch. Das Modul arbeitet in kleinen Schritten und schließt jeden Schritt vollständig ab, bevor der nächste beginnt. Ermitteln Sie einfach erneut die Vorschau und starten Sie den Lauf neu – bereits erledigte Datensätze sind dann nicht mehr im Bereich enthalten.
12. Modultexte ändern
Sämtliche Texte, die das Modul im Adminbereich anzeigt, liegen in den Sprachdateien des Shops. Sie können jede dieser Formulierungen an Ihre Gewohnheiten anpassen, ohne dass dafür etwas programmiert werden müsste.
Nutzen Sie dazu im Adminbereich die Shopfunktion „Texte ändern“. Suchen Sie dort nach dem Text, den Sie anpassen möchten, und hinterlegen Sie Ihre eigene Fassung. Ihre Änderungen bleiben bei einem Modulupdate erhalten.
13. Shopupdate und Modulpflege
Bevor Sie Ihren Shop auf eine neue Version bringen – ob Service Pack oder Masterupdate –, prüfen Sie bitte, ob das Modul und die Modulumgebung für diese Shopversion bereits freigegeben sind. Ist das nicht der Fall, warten Sie mit dem Shopupdate, bis die passenden Modulversionen vorliegen.
Installieren Sie bei einem Update immer die neueste Modulversion zusammen mit der neuesten Version der Modulumgebung. Beide gehören zusammen: Das Modul nutzt Funktionen der Modulumgebung, und eine zu alte Modulumgebung kann ein aktuelles Modul nicht bedienen.
Wenn Sie das Shopupdate durch uns durchführen lassen, aktualisieren wir vorhandene Xycons-Module und die Modulumgebung immer mit, sofern sie für die neue Shopversion verfügbar sind.
