> 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.md).

# Template Transformer

Descubra mais sobre o componente Template Transformer e saiba como utilizá-lo na Digibee Integration Platform.

O **Template Transformer** gera XML, HTML, texto e outros dados a partir de um *template* especificado. O componente pode receber dados para preencher o *template* dinamicamente a partir de um JSON recebido na sua mensagem de entrada. Descubra mais sobre [aplicações práticas do Template Transformer.](/documentation/connectors-and-triggers/pt-br/connectors/tools/template-transformer/template-and-its-uses.md)

## Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por [expressões *Double Braces*](/documentation/connectors-and-triggers/pt-br/double-braces/overview.md) estão marcados com `(DB)`.

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Model Path</strong></td><td>Caminho no qual o <em>input</em> de JSON encontra os modelos a serem utilizados no <em>template</em> (<em>dotted notation</em>).</td><td>body</td><td><em>String</em></td></tr><tr><td><strong>Preserve Original</strong></td><td>Se ativada, a opção preserva os campos originais recebidos na entrada do componente.</td><td><em>True</em></td><td>Booleano</td></tr><tr><td><strong>Body</strong></td><td>O <em>template</em> (<em>string</em>) a ser substituído e transformado durante o tempo de execução com os dados recebidos, via JSON, configurados na propriedade <em>Model Path</em>.</td><td>N/A</td><td><em>String</em></td></tr></tbody></table>

## Fluxo de mensagens <a href="#fluxo-de-mensagens" id="fluxo-de-mensagens"></a>

Para entender melhor como utilizar o **Template Transformer**, [clique aqui para ler o nosso artigo com exemplos ilustrados.](/documentation/connectors-and-triggers/pt-br/connectors/tools/template-transformer/template-and-its-uses.md)

### Exemplo de resposta de requisição ao Template Transformer contendo erro <a href="#exemplo-de-resposta-de-requisio-ao-template-transformer-contendo-erro" id="exemplo-de-resposta-de-requisio-ao-template-transformer-contendo-erro"></a>

```
{  
    "body": null,  
    "_error": "Can not construct instance of java.util.LinkedHashMap: no String-argument constructor/factory method to deserialize from String value ('')\n at [Source: N/A; line: -1, column: -1]",  
    "_body": ""
}
```

* **body:** *template* transformado.
* **\_error:** descrição do erro que ocorreu na execução.
* **\_body:** se a opção **Preserve Original** estiver habilitada, a propriedade será exibida na saída contendo o JSON de entrada.

### Entrada <a href="#entrada" id="entrada"></a>

Esse componente aceita receber um objeto JSON na sua entrada, utilizando uma linguagem chamada *Freemarker* para fazer as transformações e gerar o *template*. Ele vai buscar o JSON a ser utilizado dentro da propriedade de configuração **Model Path**.

### Saída <a href="#sada" id="sada"></a>

A estrutura será equivalente à de entrada, porém com outro modelo e outra representação de *template* como *string*. Em caso de erro, a propriedade *error* será criada no mesmo nível da propriedade original.

A notação com pontos (*dotted notation*) de JSON vai procurar pelo elemento raiz que está sendo processado pelo *pipeline* e realizar um cruzamento de acordo com as especificações passados na propriedade **Model Path**.

## Template Transformer em ação <a href="#template-transformer-em-ao" id="template-transformer-em-ao"></a>

Em uma representação do **Model Path** contendo a.b.c.d, "a" será procurado no elemento raiz. Em seguida será o "b", depois o "c" e finalmente o "d". Se um *array* for encontrado durante o cruzamento, então o algoritmo vai gerar um caminho de cruzamento para cada elemento no *array*. O algoritmo substitui todas as ocorrências do caminho definido em **Model Path**.

### **Sem erro**

```
{ 
    "body": "TEMPLATE TRANSFORMADO"
    "_body": {}
}
```

* **\_body:** se a opção **Preserve Original** estiver habilitada, a propriedade será exibida na saída contendo o JSON de entrada

### **Com erro**

```
{  
    "body": null,  
    "_error": "Can not construct instance of java.util.LinkedHashMap: no String-argument constructor/factory method to deserialize from String value ('')\n at [Source: N/A; line: -1, column: -1]",  
    "_body": ""
}
```

## Tecnologia <a href="#tecnologia" id="tecnologia"></a>

Utilizamos o *Freemarker* para realizar nossas conversões e transformações no *template* dentro desse componente. [Para conhecer mais sobre o Freemaker e como utilizá-lo, clique aqui.](https://freemarker.apache.org/docs/dgui_template_exp.html)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/template-transformer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
