SOAP Client (Forwarder)
- Casey Han
The SOAP forwarder client is designed to send requests to web services or servers, and retrieve corresponding responses. It enables rapid integration with web services by ensuring secure and reliable data transmission, making it a practical solution for interacting with and integrating third-party systems.
Settings
Setting | Description |
|---|---|
Environment | |
Target URL | Enter the Target URL of the target web server or service you want to connect to. Note! Usage Engine Cloud Edition interprets only a single forward slash in the URL fields. Ensure that you format the URLs accordingly. Note! This field supports URL interpolation. See Variable Insertion for more information. |
Authentication | |
Select from secrets wallet | Note! This option only appears when the Authentication toggle is enabled. Select a secret with the SOAP secret type. |
Header | |
Key | Enter the key of the header request. The content type is mandatory. You can add additional headers by clicking the Add Header button.  |
Value | Enter the value of the header request. |
Request | |
SOAP request body | Select one of the following formats to write the request body.
The default format is XML. |
Operational settings | |
Request timeout | Define the wait time for receiving a response in the Request Timeout field input box by entering the desired value (max 300 seconds). If no response is received within the specified time, the action selected in Action on error will be executed. |
Retry on fail | Check the Retry on fail check box to retry the operation if any 5xx error codes have been returned due to intermittent server issues. You can specify the number of retries in the Number of retries field, where the retries will be attempted inside the dynamically adjusted period of retry time. |
Action on error | Select the action you want to take in case of an error, the options are:
Any response with the HTTP status code 4xx or 5xx is considered an error. All errors get logged in the system logs. See Logs for more information. The default value is Ignore. |
Response handling | |
Select Interconnect receiver | Enabling the Response handling toggle will allow you to Select Interconnect receiver. When enabled, the SOAP forwarder can send the response details, and the request body from the SOAP web server through an Interconnect Sender to a selected existing Interconnect Receiver. A second stream can use the Interconnect Receiver to accept the response details, and the request body forwarded by the SOAP forwarder, to track the status of the request in the web server. If the stream fails for any reason, the SOAP forwarder will not send anything through the Interconnect Sender. |
Input/Output Data
Input Data
The SOAP request header and body as configured in the function.
Below is a sample request in XML format.
<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
<soap:Header>
headerValue
</soap:Header>
<soap:Body>
<soap:Fault>
faultValue
</soap:Fault>
</soap:Body>
</soap:Envelope>Below is a sample request in JSON format.
{
"?xml": { "@_version": "1.0" },
"soap:Envelope": {
"@_xmlns:soap": "http://www.w3.org/2003/05/soap-envelope",
"@_soap:encodingStyle": "http://www.w3.org/2003/05/soap-encoding",
"soap:Header": "myHeader",
"soap:Body": { "soap:Fault": "" }
}
}Output Data
Response from the web service or server.
Below is a sample response.
{
"soapForwarderStatus": 200,
"soapForwarderResponseHeaders": {
"content-type": "application/soap+xml; charset=utf-8",
"content-length": 999
},
"soapForwarderResponse": {
"?xml": "",
"soap:Envelope": {
"soap:Body": {
"exampleResponse": 2
}
}
},
"soapForwarderRequestBody": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<soap12:Envelope xmlns:soap12=\"http://www.w3.org/2003/05/soap-envelope\">\n <soap12:Body>\n <ExampleAction xmlns=\"http://tempuri.org/\">\n <input1>1</input1>\n <input2>1</input2>\n </ExampleAction>\n </soap12:Body>\n</soap12:Envelope>",
"soapForwarderRequestHeaders": {
"Accept": "application/json",
"Content-Type": "text/xml; charset=utf-8",
"User-Agent": "axios/1.7.7",
"Content-Length": "254",
"Accept-Encoding": "gzip, compress, deflate, br"
}
}Â