Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Ausgabesystem "WebServiceGeneric"

Das Ausgabesystem "WebServiceGeneric" dient dazu, Daten an einen beliebigen externen REST-Webservice zu senden. Voraussetzung hierfür ist, dass die Anforderungen des Webservices an den Aufbau der Daten und an das Authentifizierungsverfahren mit der Funktionalität von xSuite Interface übereinstimmen. Individuelle HTTP-Kopfdatensätze können in xSuite Interface z. B. nicht konfiguriert werden.

Das Ausgabesystem "WebServiceGeneric" unterstützt nur die Ausgabe von Dateianlagen. Die Ausgabe von Indexfeldern ist nicht möglich. Eine Dateianlage kann z. B. eine JSON-Datei sein, die zuvor über das JSON-Ausgabeformat aus Indexfeldinhalten generiert wurde und als Body-Inhalt an einen REST-Webservice übergeben werden soll. Dateianlagen im JSON-Format und im XML-Format werden implizit als String-Inhalt gesendet. Sonstige Formate werden als binäre Dateianlagen gesendet.

Eine Übertragung als Multipart-Daten ist nicht implementiert, d.h. mehrere Dateianlagen werden nacheinander in separaten Aufrufen an den Ziel-Webservice übergeben. Mögliche Rückgabewerte des Webservices werden immer als String-Werte gelesen. Andere Arten, z. B. Binärdaten, werden nicht explizit unterstützt.

Eigenschaft

Beschreibung

OutputSystem[].Url*(%)

vollständige URL des aufzurufenden Webservices, ggf. inklusive Pfad und Parameter

OutputSystem[].ProxyServer

Proxy-Server, der optional für die Kommunikation zum Webservice genutzt wird

Syntax: siehe Proxy-Server-Verbindung

OutputSystem[].Method

HTTP-Methode, die für den Aufruf genutzt wird

Standardwert: POST

OutputSystem[].AuthMode

Modus für die Authentifizierung gegenüber dem Webservice:

  • None: keine Authentifizierung (Standardwert)

  • Basic: Basisauthentifizierung mit Benutzername und Passwort

  • ApiKey: API-Schlüssel

  • Certificate: Client-Zertifikat

OutputSystem[].User(*)

OutputSystem[].Password(*§)

Benutzername und Passwort für die Authentifizierung im Modus Basic

Im Modus ApiKey werden diese Eigenschaften zur Angabe des Schlüsselnamens (als .User, z. B. "Bearer") und des Schlüsselwertes (als .Password) genutzt.

OutputSystem[].CertificateName(*)

Name des Client-Zertifikats für die Authentifizierung im Modus Certificate

Dies entspricht der .Name-Eigenschaft eines Zertifikats, das global unter Certificate[] definiert ist. Das Zertifikat muss den Verwendungszweck Certificate[].Usage: "Client" haben.

OutputSystem[].ResponseField

optionaler Name eines Feldes aus dem Feldkatalog

In dieses Feld wird die Antwort des Webservices (Body-Inhalt) zurückgeschrieben.

Wenn mehrere Dateianlagen einzeln übertragen werden somit mehrere Antworten vorhanden sind, werden diese alle zu einem Wert zusammengefasst. Voraussetzung hierfür ist, dass ein Trennzeichen definiert ist. Dazu wird das Trennzeichen herangezogen, das unter OutputSystem[].MultiValueSep definiert ist, auch wenn dieses regulär für die Übergabedaten und nicht für die Rückgabedaten vorgesehen ist.

OutputSystem[].ResponseFileName(%)

optionaler Name einer Dateianlage, wenn eine solche aus der Antwort des Webservices (Body-Inhalt) erstellt und dem Dokument hinzugefügt werden soll

Wenn die Antwortdaten in eine Dateianlage übernommen werden, werden diese im vorliegenden Kontext immer als Textdaten (z. B. JSON oder XML) und nicht als Binärdaten behandelt.

In diesem Abschnitt: