IMPORTANT: This documentation has been discontinued. Read the updated Template and its uses documentation on our new documentation portal.
Know some validations and treatments that can be done with the Freemarker language when you use Template Transformer. To know more about this component, click here and read the article about it.
For the examples you'll see coming next, consider this input JSON:
{
"request": {
"code": 213,
"value": 4513423.1322,
"description": " test request ",
"items": [
{
"name": "item 1",
"quantity": 2
},
{
"name": "item 2",
"quantity": 1
}
]
}
}
LIST
Enables you to make iterations in an array (list) in JSON. Imagine this function in the creation of a dynamic elements list in the output, that transforms JSON into XML.
Syntax
<#list YourList of elements>
block of information to be iterated.
</#list>
Example
Using the input informed in the beginning of this article, you can create a dynamic elements list using the template.
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<soap:Body>
<web:request>
<web:items>
<#list items as item>
<web:item>
<web:nome>${item.name}</web:name>
<web:quantity>${item.quantity}</web:quantity>
</web:item>
</#list>
</web:items>
</web:request>
</soap:Body>
</soap:Envelope>
XMP output
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:items>
<web:item>
<web:name>item 1</web:name>
<web:quantity>2</web:quantity>
</web:item>
<web:item>
<web:name>item 2</web:name>
<web:quantity>1</web:quantity>
</web:item>
</web:items>
</web:request>
</soap:Body>
</soap:Envelope>
IMPORTANT: remember that the Template output is a XML in a string.
IF/ELSE
You can use this function to validate some information. Even when its fields are null or empty, there's no great impact in your data transformation.
Syntax
<#if condition>
Block of information in case the condition in if is true.
<#elseif Syntax>
Block of information in case the condition in elseif is true.
<#else>
Block of information in case none of the conditions are taken.
</#if>
There's no limitation for the quantity of elseif and it's also possible to use just an if without the else - it all depends on your need.
Example
Using the input informed in the beginning of this article, you can create a validation in which the "code" field needs to be greater than 0 (zero).
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<so ap:Body>
<web:request>
<web:code><#if code > 0 >${code}</#if></web:code>
</web:request>
</soap:Body>
</soap:Envelope>
XML output
If the condition is true:
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:code>213</web:code>
</web:request>
</soap:Body>
</soap:Envelope>
If the conditions is false:
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:code></web:code>
</web:request>
</soap:Body>
</soap:Envelope>
Did you know the use of the function isn't limited to simple conditions? You can also use expressions to validate if the field exists (??) or if it has content (has_content).
Syntax
<#if yourField?? && yourField?has_content>
Block of information if the field exists and has content.
<#else>
Block of information if none of the conditions is taken.
</#if>
IMPORTANT: it's possible to use logical operators for a more advanced condition.
&& - for AND.
|| - for OR.
Example
Now see how to improve the validation so that the if applied in the first case is used only if the "code" field exists and has content.
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<so ap:Body>
<web:request>
<#if code?? && code?has_content>
<web:code><#if code gt 0 >${code}</#if></web:code>
</#if>
</web:request>
</soap:Body>
</soap:Envelope>
XML output
If the condition is true:
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:code>213</web:code>
</web:request>
</soap:Body>
</soap:Envelope>
If the condition is false...
... and the "code" field has a value that is null, empty or doesn't come in the input:
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
</web:request>
</soap:Body>
</soap:Envelope>
TRIM
This function is used to remove the blank spaces in the beginning and in the end of a string.
Syntax
${YourField?trim}
Example
Using the input informed in the beginning of this article, you can remove the blank spaces in the beginning and in the end of the "description" field".
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<soap:Body>
<web:request>
<web:description>${description?trim}</web:description>
</web:request>
</soap:Body>
</soap:Envelope>
XML output
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:description>test request</web:description>
</web:request>
</soap:Body>
</soap:Envelope>
REPLACE
This function is used to replace a pre-established value in the field.
Syntax
${YourField?replace}
Example
Using the input informed in the beginning of this article, you can replace the "test" value in the description by "prod".
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<soap:Body>
<web:request>
<web:description>${description?replace("test","prod")}</web:description>
</web:request>
</soap:Body>
</soap:Envelope>
XML output
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:description> prod request </web:description>
</web:request>
</soap:Body>
</soap:Envelope>
SLICE (SUBSTRING)
This function is used when the field must have a determined size.
Syntax
${YourField[0..9]}
0 = initial value
9 = final value
Example
Using the input informed in the beginning of this article, you can determine for the field to have 10 characters only, even if it has a greater size.
IMPORTANT: a good practice applicable to this function is to use IF/ELSE to validate the desired size for the field. That way, you avoid errors if the field is smaller than the established value.
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<soap:Body>
<web:request>
<#if description?length < 10>
<web:description>${description}</web:description>
<#else>
<web:description>${description[0..9]}</web:description>
</#if>
</web:request>
</soap:Body>
</soap:Envelope>
XML output
<soap:Envelope
xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\"
xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:description> request </web:description>
</web:request>
</soap:Body>
</soap:Envelope>
LOCALE
This function is used in the template to set the location in a numeric value.
Syntax
<#setting locale="en_US">
${YourField}
<#setting locale="pt_BR">
${YourField}
To use it, you must provide the tag before the dynamic field. Check how to do it in the examples below.
Example
Using the input informed in the beginning of this article, you can format the value to be in the legacy system standard.
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<soap:Body>
<web:request>
<#setting locale="en_US">
<web:value_US>${value}</web:value_US>
<#setting locale="pt_BR">
<web:value_BR>${value}</web:value_BR>
</web:request>
</soap:Body>
</soap:Envelope>
XML output
<soap:Envelope
xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\"
xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:value_US>4,513,423.13</web:value_US>
<web:value_BR>4.513.423,13</web:value_BR>
</web:request>
</soap:Body>
</soap:Envelope>
Custom
If the desired format isn't accepted by your system, you can define the necessary number for formatting through the "number_format" tag. It allows the number to be personalized treated.
Syntax
<#setting number_format="0.##">
${yourField}
IMPORTANT: the hashtags (#) define the quantity of decimal places to be used.
Example
Using the input informed in the beginning of this article, you can format the value to be in the legacy system standard.
What you must inform in the template is:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://www.webservicex.net/">
<soap:Header/>
<soap:Body>
<web:request>
<#setting number_format="0.#">
<web:custom_value>${value}</web:custom_value>
<#setting locale="pt_BR">
</web:request>
</soap:Body>
</soap:Envelope>
XML output
<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:web=\"http://www.webservicex.net/\">
<soap:Header/>
<soap:Body>
<web:request>
<web:custom_value>4513423.1</web:custom_value>
</web:request>
</soap:Body>
</soap:Envelope>