Inhaltsverzeichnis
orders_in XML-Schema
Schema
Das vollständige Schema finden Sie unter orders_in_v1_1.xsd.
Im folgenden gehen wir auf die wichtigsten Elemente des Schemas ein. Beim Lesen hilft es, sich die untenstehende Beispieldatei vor Augen zu halten.
ListOfOrders
Dieses Element ist das Wurzelelement und taucht genau einmal in einem order_in-Job auf. Unterelemente sind ein oder mehrere Order-Elemente.
Attribute
| Attribut | Pflicht? | Erklärung |
|---|---|---|
| CreationDate | ja | Zeitpunkt, an dem die Liste auf dem Fremdsystem erstellt wurde (z.B. UNIX-Timestamp) |
| ExecutionLevel | nein | Nur zu Debugging-Zwecken notwendig. Eine Bitmap, mit der festgelegt werden kann, welche Teile ausgeführt bzw. übersprungen werden sollen. Default-Wert: 3, siehe unten |
Werte der ExecutionLevel Bitmask
- 0 : Führen eines detaillierten Debug-Logs. Wird derzeit imm er gemacht und kann nicht abgeschaltet werden.
- 1 : Aufruf der Prozedur om_AcknowledgeOrders_Ad.
- 2 : Aufruf der Prozedur om_ModifyOrderInformation_Ad.
Order
Mit dem Element Order wird die Rückmeldung zu genau einem Auftrag bzw. einzelner Positionen des Auftrags und entsprechenden Informationen durchgeführt.
Attribute
| Attribut | Pflicht? | Erklärung |
|---|---|---|
| OrderID | ja | Referenz auf einen Auftrag im dStore |
| OrderNo | nein | Auftragsnummer im Fremdsystem |
| DefaultPositionOrderState | nein | Welcher Status soll für die Positionen verwendet werden die zwar übergeben wurden, jedoch keinen (Ziel-)OrderState per Attribut übergeben bekommen haben? |
| InvoiceCustomerNo | nein | Referenznummer des Auftraggebers im Fremdsystem (i.d.R. Kundennummer) |
| DeliveryCustomerNo | nein | Referenznummer der Lieferanschrift im Fremdsystem |
Position
Mit dem Element Position unterhalb von OrderContent kann für einzelne Positionen der Status gewechselt werden. Wichtig ist, dass die Berechtigung für den Statuswechsel konfiguriert ist (siehe auch Fehler -340).
Der dStore kennt den Status nur auf Positionsebene (also quasi einen Auftragspositionsstatus). Von einem Auftragsstatus spricht man, wenn alle Positionen den gleichen Status haben. Haben die Positionen unterschiedliche Status, so ist der Auftragsstatus „undefiniert“.
Attribute
| Attribut | Pflicht? | Erklärung |
|---|---|---|
| No | ja | Positionsnummer („PositionNo“) der Position für die der Status gewechselt werden soll. |
| OrderState | nein | Status, in den die Position gewechselt werden soll. Falls nicht gesetzt, wird der DefaultPositionOrderState verwendet (siehe Attribut zu Order). |
OrderInformation
Mit diesem Element werden Informationen zum Auftrag übergeben. Es gibt Berechtigungs-Regeln, was das Ändern von OrderInformations betrifft. Die Regeln sind pro Informations-Art („InformationTypeID“) konfigurierbar und sind zum einen vom Benutzer („UserID“), der die Änderung vornehmen möchte, abhängig, sowie von den Status („OrderStateID“s), in denen sich die Auftragspositionen eines Auftrags befinden. Die Abhängigkeit vom Status ist so zu verstehen : Damit die Änderung (Anlegen/Aktualisieren/Löschen) durchgeführt werden darf, müssen sich ALLE Positionen des Auftrags in einem Status befinden, für den die Änderung erlaubt ist.
Pro Auftrag darf es nur eine Information zur InformationTypeID geben.
Attribute
| Attribut | Pflicht? | Erklärung |
|---|---|---|
| InformationTypeID | ja | ID des Informationstyps, die OrderInformationTypeID |
OrderContentInformation
Mit diesem Element werden Informationen zu Auftragspositionen übergeben. Hinsichtlich der Berechtigungen gilt das bereits für die OrderInformations gesagte.
Pro Position darf es nur eine Information zur InformationTypeID geben.
Attribute
| Attribut | Pflicht? | Erklärung |
|---|---|---|
| PositionNo | ja | Positionsnummer, für die die übergebene Information gesetzt werden soll |
| InformationTypeID | ja | ID des Informationstyps, die OrderContentInformationTypeID |
Beispieldatei
- orders_in_sample1.xml
<?xml version="1.0" encoding="UTF-8"?> <ListOfOrders xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://resources.dstore.de/xsd/xml_SmartGate/orders_in_v1_1.xsd" CreationDate="1149176001"> <Order OrderID="11233" OrderNo="30029" DefaultPositionOrderState="53" InvoiceCustomerNo="10416617"> <OrderContent> <Position No="1"/> <Position No="2"/> <Position No="3"/> <Position No="4"/> </OrderContent> <OrderInformation> <Information InformationTypeID="2">erfolgreich übertragen</Information> </OrderInformation> </Order> <Order OrderID="11377" OrderNo="30025" InvoiceCustomerNo="11617906"> <OrderContent> <Position No="1" OrderState="51"/> </OrderContent> <OrderInformation> <Information InformationTypeID="2">nicht übertragen</Information> </OrderInformation> <OrderContentInformation> <Information PositionNo="1" InformationTypeID="65">Fehler: Bestandsdifferenz</Information> </OrderContentInformation> </Order> </ListOfOrders>