IMPORTANT: This documentation has been discontinued. Read the updated SOAP V2 documentation on our new documentation portal.
SOAP V2 invokes SOAP endpoints of a pipeline. Double Braces expressions are supported.
Besides, the component uses Apache Freemaker templates to generate the request message that converts the SOAP return into JSON, trying its best not to disrupt the conversion.
Take a look at the configuration parameter of the component:
URL: URL to be called - it may contain parameters following the {:param1} pattern, which will be replaced by the corresponding input message property.
Account: account to be used by the component.
Send the Request Body from a File: if enabled, the options considers the content to be sent in the call through a file; otherwise, it will be considered what's specified in "Template".
File Name: informs the name of the file to be sent in the SOAP call, if the “Send the Request Body from a File” option is enabled.
Template: Apache FreeMarker template for the SOAP message to be sent in the request.
HEADERS: headers of the call.
QUERY PARAMS: query parameters of the call.
Connection Timeout: connection expiration time (in milliseconds).
Reading Timeout: maximum time for reading (in milliseconds).
Stop On Client Error: if activated, the option will generate an error and suspend the pipeline execution.
Stop On Server Error: if activated, the option will generate an error and suspend the pipeline execution.
All Values As String: if activated, the option will return all the values inside the XML property in string.
With Spacename: if activated, the option keeps the spacenames in the XML return.
Advanced Settings: advanced configurations.
Allow Insecure Calls To HTTPS Endpoints: ifactivated, the option allows non-reliable calls to HTTPS endpoints to be made.
Raw Mode: if activated, the option receives or passes a payload without being JSON.
Save As Local File: if activated, the option saves the response as a file in the local pipeline directory. The file will be saved only when the SOAP call is successful, that is, if the http status code of the response is between 200 and 399.
Response File Name: file name of complete file path (eg.: tmp/processed/file.txt) where the SOAP call response will be saved at. Double Braces are supported.
Enable Retries: if activated, the option allows new tries.
Maximum Number Of Retries Before Giving Up: maximum number of retries before giving up the call.
Time To Wait Before Each Retry: maximum time between retries (in milliseconds).
body: “<a><b>{{ message.b }}</b><#list><references as reference><c>${reference.name}</c></references></#list></a>”{
headers: {{ message.headers }},
queryParams: {{ message.queryParams }},
references: [
{name:1},
{name:2}
],
b: “test”
}
SOAP V2 in Action
About the template variable
The name of the variable can also contain minus (-), dot (.) and colon (:) at any position, as long as they're escaped with a preceding backslash (\). Otherwise, the signs could be interpreted as operators.
About numbers substitution
<#assign x=42>
${x}
${x?string} <#-- the same as ${x} -->
${x?string.number}
${x?string.currency}
${x?string.percent}
${x?string.computer}
Output
42
42
42
$42.00
4,200%
42
Number Format
<#setting number_format="0.####">
Check if the field isn't null:
<#if varTest??>${varTest}</#if>