Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output System "WebServiceInputClient"

The output system "WebServiceInputClient" serves as a client towards the internal web service input system "WebServiceInput." This output system enables the document transfer from one xSuite Interface instance to another xSuite Interface instance. The .OutputName of the output fields must correspond to the .InputName 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

OutputSystem[].Url*(%)

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

OutputSystem[].ProxyServer

Proxy server for communication 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

  • ApiKey: API key

  • Certificate: client certificate

OutputSystem[].User(*)

OutputSystem[].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).

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

OutputSystem[].Scenario*

Name of the tenant (default value: Default) and the target scenario at the receiving web service

OutputSystem[].PreLoadAttachFiles

Boolean value determining whether file attachments of a document to be transferred will be sent to the web service in advance in separate calls

Otherwise, the file attachments will be embedded in the document and submitted with the document in a single call.

Default value: TRUE

OutputSystem[].IdField

Name of a field from the field catalog (optional)

The ID of the receiving batch that was generated by the target web service will be written back to this field.

In this section: