Maschinenlesbare Schnittstellen für Ergebnistabellen

Derzeit bieten wir einen XML-Export, der sich leicht weiterverarbeiten läßt. Es ist geplant, mit SuperX eine REST-Schnittstelle für Ergebnistabellen anzubieten.

XML-Schnittstelle

XML ist seit vielen Jahren ein beliebtes Austauschformat für komplexere Datenbereiche, und hat sich in der B2B-Kommunikation bewährt, z.B. die XRechnung. Wir nutzen XML in SuperX seit 2001, jeder Standardbericht läßt sich in der Benutzeroberfläche als XML exportieren. Darüber hinaus können Sie den Abruf auch automatisieren.

Aufruf über http

• Deeplink der Ergebnistabelle erzeugen
• Download mit wget oder curl, dabei Übergabe von den Parametern:
  • benutzer = Benutzerkennung
  • passwort = Passwort
  • contenttype=text/xml
  • stylesheet=tabelle_xml.xsl

Beispiel:

wget -O test.xml http://mein-superx-server/superx/servlet/SuperXmlTabelle?tid=16000&kennung=public&passwort=1234567&contenttype=text/xml&stylesheet=tabelle_xml.xsl

Beschreibung des XML-Formats

{{Hinweis|Das XML-Format hat ein Schema, das hier technisch dokumentiert ist.

Dieser Abschnitt befasst sich mit den wesentlichen Elementen der XML-Schnittstelle. Der Editor Jedit liefert einen übersichtlichen Baum zur Navigation in XML-Dateien:

Hierbei handelt es sich um die XML der Ergebnistabelle des Berichtes "Studierende nach Erst- und Neueinschreibung (Zeitreihe)":

Die Ergebnistabelle ist hierarchisch strukturiert, unterhalb des Root-Elements sind 1-n ergebnis-Elemente verfügbar. Das Element felder enthält jene Felder, welcher für die Selektion genutzt wurden. Das Element completefields enthält alle Felder der jeweiligen Auswahlmaske:

Das Element headers enthält die Spaltenüberschriften der Ergebnistabelle:

Das Element row und sein Unterelement col enthalten die Werte der Ergebnistabelle:

Dem Beispiel entsprechend gibt es 4 row-Elemente und 13 col-Elemente.

Das Attribut typ innerhalb der col-Elemente definiert den Datentyp:

• 1=string (Default)
• 3=DecimalFormat
• 4=integer
• 6=date
• 8=timestamp
• 9=time

Es wird mit amerikanischem Zahlenformat gearbeitet (Punkt als Dezimaltrenner). Das Datumsformat ist dd.MM.yyyy

Weiterverarbeitung

• XML / XPATH Parser zum Abfragen, z.B. Xalan
• Import mit Kettle