SOAP Client (Collector)

The SOAP functions allow you to retrieve, process, and send data to web services via the SOAP messaging protocol. This function is available as a collector, processor, and forwarder.

All of the functions are designed to structure the SOAP requests and either send, process or receive them in the stream at the designated position.

All data handling is done according to the W3C specifications of the SOAP protocol. This function is also useful when setting up integration with third-party services.

Beta Status

Currently this function is in Beta status and therefore caution must be taken when dealing with sensitive data!

SOAP Client Collector, Processor, and Forwarder

All three functions can handle SOAP requests to/from web services. Several parameters must be entered to execute the necessary requests from the remote server. The functions support Variable Insertion both in the body and URL fields.

A Target URL needs to be entered in the input box, this assigns the target SOAP request address. The SOAP Request Body is used to specify the body content of the target message.

In Result Key, you can assign a name to the result you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable

By selecting on the Include basic access authentication credentials checkbox login parameters can be specified – username and password to access the requested information.

The Headers section allows for the customization of the SOAP headers. The headers can be added by clicking on the "+ Header" button – the mandatory key value and content type can be entered. Existing entries can be removed by clicking on the "-" button next to them.

A Target URL needs to be entered in the input box, this shows the address from where the requests will be collected. The SOAP Request Body is used to specify the body content of the target message.

In Request run limit, specify the number of times the operation should run.

The Request Timeout can be adjusted by entering the desired value in the field input box.

By selecting the Include basic access authentication credentials checkbox login parameters can be specified – username and password to access the requested information.

The Headers section allows for the customization of the SOAP headers. The headers can be added by clicking the "+ Header" button – the mandatory key value and content type can be entered. Existing entries can be removed by clicking on the "-" button next to them.

Below the headers section, you can use the Enable preview for this function checkbox to enable or disable the preview data option.

SOAP Clients Additional Functionality

Some of the clients expose additional properties that you can configure:

For the SOAP Processor Client In Result Key, you can assign a name to the result you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable.
For the SOAP Collector Client, the Request Timeout can be adjusted by entering the desired value in the field input box.

URL Entry

Usage Engine interprets only a single forward slash in the URL fields. Ensure that you format the URLs accordingly.

Useful Information

The SOAP protocol is primarily used for API service interactions. SOAP requests are used to exchange data between different platforms in a uniform structure.

For example, the users can extract values from a return SOAP response by specifying the following:

"url" = payload.soapResponse["soapenv:Envelope"]["soapenv:Body"]["loginResponse"]["result"]["serverUrl"]