Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Ausgabesysteme "XSuiteInterface4Rest", "XSuiteInterface4Soap"

Die Ausgabesysteme "XSuiteInterface4Rest" und "XSuiteInterface4Soap" dienen der Übertragung von Dokumenten an die REST- oder an die SOAP-Webservice-Eingabeschnittstelle einer Instanz von xSuite Interface 4.x.

Die Dokumente werden in der Form von Pseudo-Stapeln mit je einem einzelnem Dokument an ein aktives Eingabesystem "xFlowIRestService" oder "xFlowIWebService" übergeben.

Eigenschaft

Beschreibung

OutputSystem[].Url*

vollständige HTTP- oder HTTPS-Adresse des aufzurufenden xSuite-Interface-Webservices inkl. Portnummer und ggf. URL-Basispfad

Diese Angabe erfolgt analog zum .Address-Schlüssel der korrespondierenden Eingabe­schnittstelle in xSuite Interface 4.

Bei der SOAP-Schnittstelle muss als letzter Teilpfad zusätzlich der feste Name /xFlowIWebService des Dienstes angefügt werden.

OutputSystem[].ProxyServer

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

Syntax: siehe Proxy-Server-Verbindung

OutputSystem[].AuthMode

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

  • None: keine Authentifizierung (Standardwert)

  • Windows: NTLM-Authentifizierung mit Windows-Benutzer

  • Basic: Basisauthentifizierung mit Benutzername und Passwort

  • Certificate: Client-Zertifikat

OutputSystem[].User(*)

OutputSystem[].Password(*§)

Benutzername und Passwort für die Authentifizierung im Modus Windows und Basic

Wenn im Modus Windows kein Benutzer angegeben ist, gilt der aktuelle Benutzerkontext, in dem das Programm ausgeführt wird.

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[].InternalMode

Wahrheitswert, ob für die Übertragung der Feldwerte ein interner Modus genutzt wird, der ein vereinfachtes Feld-Mapping zwischen 2 xSuite-Interface-Instanzen ermöglicht

Standardwert: FALSE

OutputSystem[].PreLoadAttachFiles

Wahrheitswert, ob Dateianlagen in separaten Aufrufen vorab zum Webservice übertragen werden

Wenn der Modus deaktiviert ist, erfolgt ein einzelner Aufruf für das gesamte Dokument mit direkt eingebetteten Dateianlagen.

Standardwert: FALSE

Dieser Modus ist nur für die REST-Schnittstelle verfügbar. Der Modus kann genutzt werden, um bei großen Dokumenten mit vielen Dateianlagen die zu übertragende Datenmenge in kleinere Pakete zu unterteilen.

IdField

optionaler Name eines Feldes aus dem Feldkatalog, in das die vom Ziel-Webservice generierte ID des empfangenen Stapels zurückgeschrieben wird

Die Zielfeldnamen, die unter .OutputName zu definieren sind, sind abhängig davon, ob der InternalMode aktiviert ist. Wenn dieser Modus aktiviert ist, sind die internen Feldnamen aus dem Feldkatalog des Zielsystems zu verwenden und das .OutputFormat ist nicht relevant, da eine typgerechte Übergabe mit dem aktuellen Datentyp der Felder erfolgt. Anderenfalls sind .OutputName und .OutputFormat explizit so zu konfigurieren, dass diese mit dem .InputName und .InputFormat der Zielfelder korrespondieren.

In diesem Abschnitt: