Support vertec.com

Vertec XML Schnittstelle

Vertec ist mit einer XML Schnittstelle ausgerüstet. Diese wird vom Vertec XML Server bereitgestellt. Mit dieser Schnittstelle können Anfragen in XML formuliert und via http an Vertec geschickt werden. Die Antwort kommt ebenfalls in XML formatiert.

Standard

|

Expert

CLOUD ABO

|

ON-PREMISES

Leistung & CRM

Budget & Teilprojekt

Fremdkosten

Ressourcen & Projektplanung

Business Intelligence

Erstellt: 13.06.2022
Aktualisiert: 14.06.2022 | Zusammenführung der Artikel XML Server und XML Schnittstelle.

Mit der XML Schnittstelle lassen sich alle Daten aus Vertec abfragen, erzeugen, ändern, 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

Die Kommunikation basiert auf dem Request / Response Schema. Ein Client schickt via HTTP POST eine in XML formulierte Anfrage und erhält als Ergebnis eine Antwort in XML.

Das Format der dabei verwendeten XML Messages basiert auf der SOAP Spezifikation. Vollständige SOAP Kompatibilität ist nicht umgesetzt, insbesondere die Behandlung von XML Namespaces fehlt. Namespaces können in Requests verwendet werden, finden aber keine Beachtung. Die Response Messages verwenden keine Namespace Informationen.

Der Aufbau der XML Messages ist grundsätzlich immer gleich. So enthält jede Message, ob Request oder Response, immer das Grundelement Envelope und als Unterelement 'Body':

<Envelope>
   <Body>
   </Body>
 </Envelope>

XML Server

Authentisierung

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 Authentisierung erfolgt in zwei Schritten:

  1. Authentisierung: Der Client muss einen Authentisierungs-Request mit Angabe von Username/Password an den Cloud-Server senden.
    • Senden von HTTP POST Request mit Parametern vertec_username und password an /auth/xml.
    • Als Antwort wird ein Authentisierungs-Token (ein langer String) gesendet.
    • Beispiel aus einem Python Script:
      import requests
      
      authurl = 'http://localhost/auth/xml'
      xmlurl = 'http://localhost/xml'
      params = {'vertec_username':'keller', 'password':'UXhfn6P.'}
      r = requests.post(authurl, params)
      token = r.text

      Dafür muss das requests-Modul vorhanden sein, siehe z.B. http://docs.python-requests.org/en/master/.

    • Beispiel aus einem VB Script:
      Set XML = CreateObject("MSXML2.XMLHTTP")
      XML.Open "POST", "http://localhost:8081/auth/xml", False
      XML.send "&vertec_username=administrator&password="
      token = XML.responsetext
  2. XML Requests: Der Client muss das Authentisierungs-Token bei jedem Request im XML Request einsetzen, damit dieser akzeptiert wird. Das Token wird als <Token> Element unter <BasicAuth> eingesetzt. Beispiel:
    <Envelope>
      <Header>
        <BasicAuth><Token>.....token ......</Token></BasicAuth>
      </Header>
      <Body>
        <Query>
          <Selection>
            <ocl>projektbearbeiter</ocl>
          </Selection>
        </Query>
      </Body>
    </Envelope>
    

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).

Session Handling

  • 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.

Testen der XML Schnittstelle

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.

Encoding

Der XML Server arbeitet mit UTF-8 Encoding, beim Senden und Empfangen von Daten.

XML Request

Der XML Request enthält einen Header, in welchem die Authentisierungs-Informationen übertragen werden.

<Envelope>
  <Header>
  </Header>
  <Body>
  </Body>
 </Envelope>

Der Body enthält dann die eigentliche Abfrage:

Objekte abfragen (Query)

Um Objekte mittels XML Message abzufragen, wird der Abfrage-Block in ein Query-Element verpackt. Dieses Element enthält wiederum die Elemente Selection und Resultdef.

<Query>
  <Selection>
    <objref>676</objref>
    <ocl>offeneleistungen</ocl>
    <sqlwhere>datum between '01.10.2021' and '31.12.2021'</sqlwhere>
    <sqlorder>bold_id</sqlorder>
  </Selection>
  <Resultdef>
    <member>datum</member>
    <member>projekt</member>
    <member>text</member>
    <member>wertext</member>
  </Resultdef>
</Query>

Selection-Element

Im Selection-Element wird die eigentliche Abfrage zusammengestellt. Folgende Unterelemente können verwendet werden:

  • objref: Gibt die Objekt-ID eines Objekts in Vertec an (Normalerweise wird die Objekt-ID über eine vorhergehende XML Abfrage eruiert). Es können auch mehrere Objekte ausgewählt werden:
    <objref>4019</objref>
    <objref>5129</objref>
  • ocl: Hier wird eine OCL Expression angegeben. Ist ein Objekt via <objref> angegeben, wird die Expression auf diesem Objekt ausgewertet, ansonsten global.
    <ocl>offeneleistungen</ocl>
  • sqlwhere: Hier kann ein SQL-Filter angegeben werden:
    <sqlwhere>datum between '01.10.2021' and '31.12.2021'</sqlwhere>

    Der ausführende Benutzer muss über Administratorenrechte oder über das SQL Query Recht verfügen.

  • sqlorder: Die Einträge können sortiert werden:
    <sqlorder>bold_id</sqlorder>

Resultdef-Element

Das Resultdef-Element gibt an, welche Informationen angefordert werden. Es können folgende Unterelemente verwendet werden:

  • member: Hier wird in OCL ein Member des Resultat-Objekts angegeben.Handelt es sich beim angegebenen Member um ein eigenständiges Objekt, wird davon die Vertec Objekt-ID zurückgeliefert (im Beispiel für das Member projekt). Es können beliebig viele Members aufgelistet werden.
  • alias-expression: Möchte man ein member um if-else-Bedingungen oder Berechnungen erweitern, wird ein Alias in einer Expression verwendet. In dieser können OCL Expressions eingesetzt werden. Der Aufbau ist wie folgt:
    <expression>
     <alias>abgeschrieben</alias>
     <ocl>wertint-wertext</ocl>
    </expression>

    Im <ocl>-Bereich sind sämtliche OCL Expressions möglich.

Es muss nicht unbedingt ein Resultdef-Element angegeben werden. Wird nur ein einzelner Wert angefordert (und nicht, wie oben beschrieben, eine Liste von Objekten), kann dieses Element einfach weggelassen werden. Z.B. liefert die Selection <ocl>projektbearbeiter->size</ocl> die Anzahl Bearbeiter zurück. Die Response liefert dann einen <Value>Anzahl</Value> zurück.

XML Response

QueryResponse-Element

Das Resultat wird in einem QueryResponse-Element zurückgeliefert. Dieses enthält immer eine Auflistung von Objekten.

  • objid: Jedes zurückgelieferte Objekt wird als eigenständiges Element geliefert. Bei jedem dieser Result-Objekten wird eine objid mitgeliefert, welche die Vertec Objekt-ID enthält:
    <objid>7822</objid>

Des Weiteren werden alle unter Resultdef angegebenen Members aufgelistet. Falls es sich dabei um eigenständige Objekte handelt, wird von diesen die Objektreferenz (Objekt-ID) mitgeliefert:

<Envelope>
  <Body>
    <QueryResponse>
      <OffeneLeistung>
        <objid>7822</objid>
        <datum>2021-11-14</datum>
        <projekt><objref>4164</objref></projekt>
        <text>Brief an Hr. Meier<text/>
        <wertExt>120.00</wertExt>
      </OffeneLeistung>
      ...

Anmerkung: Das Datumsformat ist ISO 8601.

Objekte erzeugen (Create)

Create-Element

Um ein Objekt zu erzeugen wird ein Create-Element verwendet. Dieses enthält eine Liste von zu erzeugenden Objekten. Als zu erzeugendes Objekt wird jeweils der entsprechende Klassenname angegeben. Die einzelnen Members enthalten entweder eine Objektreferenz (Objekt-ID) eines bestehenden Objektes in Vertec oder den beim Member einzutragenden Wert.

Als Beispiel wird eine offene Leistung erzeugt. Dieser wird ein bereits bestehender Bearbeiter und ein bereits bestehendes Projekt mittels Objekt-ID zugewisen. Als Aufwand wird im Attribut minutenint 45 Minuten eingetragen:

<Create>
    <OffeneLeistung>
      <bearbeiter><objref>4036</objref></bearbeiter>
      <projekt><objref>4132</objref></projekt>
      <minutenint>45</minutenint>
    </OffeneLeistung>
</Create>

CreateResponse-Element

Zurückgeliefert wird ein CreateResponse-Element. Dieses enthält eine Liste der erzeugten Objekten, die jeweils den Klassennamen des erzeugten Objektes angibt. Diese wiederum enthalten folgende Unterelemente:

  • objid: Gibt die Objekt-ID des neu erzeugten Objektes an.
  • isValid: Gibt an, ob das erzeugte Objekt in Vertec gültig ist (1) oder nicht (0).
<Envelope>
  <Body>
    <CreateResponse>
      <OffeneLeistung>
        <objid>12019</objid>
        <isValid>1</isValid>
      </OffeneLeistung>
      ...
    </CreateResponse>
  </Body>
</Envelope>

Objekte ändern (Update)

Update-Element

Das Ändern von Objekten funktioniert ähnlich wie das Erzeugen, einfach wird dafür ein Update-Element verwendet. Dieses enthält eine Liste von zu ändernden Elementen. Angegeben wird jeweils der Klassenname des zu ändernden Objekts als Unterelement.

  • objref: Für jedes zu ändernde Element muss die Objektreferenz (Objekt-ID) angegeben werden. Wichtig ist, dass diese zuoberst angegeben wird, also vor den anderen Attributen, sonst wird die Änderung nicht durchgeführt.
  • Weiter müssen die zu ändernden Attribute angegeben werden. Im Beispiel wird bei einem Projektbearbeiter mit der Objekt-ID 4019 als Kürzel CKE eingetragen:
<Update>
    <Projektbearbeiter>
      <objref>4019</objref>
      <kuerzel>CKE</kuerzel>
    </Projektbearbeiter>
    ...
</Update>

Ändern von Zusatzfeldern

Das Ändern von Zusatzfeldern funktioniert gleich wie oben, als Membernamen wird einfach der Name des Zusatzfeldes eingesetzt. Im Beispiel wird im Zusatzfeld Projektstand auf einer Projektphase mit der ID 5491 der Text Angefangen eingetragen:

<Update>
  <Projektphase>
    <objref>5491</objref>
    <Projektstand>Angefangen</Projektstand>
  </Projektphase>
</Update>

Key-Values und Tags setzen

Ab Vertec 6.3 können Key-Values und Tags über den XML Server gesetzt bzw. entfernt werden. Dafür gibt es folgende Elemente:

  • <keyvalue> mit Sub-Elementen <key> und <value>
  • <tag> mit Sub-Elementen <add> und <remove>
<Update>
    <Projektbearbeiter>
        <objref>4019</objref>
        <kuerzel>ABC</kuerzel>
        <keyvalue>
            <key>ExternalId</key>
            <value>123465</value>
        </keyvalue>
        <tag>
            <add>selected</add>
        </tag>
    </Projektbearbeiter>
</Update>

Die Abfrage von bestehenden Key-Values bzw. Tags im Query-Element kann wie gewohnt via OCL erfolgen, hier gibt es keine speziellen Elemente:

<Query>
    <Selection>
        <ocl>projektbearbeiter->select(hasTag('selected'))</ocl>
    </Selection>
    <ResultDef>
        <member>kuerzel</member>
    </ResultDef>
</Query>

Einen Wert auf NULL setzen

Um einen Wert, der bereits gesetzt ist, wieder zu leeren (auf NULL setzen), können Sie dem Attribut einen leeren Wert zuweisen. Im Beispiel wird die Tagespauschale auf dem Bearbeiter geleert:

<Update>
    <Projektbearbeiter>
        <objref>300</objref>
        <tagespauschaleext/>
    </Projektbearbeiter>
</Update>

Ja/Nein Werte (Boolean) setzen

Ja/Nein-Werte (Booleans) werden mit 0 und 1 gesetzt:

  • 0: Nein
  • 1: Ja
<Update>
    <Projekt>
        <objref>2880</objref>
        <aktiv>1</aktiv>
        <myboolean>0</myboolean>
    </Projekt>
</Update>

Etwas verwirrlich ist, dass es bei der Abfrage von Boolean-Werten einen Unterschied von eingebauten Feldern und Zusatzfeldern gibt. Eingebaute Boolean-Felder wie z.B. aktiv auf Projekten liefern 1 und 0, die Boolean-Zusatzfelder jedoch Y und N zurück.

Das Setzen erfolgt jedoch in beiden Fällen gleich, nämlich wie oben beschrieben mit 0 und 1.

Benötigt man einen einheitlichen XML-Response, kann man anstelle der einfachen <member>-Abfrage eine Expression angeben, die den Rückgabewert steuert:

<expression><alias>myboolean</alias><ocl>if zusatzfeldbool('myboolean') then 1 else 0 endif</ocl></expression>

UpdateResponse-Element

Zurückgeliefert wird ein UpdateResponse-Element mit folgendem Unterelement:

  • text: Gibt an, wieviele Objekte geändert wurden.
    <Envelope>
      <Body>
        <UpdateResponse>
          <text>Updated 1 Objects</text>
        </UpdateResponse>
      </Body>
    </Envelope>

Objekte löschen (Delete)

Delete-Element

Um ein Objekt zu löschen, wird ein Delete-Element verwendet. Dieses enthält eine Liste der zu löschenden Objekte:

  • objref: Für jedes zu löschende Element wird die entsprechende Objektreferenz (Objekt-ID) angegeben.
    <Delete>
        <objref>11764</objref>
        ...
    </Delete>
    

DeleteResponse-Element

Zurückgeliefert wird ein DeleteResponse-Element mit folgendem Unterelement:

  • text: Gibt an, wie viele Objekte gelöscht wurden.
    <Envelope>
      <Body>
        <DeleteResponse>
          <text>Deleted 1 Objects</text>
        </DeleteResponse>
      </Body>
    </Envelope>
Bitte wählen Sie Ihren Standort