SOAP V3

Discover more about the SOAP V3 component and how to use it on the Digibee Integration Platform.

The SOAP V3 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. Double Braces expressions are supported.

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

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, and ntlm 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 consider the content to be sent in the call through a file; otherwise, it will be considered what's specified in Template (XML).

False

Boolean

Request Body File Name (DB)

Informs the name or full file path (i.e. tmp/processed/file.txt) 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) (DB)

Apache FreeMarker template for the SOAP message to be sent in the request. This field will not be available if the Send the Request Body From a File option is enabled.

N/A

String

Headers

Headers of the call.

N/A

Key-value Pairs

Query Params

Query parameters of the call.

N/A

Key-value Pairs

Attachments (MTOM)

Add or remove options to set files or binary content to be sent in the request, using MTOM technology. This field will not be available if the Send the Request Body From a File option is enabled.

N/A

Options of Attachments

Is Binary

If activated, the connector must receive the binary content and the ID of the file to be sent in the request; otherwise, the file name must be informed. Available only when Attachments (MTOM) parameter is added.

False

Boolean

File Name

When the option Is Binary is deactivated, informs the name of the file to be sent along with the XML configured in Template (XML). Available only when Attachments (MTOM) parameter is added.

N/A

String

File ID

When the option Is Binary is activated, informs the ID of the file to be sent along with the XML configured in Template (XML). Available only when Attachments (MTOM) parameter is added.

N/A

String

Base64 Content

When the option Is Binary is activated, informs the Base64 content to be sent along with the XML configured in Template (XML). Available only when Attachments (MTOM) parameter is added.

N/A

String

WS-Security

Configures the request security layer using WS-Security technology. This parameter will not be available if the Send the Request Body From a File option is enabled.

N/A

Options of WS-Security

Type

Type of property to be inserted in the security layer in the XML of the request. Currently, the connector only supports Timestamp and UsernameToken types. Available only when WS-Security parameter is added.

N/A

String

Time to live

Time in seconds to be used to generate the creation and expiration date. Available only if Timestamp is selected in Type.

Integer

Millisecond precision

Defines whether the creation and expiration date must include millisecond precision. Available only if Timestamp is selected in Type.

False

Boolean

Username

Username of the account to be used. Available only if UsernameToken is selected in Type.

N/A

String

Password

Password of the account to be used. Available only if UsernameToken is selected in Type.

N/A

String

Password Type

Type of password to be used (Password Text or Password Digest). Available only if UsernameToken is selected in Type.

N/A

String

Add Nonce

If enabled, includes a Nonce. Available only if UsernameToken is selected in Type.

False

Boolean

Add Created

If enabled, includes the creation date. Available only if UsernameToken is selected in Type.

False

Boolean

Connection Timeout

Connection expiration time (in milliseconds).

30000

Integer

Reading 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

Is Multipart Response

If enabled, a Multipart response from the call will be expected, and a list will be displayed containing each Part returned.

False

Boolean

With Namespace

If activated, the option keeps the namespaces in the XML return.

True

Boolean

Override Response Charset

When enabled, the option will overwrite the charset returned from the endpoint to the charset specified in Response Charset. When disabled, it will respect the charset return in the Content-Type field (within the Headers parameter). If it does not return any charset in Content-Type, the default used will be UTF-8.

True

Boolean

Response Charset

Sets the use of the charset specified in this field. Available only when the Override Response Charset option is active.

UTF-8

String

Advanced Settings

If activated, the following parameters will be available:

False

Boolean

Allow Insecure

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 (e.g., tmp/processed/file.txt) where the SOAP call response will be saved at. Double Braces are supported. This field is shown only if Save as Local File is activated.

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. This field is shown only if Enable Retries is activated.

Integer

Time To Wait Before Each Retry

Maximum time between retries (in milliseconds). This field is shown only if Enable Retries is activated.

Integer

Use Dynamic Account

When the option is active, the component will use the account dynamically. When deactivated, it will use the account statically.

False

Boolean

Account Name

Account name to be set. The name of the account is generated dynamically via the Store Account component.

N/A

String

Scoped

When the option is active, the stored account is isolated to other sub-process. In that case, sub-processes will see their own version of the stored account data. This option is not supported for accounts used in headers or body. To know more about the Scoped flag, check out the Dynamic Accounts documentation.

False

Boolean

Currently, the Use Dynamic Account, Account Name and Scoped parameters can only be used in Pipeline Engine v2 and are only available in the Restricted Beta phase. To learn more about it, read the article Beta program.

Parameters additional information

Add Created

The Username and Password properties must be configured using the Custom Account #1 or Custom Account #2 (BASIC-type account) fields.

Using MTOM technology

To use MTOM technology, it is necessary that the file or content in Base64 be referenced directly in the XML of the request, being replaced by the value configured in File Name or File ID inside the standard <inc:Include> tag next to the namespace xmlns:inc="http://www.w3.org/2004/08/xop/include" required, referring to MTOM.

Take into account that File Name or File ID are available only when Is Binary is activated in Attachments (MTOM).

See the example below when setting the File Name/File ID field with the value "myImage.png":

XML original:

<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
        ...
        <file>iVBORw0KGgoAAAAN... (Base64 content)</file>
        ...
   </soapenv:Body>
</soapenv:Envelope>

XML activating MTOM:

<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
        ...
        <file><inc:Include href="cid:myImage.png" xmlns:inc="http://www.w3.org/2004/08/xop/include"/></file>
        ...
   </soapenv:Body>
</soapenv:Envelope>

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

Number Format

<#setting number_format="0.####">

Check if the field isn't null:

<#if varTest??>${varTest}</#if>

PreviousREST V1 (Deprecated)NextSOAP V2

Last updated 1 year ago