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

​
Objetivo

Adicionar um Template que os operadores possam selecionar ao gerar Relatórios. Por exemplo, um Template fiscal mensal pode definir um cabeçalho CSV, uma linha por transação e um valor total no fim do arquivo. Um Template XML regulatório pode definir as tags XML necessárias e preenchê-las com valores de um Data Source.

​
Quando usar

Use esta tarefa quando:
  • você está configurando o primeiro Template para um relatório cujo Data Source já existe;
  • uma nova obrigação de relatório exige uma nova estrutura de saída;
  • seu time já tem um arquivo .tpl revisado e precisa disponibilizá-lo no Console;
  • um operador precisa construir o Template visualmente em vez de editar código .tpl.
Não use esta tarefa para corrigir um Template que já existe. Use Atualizar um Template em vez disso.

​
Antes de começar

Confirme:
  • o Data Source que vai alimentar o Template está disponível quando o Template precisa de campos de banco. Pode ser uma fonte interna já configurada para o ambiente ou uma externa adicionada a partir de Data Sources;
  • o formato de saída esperado é conhecido: CSV, XML, HTML, TXT ou PDF;
  • o Template será criado no Template Builder ou enviado como arquivo .tpl;
  • o responsável pelo relatório confirmou os campos que devem aparecer na saída.
Um Template não é um Relatório gerado. É a definição reutilizável que o Reporter aplica depois durante a geração.

​
Opção 1: Construir no Template Builder

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

Abra o Template Builder

Vá para a página Templates e clique em Template Builder.
2

Dê nome ao Template

Use um nome que os operadores possam reconhecer depois, como Monthly tax CSV ou Daily transaction PDF.
3

Escolha o formato de saída

Selecione o formato que o Relatório gerado deve produzir: XML, HTML, CSV, TXT ou PDF.
4

Adicione os blocos do Template

Adicione blocos como Texto, Variável, Loop, Condicional ou Agregação. Na prática, os blocos representam as peças do arquivo final: texto fixo, valores de banco, linhas repetidas, seções condicionais ou totais.
5

Conecte campos aos dados

Use a sidebar de Data Sources para selecionar campos da conexão configurada. Por exemplo, use um bloco Variável para colocar transactions.amount na saída.
6

Salve o Template

Clique em Salvar para validar os blocos e salvar o arquivo .tpl gerado.

​
Opção 2: Enviar um arquivo .tpl

Use o envio quando um time técnico já mantém o Template fora do Console.
1

Abra o wizard de envio

Vá para a página Templates e clique em Novo Template.
2

Envie o arquivo

No passo Arquivo, arraste o arquivo .tpl para Arraste o arquivo aqui, ou clique em para selecionar para procurar no seu computador.
3

Configure o Template

No passo Config, preencha Nome do Template e Formato de Saída.
4

Revise o resumo

No passo 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.
5

Salve o Template

Clique em Salvar Template.
API equivalente: Endpoint Upload template

​
Guia de campos

​
Campos do wizard de envio

​
Campos do Template Builder

​
Resultado esperado

Após salvar, o Template aparece na página Templates e pode ser selecionado no wizard Gerar Relatório.

​
Erros comuns e pontos de atenção

O envio aceita apenas arquivos .tpl. Se o Template ainda está em desenho, use primeiro o Template Builder ou prepare o arquivo .tpl fora do Console.
O formato de saída controla que tipo de arquivo os operadores vão baixar após gerar um Relatório. Confirme o formato exigido antes de salvar.
Templates podem referenciar campos de Data Sources. Se a fonte necessária está faltando ou não foi testada, os operadores podem não saber quais campos são seguros usar.

​
Próximos passos