FTP-Schnittstelle Ergänzen von Verkaufsdokumenten
Zielsetzung
Über die Schnittstelle soll die automatisierte Bereitstellung von Verkaufsdokumente aus Fremdsystemen an Open Datacheck ermöglicht werden. Die Definition, der auf Open Datacheck mögliche Marketing- und Vertriebsunterlagen, finden sie unter https://itek-branchenwissen.atlassian.net/wiki/spaces/DKB/pages/454557699.
Rahmenbedingungen
Bei der Bereitstellung von Marketing- und Verkaufsdokumente sind verschiedenen Informationen relevant. Diese sind zum einen die Datei, welche übergeben werden soll. Weiterhin sind aber auch zusätzliche Metadaten relevante, welche die Nutzung und Verteilung steuern. Diese Metadaten sind im einzelnen:
Metadatum | Beschreibung | Mögliche Inhalte | Beispiel | Anmerkungen |
|---|---|---|---|---|
Art des Dokuments | Angabe um welche Marketing- bzw. Vertriebsunterlage es sich handelt.
| Folgende Dokumentarten können angegeben werden:
| “Produktkatalog”
| Die Angabe erfolgt implizit durch Ablage der Datei in den entsprechenden Unterordner im FTP (s. u.). |
Dateiname des Dokuments | Angabe des Dateinamen zur Selection der zur Info-Datei zugeordneten Datei. | Filenamen ohne Pfadangabe 255 Zeichen | <FileName>Produktkatalog_2022.odf</FileName>
|
|
Beginn des Gültigkeitszeitraums | Angabe des Datums ab dem das Dokument gültig ist. Der Gültigkeitszeitraum wird zur Steuerung der Sichtbarkeit beim Großhandel genutzt. Alle Dokumente werden, unabhängig vom Gültigkeitsdatum an den Großhandel weitergegeben. | Datumsangabe im Format YYY-MM-DD | <ValidityBegin>2022-11-11</ValidityBegin><!--Beginn des Gültigkeitszeitraums-->
|
|
Ende des Gültigkeitszeitraums | Angabe des Datums bis zu dem das Dokument gültig ist. Der Gültigkeitszeitraum wird zur Steuerung der Sichtbarkeit beim Großhandel genutzt. Alle Dokumente werden, unabhängig vom Gültigkeitsdatum an den Großhandel weitergegeben. | Datumsangabe im Format YYY-MM-DD | <ValidityEnd>2022-11-11</ValidityEnd> <!-- Ende des Gültigkeitszeitraums --> |
|
Kurzbeschreibung (pro Sprache) | Angabe der Kurzbeschreibung zum Dokument je Sprache (deutsch und englisch). Die Beschreibung wird bei der Anzeige in den Großhandelssystemen verwendet. | Text mit bis zu 128 Zeichen |
| |
Dokumentensprachen (mehrfach) | Angabe in welchen Sprachen die in diesem Dokument verwendet werden. | Codeliste der Sprachen:
|
| Es gibt Dokumente, die mehrsprachig verfasst sind. |
Verfügbar in Ländern | Hier können die Ländereinstellung hinterlegt werden, in denen das Dokument verfügbar sein soll. Die Angabe wird zur Steuerung der Sichtbarkeit beim Großhandel genutzt. Alle Dokumente werden, unabhängig vom der Angabe an den Großhandel weitergegeben. | Codeliste der Länder:
| Aktuell werden nur Dokumente für den deutschen Markt verteilt. | |
Handelsstufe | Angabe für welche Handelsstufe das Dokument verwendet werden kann. Alle Dokumente werden, unabhängig vom der Angabe an den Großhandel weitergegeben. | Codelisten:
| Über die Angabe wird z. B. gesteuert, das Preislisten nicht für Handwerker und Endkunden verfügbar sind. | |
Seitenversatz | Hier kann der Versatz zwischen der Seitenzahl im Dokumente (technische) und der in der Seite angegebenen Seitenzahl (fachliche Angabe) angegeben werden.
| Möglicher Werte Ganzzahl >= 0 |
| Durch die Angabe kann beim Aufruf z. B. mit einer Katalogseite (fachliche Angabe) die korrekte Seite (technischen Angabe) angezeigt werden. |
Grenzen der Schnittstelle
Über die Schnittstelle ist das Hinzufügen von neuen Dokumenten in Open Datacheck möglich. Die Funktionen zum Ändern, Ersetzen und Löschen von Dokumente werden über die Schnittstelle nicht unterstützt und stehen nur in der Upload-Oberfläche zur Verfügung, weil nur hier auf bestehende Dokumente in Open Datacheck referenziert werden kann.
Übertragungsprozess
Die Bereitstellung der Marketing- und Verkaufsdokumente erfolgt durch den Hersteller per FTPS (Explicit AUTH TLS) auf den FTP-Server von Open Datacheck. Hierzu wird pro Hersteller ein separater FTP Zugang bereitgestellt.
Zu Einordnung der der einzelnen Dokumente sehen pro Dokumentenart ein Unterordner zur Verfügung, in dem die Dateien (Nutzdateien und Steuerungsdateien) abgelegt werden können.
Verzeichnisstruktur im FTP
Steuerungsinformationen
Die Angabe der Metadaten erfolgt über eine zusätzliche Info-Datei je Dokument bzw. Video. Diese Datei muss denselben Namen tragen, wie die Nutzdatei, aber die Endung “.info” haben (s. Beispiel am Ende des Dokuments).
Beispiel Info-Datei mit Metadaten
Sobald alle Daten in das FTP-Verzeichnis verteilt sind, muss eine weitere (leere) Datei mit dem Namen “ready” in das Verzeichnis gelegt werden. Erst wenn diese Datei vorliegt, kann der Verarbeitungsprozess in Open Datacheck erfolgen.
Das folgende Beispiel zeigt ein vollständiges, zur Verarbeitung freigegebenes Verzeichnis. In anderen Fällen, z. B. bei Prospekten können natürlich auch deutlich mehr Dateien in dem Verzeichnis liegen.
Beispiel eines vollständigen Verzeichnis “Produktkatalog”:
