Beschreibung
Dokumente übertragen
Die Übergabe der Dokumente erfolgt über ein separates Verzeichnis. Sobald alle Dokumente darin enthalten sind, kann die Nachricht DocumentUpdate ebenfalls in dieses Verzeichnis abgelegt werden.
ACHTUNG:
Sind die Artikel noch nicht angelegt, erfolgt keine Zuordnung. ProductUpdate vor DocumentUpdate durchführen!
Eine Mehrfach-Verwendung/Referenzierung der Bilder ist nicht möglich, da die Bilder direkt nach der Zuordnung vom Server gelöscht werden. Für Mehrfach-Referenzierung müssen die Bilder über die GUI Verwaltung > Dokumente angelegt werden und können dann im jeweiligen Produkt verknüpft werden.
Feld | Wert |
|---|
Nachrichtenkopf - Nachrichtentyp | DocumentUpdate |
Nachrichtenkopf - Version des Typs
Letzte Version | 12
|
Nachrichtenkopf - Häufigkeit: 1
Nachrichtenkopf
Der Kopf einer Nachricht setzt sich immer aus folgenden Feldern zusammen:
| # | | | | | | |
|---|
| 1 | Nachrichtentyp | Type | M | alph | 30 | Kennung/Bezeichnung des Typs der Nachricht. Die einzelnen Typen werden im Folgenden vorgestellt. |
| 2 | Version des Typs | Version | M | int |
| Kennung der Version des Nachrichtentyps bzw. des Formats |
| 3 | Datum & Uhrzeit | Date | M | dt |
| Datum und Uhrzeit der Erstellung der Nachricht |
| 4 | Sender | SenderId | M | alph | 50 | Kennung des Senders |
| 5 | Empfänger | ReceiverId | M | alph | 50 | Kennung des Empfängers |
| 6 | Kennung der Transaktion | TransactionId | K | alph | 32 | siehe folgender Abschnitt „Transaktionen".
Leer bei nicht Verwendung des Transaktionsprotokolls. |
| 7 | Kennung der Nachricht | MessageId | M | alph | 32 | Fortlaufende Nummer um die Nachricht eindeutig zu identizieren.
siehe folgender Abschnitt „Transaktionen" |
| 8 | Sequenznummer des Senders der Nachricht | SequenceNrSender | K | int |
| Fortlaufende Zahl, die sicherstellt, dass ankommende Nachrichten in der richtigen Reihenfolge abgearbeitet werden |
| 9 | Sequenznummer des Empfängers der Nachricht | SequenceNrReceiver | K | int |
| Fortlaufende Zahl, die sicherstellt, dass ankommende Nachrichten in der richtigen Reihenfolge abgearbeitet werden |
| 10 | Timeout | Timeout | K | int |
| Zeit in Minuten, in der der Sender eine Antwort erwartet. Kein Timeout (unendliches Warten) wird durch den Wert 0 (null) ausgedrückt. |
| 11 | Nachrichtenlänge | NumberOfLines | M | int | 10 | Anzahl der Zeilen der Nachricht , inkl. Der ersten Zeile. Dieser Wert dient zur Überprüfung, ob die Nachricht komplett übertragen wurde. |
Mit der Version 2.2 der Schnittstelle wird das Feld „Version" genutzt. Alle bisherigen Schnittstellenversionen hatten hier den Wert „1". Ab der aktuellen Version wird der Wert mit jeder Version hochgezählt. Alle Satzarten und Felder die aktuell keine Versionsangabe besitzen, müssen unterstützt werden. Alle Felder und Satzarten die eine Angabe besitzen, müssen erst ab der angegebenen Version unterstützt werden.
Die Werte für die Felder „Kennung des Senders" und „Kennung des Empfängers" müssen im Vorfeld festgelegt werden. Durch sie werden konkrete Instanzen eines ordermanager und einer Warenwirtschaft eindeutig identifizert.
Die „Kennung der Nachricht" sollte, wenn möglich, mit einer fortlaufenden Nummern gefüllt werden. Wird auf das Transaktionsprotokoll verzichtet, so müssen die Felder „Kennung der Transaktion" sowie beide Sequenznrn Felder leer bleiben. Ab der Version 2.4 wird der Einsatz des Transaktionsprotokolls nicht mehr empfohlen.
Document - Häufigkeit: 1..*
Pro Artikelposition kann es mehrere Dokumente geben. Die Referenzierung zum Artikel findet über die Artikelnummer statt.
| # | | | | | | | Version |
|---|
| 1 | Artikelnr. | ArticleId | M | Alph | 30 | Nummer der Artikels in der Warenwirtschaft |
|
| 2 | Dokumententyp | DocType | M | Alph | 50 | Kennzeichner für Dokumenttyp. Muss Kundenindividuell spezifiziert werden.
Die Standard Typen, die bereits im orderManager sind in der untenstehenden Liste zu finden. |
|
| 3 | Dateiname | FileName | M | Alph | 1000 | Der Name der Datei ohne Endung. |
|
| 4 | Dateinamens-
erweiterung | FileExtension | M | Alph | 10 | Die Endung der Datei, z.B. „.jpg" |
|
| 5 | Ist neues Dokument | IsNewDocument | M | Bool |
| Handelt es sich bei dem Dokument um ein Dokument, welches das erste Mal übertragen wird? |
|
| 6 | Gültig ab | ValidFrom | K | DateTime |
| gibt an, ab wann das Dokument gültig ist | 8 |
| 7 | Beschreibung | Description | K | Alph | 500 | Name des Dokuments | 8 |
| 8 | Inhalt | Content | K | Alph | 400.000 | Base64-Codierter Inhalt der Datei | 17 |
Standard-Dokumentetypen des ordermanager
| Dokumenttyp Wert | Beschreibung |
|---|
| 1 | 1 | Listenbild (Standardbild) |
| 2 | 2 | Sicherheitsdatenblatt |
| 3 | 3 | Produktdatenblatt |
| 4 | 4 | Betriebsanleitung |
| 5 | 999 | Sonstiges |
| 6 | 6 | Detailbild |
| 7 | 7 | Galeriebild (groß) |
| 8 | 8 | Galeriebild (klein) |
Die Nachricht kann nur Dokumente enthalten, zu denen auch eine Datei übertragen wurde. Wird eine Datei geliefert, so muss "IsNewDocument" auf "true" stehen. Und nur in diesem Fall wird der Inhalt in das System übernommen.
