Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output Systems "XSuiteInterface4Rest", "XSuiteInterface4Soap"

The output systems "XSuiteInterface4Soap" and "xSuiteInterface4Soap" serve to transfer documents to the REST or the SOAP web service input interface of an xSuite Interface 4.x instance.

The documents are transferred to an active input system "xFlowIRestService" or "xFlowIWebService" in the form of pseudo-batches, each with a single document.

Property

Description

OutputSystem[].Url*

Full HTTP or HTTPS address of the xSuite Interface web service to be called, including port number and URL path, if applicable

This specification is analogous to the .Address key of the corresponding input interface in xSuite Interface 4.

For the SOAP interface, the fixed name /xFlowIWebService of the service must also be added as the last sub-path.

OutputSystem[].ProxyServer

Proxy server for connection to the web service (optional)

Syntax: see Proxy Server Connection

OutputSystem[].AuthMode

Mode for authentication against web service:

  • None: no authentication (default value)

  • Windows: NTLM authentication with Windows user

  • Basic: basic authentication with user name and password

  • Certificate: client certificate

OutputSystem[].User(*)

OutputSystem[].Password(*§)

User name and password for authentication in Windows und Basic mode

If no user is specified in Windows mode, the current user context in which the program is executed will apply.

OutputSystem[].CertificateName(*)

Name of the client certificate for authentication in Certificate mode

This corresponds to the .Name property of a certificate defined globally under Certificate[]. On the certificate, the intended purpose Certificate[].Usage: "Client" must be stated.

OutputSystem[].InternalMode

Boolean value determining whether an internal mode will be used for the transfer of the field values, allowing simplified field mapping between two xSuite Interface instances

Default value: TRUE

OutputSystem[].PreLoadAttachFiles

Boolean value determining whether file attachments are to be transferred to the web service in advance in separate calls

If the mode is deactivated, a single call will be made for the entire document with file attachments embedded directly.

Default value: TRUE

This mode is only available for the REST interface. The mode can be used to divide the amount of data to be transferred into smaller packets for large documents with many file attachments.

IdField

Name of a field from the field catalog into which the ID of the receiving batch generated by the target web service is written back (optional)

Which target field names need to be defined under .OutputName depends on whether InternalMode is enabled. If this mode is enabled, the internal field names from the target system's field catalog are to be used and the .OutputFormat will not apply, since a type-compliant transfer is performed with the fields' current data type. Otherwise, configure .OutputName and .OutputFormat to explicitly correspond with the .InputName and .InputFormat of the target fields.

In this section: