Software- Handbuch

Transkript

1 Der magisch einfache WebService. Software- Handbuch Von Jonathan Werner

2 Inhaltsverzeichnis 1 Inhaltsverzeichnis 1 Inhaltsverzeichnis Einleitung Ergebnisse einer Periode Ergebnisse einer Periode als HTML Planungsdaten einer Periode ins Tool hochladen Planungsdaten einer Periode ins Tool hochladen und direkt das Ergebnis zurückerhalten Planungsdaten einer Periode ins Tool hochladen und direkt das Ergebnis als HTML zurückerhalten

3 Einleitung 2 Einleitung In Ibsys II wird das Tool von Supply Chain Simulator 2.0 ( ) genutzt, um die geplanten Perioden einzugeben und das Ergebnis mit anderen Grup- pen zu vergleichen. Eine Herausforderung für die Programmierung ist, wie die eigenen geplanten Daten in das Tool von Supply Chain Simulator 2.0 gelangen und wie die benö- tigten Daten aus dem Tool exportiert werden können. Bisher war es nur möglich, die XML- Datei mit den geplanten Periodendaten per Hand in Supply Chain Simulator 2.0 zu laden. Die Ergebnisse der Vorperioden mussten dabei zusätzlich per Hand aus dem Tool in das eigene Planungs- Tool kopiert werden. Eine Erleichterung bietet nun MagicRest. Dieser WebService ermöglicht es, die Pla- nungsdaten automatisiert an den Supply Chain Simulator 2.0 zu übertragen. Außerdem können die Ergebnisse einer Periode automatisiert aus diesem Tool in das eigene Pla- nungs- Tool übertragen werden. Der WebService ist ein RESTful- WebService. Das bedeutet, dass die in SWE II gewonnen Erfahrungen auch für dieses Projekt genutzt werden können. Im folgenden Kapitel wer- den die beschrieben, die im Projekt genutzt werden können

4 3 In diesem Kapitel werden die Funktionen beschrieben, die dieser WebService bietet. Dabei wird für jede Funktion die URL und die Methode genannt, mit der die jeweilige Funktion aufgerufen werden kann. Außerdem sind die zu übergebenden Parameter und die Ergebnisse einer jeden Funktion beschrieben. Alle Funktionen lassen sich über die Basis- URL mit der angehängten URL der Funktion aufrufen. Die Methoden- Parameter müssen im JSON- Format überge- ben werden. Die Ergebnisse des Aufrufs werden vom WebService im JSON- Format zurückgegeben. Dabei wird das Ergebnis immer im Format: {"success":true,"message":"","total":11,"data": ""} übergeben. Der Parameter sucess gibt an, ob die Anfrage erfolgreich ausgeführt wer- den konnte. Der Parameter message enthält eine eventuelle Fehlermeldung. Der Pa- rameter total gibt die Anzahl der Array- Elemente des Parameters data an. Der Para- meter data enthält die tatsächliche Antwort des WebService

5 3.1 Ergebnisse einer Periode Beschreibung Diese Funktion gibt die Ergebnisse der angefragten Periode zurück. Dabei werden die Daten zurückgegeben, die im Supply Chain Simulator 2.0 auf der Seite Kennzahlen Gesamtergebnis (Druck) angezeigt werden. Lediglich die Daten der Tabelle Kenn- zahlen werden nicht mit übermittelt. Die restlichen Tabellen werden in Objekte um- gewandelt und als Array zurückgegeben. URL /user/(.*)/(.*)/period/(.*)/results URL- Parameter 1. Benutzername 2. Passwort 3. Periode Methode GET Methoden- Parameter - Ergebnis (data) Das Ergebnis ist ein multidimensionales Array. Dabei besteht die Erste Ebene aus den einzelnen Tabellen: ProductionOrders, WarehouseStock, InwardStockMovement, Fu- tureinwardstockmovement, MarketplaceIncoming, MarketplaceOutgoing, Work- placecosts, WorkplaceWaitinglist, StockWaitinglist, OrdersBeeingProcessed und Cyc- letimes. Jede dieser Tabellen- Elemente enthält noch einmal ein Array mit den Zeilen der Tabellen als Elemente. Beispiel einer Anfrage / des Ergebnisses

6 Das Ergebnis wird nur als Auszug dargestellt und soll zeigen, wie die Ergebnisse all- gemein aufgebaut sind. Natürlich wird das Ergebnis direkt im JSON- Format zurückge- liefert. Der Screenshot zeigt eine Umwandlung des JSON- Objekts nach HTML. Auf der Website lassen sich die JSON- Ergebnisse in diesem HTML- Format anzeigen, um ein vollständiges Verständnis für das Ergebnis zu bekommen

7 3.2 Ergebnisse einer Periode als HTML Beschreibung Diese Funktion gibt die Ergebnisse der angefragten Periode zurück. Dabei werden die Daten zurückgegeben, die im Supply Chain Simulator 2.0 auf der Seite Kennzah- len Gesamtergebnis (Druck) angezeigt werden. Hierbei werden alle Tabellen dieser Seite als HTML zurückgegeben, damit sie im eigenen Tool dargestellt werden kön- nen URL Methode /user/(.*)/(.*)/period/(.*)/results/type/(.*) GET URL- Parameter 1. Benutzername 2. Passwort 3. Periode 4. Typ des Ergebnisses. Hier ist momentan nur der Wert jquery möglich Methoden- Parameter - Ergebnis (data) Das Ergebnis ist ein HTML- Element. Dabei besteht das Element aus den einzelnen Tabellen: ProductionOrders, WarehouseStock, InwardStockMovement, FutureIn- wardstockmovement, MarketplaceIncoming, MarketplaceOutgoing, WorkplaceCosts, WorkplaceWaitinglist, StockWaitinglist, OrdersBeeingProcessed und CycleTimes. Diese Tabellen sind so formatiert, dass sie direkt als HTML im eigenen Tool darge- stellt werden können. Beispiel einer Anfrage

8 Hier ist als Beispiel die Ausgabe des HTML- Elements gezeigt, das vom WebService zurückgeliefert wird. Ein Klick auf die Überschriften öffnet die jeweilige Tabelle

9 3.3 Planungsdaten einer Periode ins Tool hochladen Beschreibung Mit dieser Funktion lassen sich die geplanten Daten einer Periode auf Supply Chain Simulator 2.0 hochladen. Dabei wird als Methoden- Paramter der XML- String über- geben, den man normalerweise auch direkt als XML- Datei auf Supply Chain Simula- tor 2.0 hochladen würde. URL /user/(.*)/(.*)/period URL- Parameter 1. Benutzername 2. Passwort Methode POST Methoden- Body Ein JSON- Objekt, das als Name xml und als Wert den XML- String enthält siehe Screenshot im Beispiel Ergebnis (data) data sollte bei dieser Methode keine Ergebnisse enthalten. Lediglich der Parameter message gibt an, ob die Daten erfolgreich hochgeladen werden konnten Beispiel einer Anfrage

10 Der Screenshot zeigt das Firefox- Addon Poster, mit dem sich Anfragen an den WebService testen lassen. Methoden- Parameter: Siehe als Beispiel den Inhalt der Datei

11 3.4 Planungsdaten einer Periode ins Tool hochladen und direkt das Ergebnis zu- rückerhalten Beschreibung Mit dieser Funktion lassen sich die geplanten Daten einer Periode auf Supply Chain Simulator 2.0 hochladen. Dabei wird als Methoden- Paramter der XML- String über- geben, den man normalerweise auch direkt als XML- Datei auf Supply Chain Simula- tor 2.0 hochladen würde. Dabei werden die Ergebnisse der neuen Periode zurückgegeben, die im Supply Chain Simulator 2.0 auf der Seite Kennzahlen Gesamtergebnis (Druck) angezeigt werden. Lediglich die Daten der Tabelle Kennzahlen werden nicht mit übermittelt. Die rest- lichen Tabellen werden in Objekte umgewandelt und als Array zurückgegeben. URL /user/(.*)/(.*)/period/results URL- Parameter 1. Benutzername 2. Passwort Methode POST Methoden- Body Ein JSON- Objekt, das als Name xml und als Wert den XML- String enthält siehe Screenshot im Beispiel Ergebnis (data) Das Ergebnis ist ein multidimensionales Array. Dabei besteht die Erste Ebene aus den einzelnen Tabellen: ProductionOrders, WarehouseStock, InwardStockMove- ment, FutureInwardStockMovement, MarketplaceIncoming, MarketplaceOutgoing, WorkplaceCosts, WorkplaceWaitinglist, StockWaitinglist, OrdersBeeingProcessed und CycleTimes. Jede dieser Tabellen- Elemente enthält noch einmal ein Array mit den Zeilen der Tabellen als Elemente. Beispiel einer Anfrage Methoden- Parameter: Siehe Kapitel

12 3.5 Planungsdaten einer Periode ins Tool hochladen und direkt das Ergebnis als HTML zurückerhalten Beschreibung Mit dieser Funktion lassen sich die geplanten Daten einer Periode auf Supply Chain Simulator 2.0 hochladen. Dabei wird als Methoden- Paramter der XML- String über- geben, den man normalerweise auch direkt als XML- Datei auf Supply Chain Simula- tor 2.0 hochladen würde. Dabei werden die Ergebnisse der neuen Periode zurückgegeben, die im Supply Chain Simulator 2.0 auf der Seite Kennzahlen Gesamtergebnis (Druck) angezeigt werden. Hierbei werden alle Tabellen dieser Seite als HTML zurückgegeben, damit sie im ei- genen Tool dargestellt werden können. URL /user/(.*)/(.*)/period/results/type/(.*) URL- Parameter 1. Benutzername 2. Passwort 3. Typ des Ergebnisses. Hier ist momentan nur der Wert jquery möglich Methode POST Methoden- Body Ein JSON- Objekt, das als Name xml und als Wert den XML- String enthält siehe Screenshot im Beispiel Ergebnis (data) Das Ergebnis ist ein HTML- Element. Dabei besteht das Element aus den einzelnen Tabellen: ProductionOrders, WarehouseStock, InwardStockMovement, FutureIn- wardstockmovement, MarketplaceIncoming, MarketplaceOutgoing, WorkplaceCosts, WorkplaceWaitinglist, StockWaitinglist, OrdersBeeingProcessed und CycleTimes. Diese Tabellen sind so formatiert, dass sie direkt als HTML im eigenen Tool darge- stellt werden können. Beispiel einer Anfrage Methoden- Parameter: Siehe Kapitel

13 Fehlermeldungen 4 Fehlermeldungen Der WebService gibt einige Fehlermeldungen zurück, wenn die übergebenen Parameter nicht stimmten oder ein anderer Fehler auftritt. Die Fehlermeldungen stehen im Ergeb- nisparameter message. Login data ist not correct. Dieser Fehler tritt dann auf, wenn die übermittelte Kombination aus User / Passwort nicht korrekt ist. Dabei wird überprüft, ob man sich mit diesen Daten im Supply Chain Simulator 2.0 anmelden kann You have to submit xml code Der WebService konnte im Anfrage- Body keinen XML- Code entdecken. Bitte stellen Sie si- cher, dass der Parameter korrekt übergeben wurde The file could not been uploaded successfully. Dieser Fehler tritt dann auf, wenn der Supply Chain Simulator 2.0 einen unbekannten Feh- ler zurückgibt. Bitte versuchen Sie es später noch einmal oder überprüfen Sie Ihre Anfrage- Parameter Could not find current period. Please contact the administrator. Die neue Periode / die angefragte Periode konnte nicht gefunden werden. Bitte versuchen Sie es später noch einmal oder überprüfen Sie Ihre Anfrage- Parameter The requested period does not exist for the given user. Die angefragte Periode existiert für den gegebenen User (noch) nicht

14 Hilfreiches Firefox- Addon 5 Hilfreiches Firefox- Addon Um den WebService zu testen, lässt sich das Firefox- Addon Poster verwenden. Mit Hil- fe dieses Addons lassen sich Anfragen an den WebService stellen. Der folgende Screenshot zeigt ein Beispiel für die Verwendung von Poster :