SOAP V2

Know the component and how to use it.

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.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Parameter	Description	Default value	Data type
URL (DB)	URL to be called - it may contain parameters following the {:param1} pattern, which will be replaced by the corresponding input message property.	https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente	String
Account	Account to be used by the component. Supported accounts: Basic, Certificate Chain. Read the Accounts documentation to learn more about available account types.	N/A	String
Custom Account #1	Additional account to be used by the component through Double Braces {{ account.custom-1.value }}. Read the article Double Braces Functions to learn more about the topic.	N/A	String
Custom Account #2	Additional account to be used by the component through Double Braces {{ account.custom-2.value }}. Read the article Double Braces Functions to learn more about the topic.	N/A	String
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.	False	Boolean
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.	N/A	String
Template (XML)	Apache FreeMarker template for the SOAP message to be sent in the request.	N/A	String
Headers	Headers of the call.	N/A	Object/Map
Query Params	Query parameters of the call.	N/A	Object/Map
Connect Timeout	Connection expiration time (in milliseconds).	30000	Integer
Read Timeout	Maximum time for reading (in milliseconds).	30000	Integer
Stop On Client Error	If activated, the option will generate an error and suspend the pipeline execution.	False	Boolean
Stop On Server Error	If activated, the option will generate an error and suspend the pipeline execution.	False	Boolean
All Values As String	If activated, the option will return all the values inside the XML property in string.	False	Boolean
With Namespace	If activated, the option keeps the namespaces in the XML return.	True	Boolean
Advanced Settings	Advanced configurations.	False	Boolean
Allow Insecure Calls To HTTPS Endpoints	If activated, the option allows non-reliable calls to HTTPS endpoints to be made.	False	Boolean
Raw Mode	If activated, the option receives or passes a payload without being JSON.	False	Boolean
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.	False	Boolean
Response File Name (DB)	File name of complete file path (eg.: tmp/processed/file.txt) where the SOAP call response will be saved at. Double Braces are supported.	N/A	String
Enable Retries	If activated, the option allows new tries.	False	Boolean
Maximum Number Of Retries Before Giving Up	Maximum number of retries before giving up the call.	0	Integer
Time To Wait Before Each Retry	Maximum time between retries (in milliseconds).	0	Integer
Override Response Charset	When activated, the option will overwrite the charset returned from the endpoint to the charset specified in the Response Charset property. When disabled, it will respect the charset return in the Content-Type header. If no charset is returned in the content type, the default used will be UTF-8.	True	Boolean
Response Charset	Used only when the Override Response Charset option is active and will force the use of the charset specified in this property.	UTF-8	String

Messages flow

Input

body: “<a><b>{{ message.b }}</b><#list><references as reference><c>${reference.name}</c></references></#list></a>”

Output

{
    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

Input

<#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>