Skip to main content
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 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
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.

​
Opção 1: Montar no Template Builder

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

Abrir o Template Builder

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

Nomear o Template

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

Escolher o formato de saída

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

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

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.
6

Salvar 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 uma equipe técnica já mantém o Template fora do Console.
1

Abrir o assistente de envio

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

Enviar o arquivo

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

Configurar o Template

Na etapa Configuração, preencha Nome do Template e Formato de Saída.
4

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

Salvar o Template

Clique em Salvar Template.
Equivalente na API: Endpoint de envio de template

​
Guia de campos

​
Campos do assistente de envio

​
Campos do Template Builder

​
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

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

​
Próximos passos