XML Server

Vertec ist mit einer XML Schnittstelle ausgerüstet. Damit können Anfragen in XML formuliert und via http an Vertec geschickt werden. Die Antwort kommt ebenfalls in XML formatiert.

Damit lassen sich alle Daten aus Vertec abfragen, ändern, erzeugen oder löschen. Die Schnittstelle eignet sich demzufolge für Anbindungen von Drittsystemen aller Art.

Mit Vertec Version 6.1.0.10 wurde der XML Server in den Cloud Server integriert. Das deckt folgende Anforderungen ab:

1. Die Authentisierung erfolgt via Cloudserver Authentication System. Damit ist der XML Server LDAP fähig.
2. Pro XML Session kann ein eigener Vertec.Session Prozess gestartet werden. Damit können Probleme mit langlaufenden Sessions vermieden werden.

Damit der XML Server aktiviert wird, muss im Vertec.ini folgende Einstellung gesetzt sein (Standard):

[CloudServer]
XML Server = true

Der Client muss einen Authentisierungs-Request mit Angabe von Username/Password an den Cloud Server senden. Als Antwort erhält er ein Authentisierungs-Token, welches bei jedem Request im XML Request eingesetzt werden muss. Die genaue Beschreibung finden Sie in der XML Schnittstellen Beschreibung.

Beim Token handelt es sich um ein signiertes Token gemäss dem JWT (java web token) Standard. Es enthält folgende Angaben, die vom Server ausgewertet werden:

• SessionId: eine XML Session-ID (siehe Session Handling unten)
• UserId: die interne ID des eingeloggten Bearbeiters
• Expiration-Date: 1 Tag ab Ausgabe-Datum

Alle ausgegebenen Tokens sind nach einem Neustart des Cloud Servers nicht mehr gültig (der private Key für die Signatur wird beim Starten des Cloud Servers gewürfelt).

• Bei einem XML Request auf /xml wird zuerst das Token auf Gültigkeit und Ablaufdatum geprüft.
• Anschliessend wird geprüft, ob für die XML Session-ID bereits eine Vertec-Session läuft. Falls ja, wird der Request dieser Session übergeben.
• Falls noch keine Session für die angegebene XML Session-ID existiert, wird eine angelegt (bzw. aus dem Idle Pool genommen).
• Das erlaubt ein kontrolliertes Session Management aufgrund des übergebenen Tokens. Wenn der Client in einem XML Request ein neues Token angibt, startet der Cloud Server dafür eine neue Session.
• Eine XML Session hat einen Session Timeout. Wenn für die Zeit des Timeout kein neuer Request für die Session empfangen wird, dann wird die Session beendet. Das ist sinnvoll, damit vom Client in kurzer Folge abgesetzte Requests auf dieselbe Session kommen. Der Session Timeout beträgt standardmässig 5 Minuten, kann aber im Vertec.ini gesetzt werden:

  [CloudServer]
  XML Session Timeout = 10

• Das Token kann während seiner Gültigkeit (1 Tag) weiterverwendet werden. Wenn die Session aufgrund des Timeouts beendet wurde, wird einfach eine neue Session gestartet. Dank den Idle Sessions ist die Verzögerung auch bei einer neuen Session minimal.
• Bei mehreren hintereinander formulierten XML Abfragen sollten nicht jedes Mal eine neue Session via Authentisierung gestartet werden. Dies kann schnell zu sehr vielen Vertec Sessions auf dem Server und somit zur Überlastung führen. Stattdessen sollte das beim Authentisieren erhaltene Token während der Laufzeit von zusammenhängenden Abfragen genutzt werden.

Zum Testen von XML Request steht eine einfache Web-Oberfläche unter /xml/query zur Verfügung.

1. Zuerst stehen 2 Felder für Username und Passwort zum Generieren eines Tokens zur Verfügung.
2. Dann öffnet sich die Testing-Oberfläche. Im oberen Bereich kann ein XML Request (nur Body Element) angegeben werden. Envelope und Header mit eingesetztem Token werden beim Absenden automatisch zusammengestellt.
3. Das Ergebnis-XML wird unterhalb dargestellt.

Beachten Sie bitte, dass Sie damit unter Umständen auf Ihre reale Datenbank zugreifen und sich Datenänderungen auf Ihre realen Daten auswirken können, sofern Sie nicht eine unabhängige Testinstallation eingerichtet haben.