Skip to main content
Use o Template Builder para criar ou manter um Template visualmente. O builder converte blocos em código .tpl, então os operadores podem definir a estrutura do relatório sem escrever o arquivo do Template manualmente.

​
Objetivo

Construir um Template a partir de blocos visuais e salvá-lo para futuras gerações de Relatório. Por exemplo, um Template de transações mensais pode usar texto fixo no cabeçalho, um Loop para cada linha de transação, blocos Variável para campos como valor e data, e um bloco Agregação para o total.

​
Quando usar

Use o Template Builder quando:
  • os operadores precisam criar um Template sem editar código .tpl;
  • um Template do Template Builder precisa ser mantido visualmente;
  • a estrutura do relatório depende de campos, loops, condições ou totais de um Data Source;
  • o time quer baixar o arquivo .tpl gerado depois de construí-lo.
Use o envio de .tpl em vez disso quando um time técnico já criou e revisou o Template fora do Console.

​
Antes de começar

Confirme:
  • existe pelo menos um Data Source relevante se 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 Data Source foi testado quando a saúde da conexão ou a visibilidade do schema são incertas, para que as tabelas e campos fiquem disponíveis na sidebar;
  • o formato de saída esperado é conhecido: XML, HTML, CSV, TXT ou PDF;
  • o operador conhece a estrutura do relatório, como cabeçalho exigido, linhas, totais ou seções condicionais.
Os blocos definem a estrutura da saída. Os filtros aplicados durante a geração do Relatório definem quais registros entram nessa estrutura.

​
Passo a passo

1

Abra o builder

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

Dê nome ao Template

Edite o nome do Template no cabeçalho. Use um nome que os operadores possam identificar ao gerar o relatório.
3

Escolha o formato de saída

Selecione XML, HTML, CSV, TXT ou PDF.
Quando PDF é selecionado, o código do template gerado usa o formato HTML e é convertido para PDF durante a geração do relatório.
4

Adicione blocos ao canvas

Use a barra de blocos para adicionar estrutura. Blocos comuns são Texto, Variável, Loop, Condicional e Agregação.
5

Conecte campos a partir de Data Sources

Use a sidebar de Data Sources para navegar por schemas, tabelas e campos. Clique em um campo para adicionar um bloco Variável para esse campo.
6

Revise o código gerado quando necessário

Mude de Visual para Código para inspecionar a pré-visualização .tpl gerada. A visão de código é para revisão e cópia/download, não para edição manual.
7

Salve o Template

Clique em Salvar. O builder valida os campos obrigatórios dos blocos, gera o código .tpl e salva o Template.

​
Guia de campos

​
Campos e controles a nível de builder

​
Guia de campos por bloco

​
Tipos de bloco

​
Trabalhando com blocos

  • Clique em um tipo de bloco na barra para adicioná-lo ao canvas.
  • Arraste blocos para reordenar a saída.
  • Configure cada bloco inline. Por exemplo, um Variável precisa de fonte e campo, enquanto um Condicional precisa de uma condição.
  • Use Inline quando o bloco deve renderizar sem uma quebra de linha depois.
  • Use Remover espaços em branco para remover espaços extras ao redor da saída do bloco.
  • Use Duplicar para copiar um bloco configurado.
  • Use Excluir para remover um bloco do Template.
Blocos contêineres como Loop, Condicional, Seção e With podem conter blocos filhos. Use-os quando a saída precisar de conteúdo repetido ou agrupado.

​
Resultado esperado

Após salvar, o Template aparece na página Templates e pode ser selecionado no wizard Gerar Relatório. Você também pode baixar o arquivo .tpl gerado a partir do builder.

​
Erros comuns e pontos de atenção

A sidebar mostra apenas Data Sources configurados. Se a fonte interna esperada não está listada, confirme a configuração com o administrador do Reporter. Se o relatório precisa de um banco externo, adicione e teste esse Data Source antes de usar campos de banco no Template.
O builder valida os blocos ao salvar. Se um bloco está sem fonte, campo, condição ou expressão, corrija esse bloco antes de salvar.
Os blocos do Template definem a estrutura do arquivo. Os filtros de Relatório são selecionados depois durante a geração e decidem quais registros entram na saída.
A saída PDF é gerada a partir de HTML. Construa o Template como conteúdo compatível com HTML quando o formato final for PDF.

​
Próximos passos

API equivalente

Não há um endpoint de API separado para o builder visual. Use o Endpoint Upload template com um arquivo .tpl preparado.