> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/template-transformer/template-and-its-uses.md). # Template e suas utilizações Conheça algumas validações e tratamentos que podem ser feitos com a linguagem *Freemarker* quando você utiliza o **Template Transformer**. [Para saber mais sobre esse componente, clique aqui e leia o artigo a respeito.](/documentation/connectors-and-triggers/pt-br/connectors/tools/template-transformer.md) Para os exemplos que você verá a seguir, considere o seguinte JSON de entrada: ``` { "pedido": { "codigo": 213, "valor": 4513423.1322, "descricao": " pedido teste ", "itens": [ { "nome": "item 1", "quantidade": 2 }, { "nome": "item 2", "quantidade": 1 } ] } } ``` ### *LIST* Possibilita que você realize iterações em um *array* (lista) no JSON. Imagine essa função na criação de uma lista dinâmica de elementos na saída, que transforma o JSON em XML. **Sintaxe** ``` <#list SuaLista as elemento> bloco de informações que será iterado. ``` **Exemplo** Utilizando a entrada informada no começo do artigo, você pode criar uma lista dinâmica de itens utilizando o *template*. O que você deve informar no *template* é: ``` <#list itens as item> ${item.nome} ${item.quantidade} ``` **Saída do XML** ``` item 1 2 item 2 1 ``` {% hint style="info" %} Lembre-se que a saída do **Template** é um XML em uma *string*. {% endhint %} ### *IF/ELSE* Você pode utilizar essa função para a validação de algumas informações. Mesmo quando os seus campos estiverem nulos ou vazios, não há um grande impacto na sua transformação de dados. **Sintaxe** ``` <#if condição> Bloco de informações caso a condição do if seja verdadeira. <#elseif condição> Bloco de informações caso a condição do elseif seja verdadeira. <#else> Bloco de informações caso nenhuma das condições seja tomadas. ``` Não existe limitação para a quantidade de *elseif* e também é possível usar apenas um *if* sem o *else* - tudo depende da sua necessidade. **Exemplo** Utilizando a entrada informada no começo do artigo, você pode criar uma validação na qual o campo "código" precise ser maior que 0 (zero). O que você deve informar no *template* é: ``` <#if codigo > 0 >${codigo} ``` **Saída do XML**\ Caso a condição seja verdadeira: ``` 213 ``` Caso a condição seja falsa: ``` ``` Sabia que a utilização da função não é limitada a condições simples? Você também pode utilizar expressões para validar se o campo existe (??) e se ele tem conteúdo (has\_content). **Sintaxe** ``` <#if seuCampo?? && seuCampo?has_content> Bloco de informações caso o campo exista e tenha conteúdo. <#else> Bloco de informações caso nenhuma das condições seja tomadas. ``` {% hint style="info" %} É possível utilizar operadores lógicos para uma condição mais avançada. {% endhint %} ***&&*** - para o E (AND). ***||*** - para o OU (OR). **Exemplo** Agora veja como melhorar a validação para que o *if* feito no primeiro caso seja utilizado apenas se o campo "código" existir e tiver conteúdo. O que você deve informar no *template* é: ``` <#if codigo?? && codigo?has_content> <#if codigo gt 0 >${codigo} ``` **Saída do XML**\ Caso a condição seja verdadeira: ``` 213 ``` Caso a condição seja falsa... ... e o campo "código" tenha um valor *null*, vazio ou não venha na entrada: ``` Essa função é utilizada para remover os espaços em branco no começo e no final de uma *string*. **Sintaxe** ``` ${SeuCampo?trim} ``` **Exemplo** Utilizando a entrada informada no começo do artigo, você pode remover os espaços em branco no começo e final do campo "descrição". O que você deve informar no *template* é: ``` ${descricao?trim} ``` **Saída do XML** ``` pedido teste ``` ### *REPLACE* Essa função é utilizada para substituir um valor pré-determinado no campo. **Sintaxe** ``` ${SeuCampo?replace} ``` **Exemplo** Utilizando a entrada informada no começo do artigo, você pode substituir o valor "teste" em descrição por "prod". O que você deve informar no *template* é: ``` ${descricao?replace("teste","prod")} ``` **Saída do XML** ``` pedido prod ``` ### *SLICE (SUBSTRING)* Essa função é utilizada quando o campo é obrigado a ter um determinado tamanho. **Sintaxe** ``` ${SeuCampo[0..9]} 0 = valor inicial9 = valor final ``` **Exemplo** Utilizando a entrada informada no começo do artigo, você pode determinar que o campo tenha apenas 10 caracteres, mesmo que o tamanho dele seja maior. {% hint style="info" %} Uma boa prática aplicável à essa função é utilizar *IF/ELSE* para validar o tamanho desejado do campo. Dessa forma, você evita erros caso o campo seja menor do que o valor de corte estabelecido. {% endhint %} O que você deve informar no *template* é: ``` <#if descricao?length < 10> ${descricao} <#else> ${descricao[0..9]} ``` **Saída do XML** ``` pedido ``` ### *LOCALE* Essa função é utilizada no *template* para configurar a localização de um valor numérico. **Sintaxe** ``` <#setting locale="en_US">${SeuCampo}<#setting locale="pt_BR">${SeuCampo} ``` Para poder utilizá-lo, você precisa informar a *tag* antes do campo dinâmico. Veja como fazer isso nos exemplos abaixo. **Exemplo** Utilizando a entrada informada no começo do artigo, você pode formatar o valor para que ele fique no padrão do sistema legado. O que você deve informar no *template* é: ``` <#setting locale="en_US"> ${valor} <#setting locale="pt_BR"> ${valor} ``` **Saída do XML** ``` 4,513,423.13 4.513.423,13 ``` ### Customizado Caso a formatação desejada não seja aceita pelo seu sistema, você pode definir a formatação necessária do número por meio da *tag "*number\_format". Permite a você customizar a formatação de números. **Sintaxe** ``` <#setting number_format="0.##"> ${seuCampo} ``` {% hint style="info" %} As *hashtags* (#) definem a quantidade de casas decimais que serão utilizadas. {% endhint %} **Exemplo** Utilizando a entrada informada no começo do artigo, você pode formatar o valor para que ele fique no padrão do sistema legado. O que você deve informar no *template* é: ``` <#setting number_format="0.#"> ${valor} <#setting locale="pt_BR"> ``` **Saída do XML** ``` 4513423.1 ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/template-transformer/template-and-its-uses.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.