> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Adicionar um Template

> Crie um Template no Reporter usando o Template Builder ou enviando um arquivo .tpl já preparado, depois mapeie as fontes de dados dele para a geração de relatórios regulatórios.

Use esta página para criar o Template que o Reporter vai usar para gerar um Relatório. Um Template é a estrutura reutilizável do arquivo de saída: ele define o layout, os campos, as condições, os loops, os cálculos e o formato final.

## Objetivo

***

Adicione um Template que os operadores possam selecionar ao gerar Relatórios.

Por exemplo, um Template de imposto mensal pode definir um cabeçalho CSV, uma linha por transação e um valor total no final do arquivo. Um Template regulatório em XML pode definir as tags XML exigidas e preenchê-las com valores de uma Fonte de Dados.

## Quando usar

***

Use esta tarefa quando:

* você configura o primeiro Template para um relatório cuja Fonte de Dados já existe
* uma nova obrigação de relatório exige uma nova estrutura de saída
* sua equipe já tem um arquivo `.tpl` revisado e precisa disponibilizá-lo no Console
* um operador precisa montar o Template visualmente em vez de editar o código `.tpl`

Não use esta tarefa para corrigir um Template que já existe. Use [Atualizar um Template](/pt/products/reporter/console/updating-a-template) no lugar.

## Antes de começar

***

Confirme:

* a Fonte de Dados que vai alimentar o Template está disponível quando o Template precisa de campos de banco de dados. Pode ser uma fonte interna já configurada para o ambiente ou uma fonte externa adicionada em **Fontes de Dados**
* você sabe o formato de saída esperado: CSV, XML, HTML, TXT ou PDF
* o Template vai ser criado no **Template Builder** ou enviado como um arquivo `.tpl`
* o responsável pelo relatório confirmou os campos que devem aparecer na saída

<Note>
  Um Template é a definição reutilizável que o Reporter aplica depois, durante a geração do relatório. Ele não é o Relatório gerado em si.
</Note>

## Opção 1: Montar no Template Builder

***

Use o Template Builder quando um operador precisar montar o Template visualmente a partir de blocos.

<Steps>
  <Step title="Abrir o Template Builder">
    Acesse a página **Templates** e clique em **Template Builder**.
  </Step>

  <Step title="Nomear o Template">
    Use um nome que os operadores possam reconhecer depois, como `Monthly tax CSV` ou `Daily transaction PDF`.
  </Step>

  <Step title="Escolher o formato de saída">
    Selecione o formato que o Relatório gerado deve produzir: XML, HTML, CSV, TXT ou PDF.
  </Step>

  <Step title="Adicionar os blocos do Template">
    Adicione blocos como **Texto**, **Variável**, **Loop**, **Condicional** ou **Agregação**. Na prática, os blocos representam as partes do arquivo final: texto fixo, valores do banco de dados, linhas repetidas, seções condicionais ou totais.
  </Step>

  <Step title="Conectar campos aos dados">
    Use a barra lateral de Fontes de Dados para selecionar campos da conexão de banco de dados configurada. Por exemplo, use um bloco **Variável** para colocar `transactions.amount` na saída.
  </Step>

  <Step title="Salvar o Template">
    Clique em **Salvar** para validar os blocos e salvar o arquivo `.tpl` gerado.
  </Step>
</Steps>

## Opção 2: Enviar um arquivo `.tpl`

***

Use o envio quando uma equipe técnica já mantém o Template fora do Console.

<Steps>
  <Step title="Abrir o assistente de envio">
    Acesse a página **Templates** e clique em **Novo Template**.
  </Step>

  <Step title="Enviar o arquivo">
    Na etapa **Arquivo**, arraste o arquivo `.tpl` para **Arraste o arquivo aqui**, ou clique em **selecionar** para procurar no seu computador.
  </Step>

  <Step title="Configurar o Template">
    Na etapa **Configuração**, preencha **Nome do Template** e **Formato de Saída**.
  </Step>

  <Step title="Revisar o resumo">
    Na etapa **Revisão**, confirme o arquivo, o nome e o formato de saída. Use os botões de edição se algum campo estiver errado.
  </Step>

  <Step title="Salvar o Template">
    Clique em **Salvar Template**.
  </Step>
</Steps>

<Tip>
  **Equivalente na API**: [Endpoint de envio de template](/pt/reference/products/reporter/upload-template)
</Tip>

## Guia de campos

***

### Campos do assistente de envio

| Campo                          | O que inserir                                                                                                                     | Exemplo           |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| **Arquivo do Template (.tpl)** | Arquivo `.tpl` obrigatório usado como origem do Template. Deve ser maior que 0 bytes e no máximo 1 MiB. Campo da API: `template`. | `monthly-tax.tpl` |
| **Nome do Template**           | Nome obrigatório voltado ao operador. Ele é mapeado para `name` no Console e para `description` na API do Reporter.               | `Monthly tax CSV` |
| **Formato de Saída**           | Tipo de saída obrigatório. Use um entre `csv`, `xml`, `html`, `txt` ou `pdf`.                                                     | `csv`             |

### Campos do Template Builder

| Campo                            | O que inserir                                                                                                                            | Exemplo                                                                  |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Nome do Template**             | Nome obrigatório no cabeçalho do builder. Ele se torna o nome salvo do Template e o prefixo do nome do arquivo `.tpl` gerado.            | `Daily transaction PDF`                                                  |
| Barra de blocos                  | Adicione pelo menos um bloco antes de salvar. Os blocos se tornam o código `.tpl` gerado.                                                | cabeçalho **Texto** + **Loop** sobre transações + total de **Agregação** |
| Barra lateral de Fontes de Dados | Use Fontes de Dados configuradas para inserir campos em blocos **Variável**. Os campos técnicos incluem `dataSource`, `table` e `field`. | `production-postgres.transactions.amount`                                |

## Resultado esperado

***

Depois de salvar, o Template aparece na página **Templates** e pode ser selecionado no assistente **Gerar Relatório**.

## Erros comuns e pontos de atenção

***

<AccordionGroup>
  <Accordion title="Enviar um arquivo que não é `.tpl`">
    O envio aceita apenas arquivos `.tpl`. Se o Template não estiver finalizado, use primeiro o **Template Builder** ou prepare o arquivo `.tpl` fora do Console.
  </Accordion>

  <Accordion title="Escolher o formato de saída errado">
    O formato de saída controla que tipo de arquivo os operadores vão baixar depois de gerar um Relatório. Confirme o formato exigido antes de salvar.
  </Accordion>

  <Accordion title="Criar um Template antes que a Fonte de Dados esteja pronta">
    Templates podem referenciar campos de Fontes de Dados. Os operadores podem não saber quais campos são seguros para usar quando a fonte necessária está ausente ou não tem resultado de teste.
  </Accordion>
</AccordionGroup>

## Próximos passos

***

* Use [Gerar um Relatório](/pt/products/reporter/console/generating-a-report) para criar um Relatório a partir do Template.
* Use [Atualizar um Template](/pt/products/reporter/console/updating-a-template) se a estrutura, o arquivo, o nome ou o formato de saída precisar de correção.
* Use o [Template Builder](/pt/products/reporter/console/template-builder) quando os operadores precisarem manter o Template visualmente.
