Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Output System "WebServiceGeneric"

The "WebServiceGeneric" output system is used to send data to any external REST web service. The prerequisite for this is that the requirements of the web service for the structure of data and authentication procedure match the functionality of xSuite Interface. Individual HTTP header data records cannot be configured in xSuite Interface, for example.

The "WebServiceGeneric" output system only supports the output of file attachments. The output of index fields is not possible. A file attachment might be, for example, a JSON file that was previously generated from index field contents via the JSON output format and is to be passed to the REST web service as body content. File attachments in JSON format and in XML format are implicitly sent as string content. Other formats are sent as binary file attachments.

Transfer as multipart data is not implemented (i.e., multiple file attachments are sent to the target web service one after the other in separate calls). Possible return values of the web service are always read as string values. Other types (e.g., binary data) are not explicitly supported.

Property

Description

OutputSystem[].Url*(%)

Full URL of the web service to be called, including the path and the parameter, if necessary

OutputSystem[].ProxyServer

Proxy server for communication to the web service (optional)

Syntax: see Proxy Server Connection

OutputSystem[].Method

HTTP method used for the call

Default value: POST

OutputSystem[].AuthMode

Mode for authentication against web service:

  • None: no authentication (default value)

  • 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 Basic mode

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

Name of a field from the field catalog (optional)

The response of the web service (body content) is written back to this field.

If multiple file attachments are transferred individually, which results in multiple responses, they will all be combined into one value. The prerequisite is that a separator is defined. Use the separator defined under OutputSystem[].MultiValueSep for this, even if this is normally intended for transfer data and not for the return data.

OutputSystem[].ResponseFileName(%)

Name of a file attachment if one is to be created from the web service response (body content) and added to the document (optional)

If the response data is transferred to a file attachment, in this context it will always be treated as text data (e.g., JSON or XML) and not as binary data.

In this section: