Modul-Dokumentation „Kundendokumente (DMS)“

Allgemeine Infos zum Modul und zu uns 😊

Was das Modul kann

Mit diesem OXID Modul kannst du beliebige Dokumente, z. B. Rechnungen, Lieferscheine, Aufträge, Anschreiben, Bilder, zu jedem Kunden im OXID Backend hochladen.

Die Dokumente können einzeln auch dem Kunden in seinem Kundenkonto zum Download bereitgestellt werden.

In OXID generierte Rechnungen und Lieferscheine werden automatisch in die Kunden-Dokumentliste übernommen. So hast du jederzeit über den Kunden Zugriff auf die Dokumente. Sie können außerdem ebenfalls für den Download im Kundenkonto freigeschalten werden, so dass sich Kunden diese Dokumente im Shop herunterladen können.

Dateien lassen sich nachträglich aktualisieren und auch wieder entfernen. Die Dokumentenliste ist nach verschiedenen Kriterien sortierbar.

Sicherheit geht vor! Dateien werden unter gehashtem Dateinamen gespeichert und bei Zugriff auf Dateien stets die Berechtigung geprüft.

Dieses Modul ist kompatibel mit unserem OXID Modul „Rechnung per E-Mail“ - mit der du Rechnungen automatisch per E-Mail an deine Kunden senden kannst. Bitte beachte dazu unsere Hinweise in der Installationsanleitung.

WENN DU AUCH „RECHNUNG PER E-MAIL“ VERWENDEST

Wenn du auch unser Modul „Rechnung per E-Mail“ verwendest, ist es zwingend erforderlich, dass du folgende Punkte beachtest:

Damit der Rechnungsversand per E-Mail bei Bestellung oder / und aus dem Backend heraus weiterhin richtig funktioniert, muss das Modul die OXID Klassen oxorder und oxpdf als letztes erweitern.

Du siehst das unter Erweiterungen → Module auf dem ersten Tab.

Die fett dargestellten Namen sind die OXID Klassen, darunter stehen die Modulklassen, die diese OXID Klassen erweitern.

Achte hier darauf, dass dwa_inv_oxorder bzw. dwa_inv_pdf in der Aufzählung jeweils ganz unten stehen.

Abb.: So ist es korrekt: dwa_inv_oxorder steht ganz unten

Falls das nicht der Fall ist, kannst du die Vererbungsreihenfolge ändern, indem du die Klasse mit gedrückter Maustaste an die letzte Stelle ziehst. Klicke anschließend ganz unten auf den Button „Speichern“ und leere das tmp-Verzeichnis (siehe Kapitel 2.4).

Sollte das nicht funktionieren, führe folgende Schritte durch, um „Rechnung per E-Mail“ an die letzte Stelle zu schieben:

1. Modul deaktivieren
2. Modul auf dem Server löschen
3. Löschen der Dateien in OXID (Erweiterungen → Module) bestätigen
4. Modul wieder hochladen
5. Modul aktivieren + tmp Ordner leeren

Prüfe die Reihenfolge immer, wenn du neue OXID Module installiert hast!

Bei fehlerhafter Vererbungsreihenfolge wird die Rechnung nicht mehr per E-Mail versendet, sondern direkt an den Browser ausgegeben.

Deaktiviere dann also jetzt das Modul „Rechnung per E-Mail“ oder verschieben die Reihenfolge der Erweiterung im Nachgang wie vorstehend beschrieben.

Wenn du auch unser Modul „Rechnung per E-Mail“ verwendest, kannst du dieses nun wieder aktivieren.

GRUNDEINSTELLUNGEN

In den Moduleinstellungen (Tab „Einstellungen“ unter Erweiterungen / Module) kannst du folgende Einstellungen vornehmen:

Pfad zu den Dateien

Optional! Wenn du hier nichts einträgst, liegen Kunden-Dokumente immer im Verzeichnis out/customerdocs/. Da die Dateinamen verfremdet werden (siehe Kapitel Sicherheit), ist das auch ausreichend.

Willst du die Dateien jedoch in einem eigenen Verzeichnis ablegen, gib hier den Pfad relativ zum Shop-Verzeichnis an. Lege dazu den Ordner einfach an und gib ihm Schreibrechte. Verwende dazu dieses Format (vorn ohne Slash, am Ende Slash):

out/customerdocs/

Download von Dokumenten im Kundenaccount aktivieren

Wenn du diese Option aktivierst, erscheint im Kundenkonto ein neuer Menüpunkt „Meine Dokumente“. Dort können Kunden Dokumente herunterladen, die du ihnen über den Shop zur Verfügung stellst.

Kunden können dabei trotzdem nicht alle Dokumente herunterladen, die dz zu diesem Kunden hochgeladen hast, sondern lediglich die, die du als „extern“ kennzeichnest (siehe Kapitel "Dokumente für den Kunden freischalten").

OXID Dokumente (Rechnung, Lieferschein) bei Erzeugen als extern kennzeichnen

Diese Option hat nur Auswirkungen, wenn du den generellen Download von Dokumenten im Kundenaccount aktiviert hast (vorherige Checkbox). Wenn du die Option aktivierst, werden alle Rechnungen und Lieferscheine, die du von da an im OXID Backend erzeugst, automatisch als „extern“ gekennzeichnet.

Praktischer Einsatz

DOKUMENTENLISTE

Mit dem Modul lassen sich nur Dokumente verwalten, die sich jeweils eindeutig einem Kunden zuordnen lassen.

Gehe auf Benutzer verwalten → Benutzer und wähle einen Kunden aus. Auf dem Tab „Kunden-Dokumente“ kannst du nun die Dokumente zu diesem Kunden verwalten. Jeder Kunde verfügt so über sein eigenes Dokumentenarchiv.

Um die Liste zu sortieren, klicke auf den entsprechenden Spaltennamen.

Wenn du auf den Dokumenttitel klickst, kannst du das Dokument bearbeiten.

Durch Klick auf den Dateinamen öffnet die Datei sich im neuen Fenster bzw. kann heruntergeladen werden (abhängig vom Dateityp).

NEUES DOKUMENT HOCHLADEN

Lade ein neues Dokument hoch, indem du unten im Formular einen Titel angibst und eine Datei auswählst. Es sind beliebige Dateiformate möglich (lies dazu auch Kapitel "Sicherheit geht vor").

DOKUMENT BEARBEITEN ODER LÖSCHEN

Um ein Dokument zu bearbeiten, klicke auf dessen Titel. Du kannst es dann im Formular bearbeiten.

Um es zu löschen, klicke am Ende der Zeile auf das Kreuz.

DOKUMENTE FÜR DEN KUNDEN FREISCHALTEN (DOWNLOAD IM KUNDENKONTO)

Standardmäßig sehen Kunden die Dokumente nicht, die du im OXID Backend zu ihnen hochlädst.

Um Kunden Zugriff zu geben, markiere die gewünschten Dokumente mit „Kunde darf dieses Dokument herunterladen (Kunden-Konto)“. Diese Freigabe kann auch im Nachhinein noch gewährt oder wieder entzogen werden – bearbeite dazu das Dokument.

Für den Kunden freigegebene Dokumente sind in der Liste mit „extern“ gekennzeichnet.

Wichtig – Kunden sehen Dokumente im Kundenkonto nur, wenn du die entsprechende Option in den Moduleinstellungen aktiviert hast.

RECHNUNGEN + LIEFERSCHEINE FÜR DEN KUNDEN ERZEUGEN

Wenn du im OXID Backend eine Rechnung oder einen Lieferschein druckst (Menüpunkt Bestellungen), wird diese automatisch in den Kunden-Dokumenten beim richtigen Kunden hinzugefügt.

Wenn du möchtest, dass Kunden diese Dokumente in ihrem Kundenkonto herunterladen können, aktiviere die beiden Optionen „Download von Dokumenten im Kundenaccount aktivieren“ und „Download von OXID Dokumenten (Rechnung, Lieferschein) im Kundenaccount aktivieren“ in den Moduleinstellungen (siehe Kapitel "Grundeinstellungen).

SICHERHEIT GEHT VOR

Dateinamen

Sämtliche Dateien werden automatisch unter verfremdetem Namen (Hashcode) auf dem Webserver abgelegt, so dass sie nicht direkt heruntergeladen werden können. Selbst wenn der direkte Zugriff auf eine solche Datei erfolgt, ist sie in aller Regel unbrauchbar, weil die Dateiendung nicht bekannt ist.

Kunden sehen von dieser Hash-Funktion übrigens nichts, beim Download (mit Zugriffsrechte-Prüfung, siehe unten) wird der Dateiname wieder in den ursprünglichen zurückgewandelt.

Wenn du bereits mit dem Kunden-Dokumente Modul einer früheren Version gearbeitet hast, werden deine Dateien beim Aktivieren der neuen Modulversion automatisch umbenannt und so gesichert (dieser Vorgang ist einmalig und nur bei Updates von Versionen, die noch nicht mit Hashcodes arbeiteten).

Außerdem sorgt das Modul dafür, dass keine Datei versehentlich durch eine andere überschrieben wird, indem es automatisch beim Upload einen eindeutigen Dateinamen generiert.

Zugriffschutz

Die Download-Funktion des Moduls sichert den Zugriff auf die Download-Dateien wie folgt:

Angemeldete Administratoren dürfen alle Dateien herunterladen.

Kunden dürfen nur eigene, als extern gekennzeichnete Dateien herunterladen. Und auch das nur, wenn die entsprechende Option in den Moduleinstellungen aktiviert ist.

Tipp: Dateitypen

Grundsätzlich gibt es im Modul keine Einschränkungen, welche Dateitypen hochgeladen werden dürfen. Wir empfehlen aber zu deiner eigenen und der Sicherheit deiner Kunden, sich auf folgende Dateiformate zu beschränken:

• PDF-Dateien,
• Bilder (jpg, png),
• sowie Zip-Dateien.