veloconnect 1.1 - Spezifikation (19.9.2006)

Dr. Ludwig Balke


Inhaltsverzeichnis

1. Einleitung
2. Abhängigkeit von anderen Spezifikationen
3. Überblick
3.1. Bindungen
3.2. Transaktionen
3.3. Übersicht der Regeln
4. Veloconnect XML-Schema
5. Basis-Komponenten
5.1. Primitive Datentypen
5.2. Basis-Typen
5.3. Grundlegende zusamengesetzte Typen
5.4. Beschreibung von Gegenständen
6. Operationen
6.1. RequestType
6.2. ResponseType
6.3. Operation: GetStatus
6.4. Operation: Rollback
6.5. Operation: GetProfile
7. Transaktion: Order
7.1. Operation: CreateOrder
7.2. Operation: UpdateOrder
7.3. Operation: FinishOrder
7.4. Operation: ViewOrder
7.5. Operation: GetItemDetails
7.6. Operation: GetItemDetailsList (neu in Version 1.1)
8. Transaktion: OrderInOnlineShop
9. Katalogdaten (neu in Version 1.1)
9.1. Transaktion: TextSearch
9.2. Operation: GetClassificationScheme
9.3. vcc:ItemInformation
10. Testbetrieb
11. Zukünftige Versionen
12. Beispiele
12.1. GetProfile
12.2. Abfrage von Artikeldetails (Operation: GetItemDetails)
12.3. Abfrage von Artikeldetails (Operation: GetItemDetailsList)
12.4. Bestellung erzeugen (Transaktion: Order, Operation: CreateOrder)
12.5. Bestellung ändern (Transaktion: Order, Operation: UpdateOrder)
12.6. Bestellung abschließen (Transaktion: Order, Operation: FinishOrder)
12.7. Bestellung in Verbindung mit Online-Shop (Transaktion: OrderInOnlineShop)
12.8. Suche nach Artikeln (Transaktion:TextSearch)
12.9. Klassifikationsschemata
12.10. ItemInformation
13. Urheberrechtliche Hinweise
13.1. veloconnect
13.2. UBL
14. Referenzen
15. Änderungen/Neuerungen
15.1. Syntaktische Änderungen
15.2. Änderungen an Operationen/Transaktionen
15.3. Neue Operationen/Transaktionen

1. Einleitung

Diese Spezifikation richtet sich an ein Publikum mit entsprechenden Vorkenntnissen (vgl. Abschnitt 2, „Abhängigkeit von anderen Spezifikationen“). Angesprochen sind zum einen Entscheider, die den Aufwand für eine Umsetzung dieser Spezifikation abschätzen wollen, und zum anderen Entwickler, die eine solche Schnittstelle implementieren. Die allgemeinen Gründe für veloconnect brauchen daher hier nicht wiederholt zu werden, man findet sie auf der Website [1].

Der eilige Leser orientiere sich an den Beispielen in Abschnitt 12, „Beispiele“ und schlage dann nach Bedarf die Details nach.

Über die Änderungen gegenüber der Vorgängerversion 1.0 informiert überblicksartig ein Abschnitt am Ende dieses Dokuments (Abschnitt 15, „Änderungen/Neuerungen“).

Diese Spezifikation beruht auf offenen und verbreiteten Standards, um sich auf die spezifischen Aufgaben konzentrieren zun können, die durch diese Schnittstelle gelöst werden sollen. Als Sprache zur Übermittlung von Daten wird XML eingesetzt, da hiermit strukturierte Daten übertragen werden können und die Struktur in flexibler und verläßlicher Weise derart festgelegt werden kann, dass eine automatische Validierung möglich ist. Damit einher geht natürlich ein gewisser Overhead, der allerdings bei den zur Verfügung stehenden Ressourcen und Komprimierungsmöglichkeiten keine Rolle spielt. Ferner gibt es für die gängigen Betriebssysteme und Programmiersprachen fertige und frei verfügbare Bibliotheken zum Parsen und Generieren von XML-Dokumenten.

Zur Modellierung der Entitäten, die mittels XML beschrieben werden sollten, wird die „Universal Business Language (UBL)“ [3] eingesetzt, ein vom OASIS-Konsortium [2] etablierter offener Standard. Dabei handelt es sich um ein umfangreiches XML-Schema zur Beschreibung geschäftsrelevanter Entitäten. Im Unterschied zu anderen Standards wie z.B. OpenTrans oder cXML sind hier nicht Geschäftsprozesse, die am Einkaufsprozedere großer Firmen orientiert sind, fest in der Schemadefinition verankert, sondern es wird ein allgemeines Vokabular zur Verfügung gestellt, mit dem auch die für veloconnect spezifischen Prozesse abzubilden sind.

Dieses Dokument ist wie folgt aufgebaut: Nachdem zunächst die Abhängigkeit von anderen Spezifikationen expliziert wird (Abschnitt 2, „Abhängigkeit von anderen Spezifikationen“), wird ein genereller Überblick über das der Spezifikation zugrunde liegende Modell gegeben (Abschnitt 3, „Überblick“). In den folgenden beiden Abschnitten werden die konstituierenden Elemente des XML-Schemas erläutert, welches zur Übermittlung von Daten verwendet wird (Abschnitt 4, „Veloconnect XML-Schema“, Abschnitt 5, „Basis-Komponenten“). Die generischen Regeln für die über eine veloconnect-Schnittstelle kommunizierenden Parteien, sowie die spezifischen Anforderungen für den Bestellvorgang finden sich in Abschnitt 6, „Operationen“ bzw. Abschnitt 7, „Transaktion: Order“ und Abschnitt 8, „Transaktion: OrderInOnlineShop“. Neu hinzugekommen ist in Version 1.1 der Abschnitt über den Austausch von Katalogdaten (Abschnitt 9, „Katalogdaten (neu in Version 1.1)“). Anschließend wird erläutert, welcher Testmechanismus vorgesehen ist (Abschnitt 10, „Testbetrieb“), sowie nach welchen Regeln in zukünftigen Versionen der Spezifikation für Auf- und Abwärtskompatibilität gesorgt ist (Abschnitt 11, „Zukünftige Versionen“). Den Abschluss bilden einige Beispiele in Abschnitt 12, „Beispiele“.

Diese Spezifikation basiert auf der UBL-Spezifikation, deren Urheberrechte das OASIS-Konsortium [2] innehat; die Lizenzbestimmungen finden sich in Abschnitt 13, „Urheberrechtliche Hinweise“. Die Urheberrechte dieser Spezifikation besitzt der Verbund Selbtsverwalteter Fahrradbetriebe e. V. (VSF) [4]. Die genauen Lizenzbestimmungen finden sich ebenfalls in Abschnitt 13, „Urheberrechtliche Hinweise“.

Hinweise auf Fehler und Vorschläge werden gerne unter der Adresse entgegengenommen.