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

​
Objetivo

Monte um Template a partir de blocos visuais e salve-o para geração de Report futura. Por exemplo, um Template de transação mensal pode usar texto fixo para o cabeçalho e um Loop para cada linha de transação. Também pode usar blocos Variable para campos como valor e data, e um bloco Aggregation para o total.

​
Quando usar

Use o Template Builder quando:
  • operadores precisam criar um Template sem editar código .tpl.
  • um Template do Template Builder precisa de manutenção visual.
  • a estrutura do relatório depende de campos, loops, condições ou totais de uma Data Source.
  • a equipe quer baixar o arquivo .tpl gerado depois de montá-lo.
Use o upload de .tpl quando uma equipe técnica já criou e revisou o Template fora do Console.

​
Antes de começar

Confirme:
  • que existe pelo menos uma Data Source relevante, caso o Template precise de campos do banco de dados. Pode ser uma fonte interna já configurada no ambiente ou uma fonte externa adicionada em Data Sources.
  • que você testou a Data Source quando a saúde da conexão ou a visibilidade do schema forem incertas. As tabelas e campos dela ficam então disponíveis na barra lateral.
  • que você conhece o formato de saída esperado: XML, HTML, CSV, TXT ou PDF.
  • que o operador conhece a estrutura do relatório, como cabeçalho obrigatório, linhas, totais ou seções condicionais.
Os blocos definem a estrutura da saída. Os filtros aplicados durante a geração do Report definem quais registros entram nessa estrutura.

​
Passo a passo

1

Abra o builder

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

Nomeie o Template

Edite o nome do Template no cabeçalho. Use um nome que os operadores consigam identificar durante a geração do relatório.
3

Escolha o formato de saída

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

Adicione blocos ao canvas

Use a barra de ferramentas de blocos para adicionar estrutura. Os blocos comuns são Text, Variable, Loop, Conditional e Aggregation.
5

Conecte campos das Data Sources

Use a barra lateral de Data Sources para navegar por schemas, tabelas e campos. Clique em um campo para adicionar um bloco Variable para esse campo.
6

Revise o código gerado quando necessário

Alterne de Visual para Code para inspecionar o preview do .tpl gerado. A visualização de código serve para revisão e cópia/download, não para edição manual.
7

Salve o Template

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

​
Guia de campos

​
Campos e controles em nível de builder

​
Guia de campos por bloco

​
Tipos de bloco

​
Trabalhando com blocos

  • Clique em um tipo de bloco na barra de ferramentas para adicioná-lo ao canvas.
  • Arraste blocos para reordenar a saída.
  • Configure cada bloco inline. Por exemplo, uma Variable precisa de uma origem e um campo, enquanto uma Conditional precisa de uma condição.
  • Use Inline quando o bloco deve ser renderizado sem quebra de linha depois dele.
  • Use Trim whitespace para remover espaços extras ao redor da saída do bloco.
  • Use Duplicate para copiar um bloco configurado.
  • Use Delete para remover um bloco do Template.
Blocos container como Loop, Conditional, Section e With podem conter blocos filhos. Use-os quando a saída precisar de conteúdo repetido ou agrupado.

​
Resultado esperado

Depois de salvar, o Template aparece na página Templates. Você pode selecioná-lo no assistente Generate Report. Você também pode baixar o arquivo .tpl gerado a partir do builder.

​
Erros comuns e pontos de atenção

A barra lateral mostra apenas Data Sources configuradas. Se a fonte interna esperada não aparecer, confirme a configuração com o administrador do Reporter. Se o relatório precisar de um banco de dados externo, adicione e teste essa Data Source antes de usar campos do banco de dados no Template.
O builder valida os blocos durante o salvamento. Se um bloco não tiver origem, campo, condição ou expressão, corrija esse bloco antes de salvar.
Os blocos do Template definem a estrutura do arquivo. Você seleciona os filtros do relatório depois, durante a geração do relatório. Eles decidem quais registros entram na saída.
A saída em PDF vem de HTML. Monte o Template com conteúdo compatível com HTML quando o formato de saída final for PDF.

​
Próximos passos

Equivalente na API

Não existe um endpoint de API separado para o builder visual. Use Upload template endpoint com um arquivo .tpl já pronto.