Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input System "WebServiceOutputClient"

This input system serves as a client towards the internal web service output system "WebServiceOutput". The input system "WebServiceOutputClient" reads in batches or documents provided by the web service for retrieval, enabling document transfer from one xSuite Interface instance to another. The .InputName of the input fields must correspond to the .OutputName on the opposite side.

Notice

To simplify the configuration, the list of fields can also be left completely empty here. The fields are then implicitly formed from all fields of the field catalog under the field names defined there. If the other side uses an identical field catalog, mapping to separate output and input names can be omitted in this way.

Property

Description

InputSystem.Url*

HTTPS base address of the web service including the port number and, if necessary, with the base URL path of the web service (according to property WebService.UrlBasePath)

InputSystem.ProxyServer

Proxy server for communication to the web service (optional)

Syntax: see Proxy Server Connection

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

  • ApiKey: API key

  • Certificate: client certificate

InputSystem.User(*)

InputSystem].Password(*§)

User name and password for authentication in Windows and Basic modes

In ApiKey mode, these properties are used to specify the key name (as .User, e.g., "Bearer") and the key value (as .Password).

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

InputSystem.Tenant

InputSystem.Scenario*

Name of the tenant (default value: Default) and the source scenario at the web service queried

InputSystem.PreLoadAttachFiles

Boolean value determining whether file attachments of a document to be retrieved will be downloaded in separate web service calls

If this value is false, the file attachments will be embedded in the document and submitted with the document in a single call.

Default value: TRUE

InputSystem.FetchMode

Mode defining how batches and documents are called by the web service:

  • Document: retrieval of single documents (default value)

  • Batch: retrieval of complete batch

In Batch mode, a batch is retrieved from the web service as a whole (i.e., with all its constituent documents). In Document mode, each document is retrieved individually and a separate input batch is created, containing just this one document.

In this section: