Objetivo
Criar um Relatório gerado para uma necessidade operacional específica, período, entidade, status ou envio. Por exemplo, gere um CSV mensal de transações de maio, um arquivo XML para envio regulatório ou um resumo PDF filtrado por um segmento de clientes.
Quando usar
Use esta tarefa quando:
- o Template está pronto;
- o Data Source usado pelo Template está disponível. Pode ser uma fonte interna já configurada para o ambiente ou uma externa adicionada a partir de Data Sources;
- um operador precisa produzir um arquivo de Relatório;
- o Relatório precisa de filtros opcionais, como intervalo de datas, status, tipo ou entidade.
Antes de começar
Confirme:
- o Template selecionado é o correto para a obrigação;
- o formato de saída do Template corresponde ao arquivo que você precisa entregar;
- o Data Source usado pelo Template está disponível e testado quando o relatório depende de uma conexão que pode ter mudado;
- você sabe se o Relatório deve incluir todos os dados ou um subconjunto filtrado;
- os valores dos filtros são suficientemente precisos para o período de reporting.
Relatórios são gerados de forma assíncrona. Um novo Relatório começa em
Processing e só fica disponível para download quando chega a Finished.Passo a passo
Selecione o Template
No passo Template, escolha o Template que define a estrutura e o formato de saída. Clique em Próximo.
Adicione filtros quando necessário
No passo Filtros, adicione um ou mais filtros para delimitar os dados. Este passo é opcional. Se o Relatório deve incluir todos os dados disponíveis, clique em Próximo.
Gere o Relatório
Clique em Gerar Relatório. O wizard mostra o progresso da geração e fecha após a requisição ser enviada.
Guia de campos
| Campo | O que informar | Exemplo |
|---|---|---|
| Template | Template obrigatório selecionado no passo Template. O valor técnico enviado à API é templateId. | Monthly tax CSV |
| Buscar templates | Busca opcional na UI. Filtra a lista carregada de Templates por nome ou nome de arquivo e não é enviada no payload da geração. | tax |
| Banco de Dados | Obrigatório apenas quando uma linha de filtro é usada. Selecione a conexão do Data Source; o payload usa este valor como database. | production-postgres |
| Tabela | Obrigatório apenas quando uma linha de filtro é usada. Selecione uma tabela do schema da conexão. | transactions |
| Campo | Obrigatório apenas quando uma linha de filtro é usada. Selecione o campo a comparar. | created_at |
| Operador | Obrigatório apenas quando uma linha de filtro é usada. Use eq, gt, gte, lt, lte, between, in ou nin. | Entre / between |
| Valores | Obrigatório apenas quando uma linha de filtro é usada. between exige exatamente dois valores; in e nin aceitam valores separados por vírgula; os demais operadores usam um valor. | 2026-05-01, 2026-05-31 |
Exemplos de filtros
| Filtro | Resultado |
|---|---|
status Igual active | Inclui apenas registros ativos. |
created_at Entre 2026-05-01, 2026-05-31 | Inclui registros de maio de 2026. |
type Em credit,debit | Inclui qualquer um dos dois tipos de transação. |
amount Maior Que 1000 | Inclui registros com valor acima de 1000. |
Status e próxima ação
| Status | O que significa | Ação do operador |
|---|---|---|
Processing | O Reporter está gerando o arquivo. | Espere. A lista atualiza automaticamente. |
Finished | O arquivo está pronto. | Visualize, pré-visualize ou baixe o Relatório. |
Error | O Reporter encontrou um erro durante a geração. | Revise a mensagem e gere novamente após a correção. |
PendingExtraction | O Reporter está esperando a extração de dados antes do processamento final. | Espere ou revise a saúde do Data Source se não avançar. |
Resultado esperado
Um novo Relatório aparece na página Relatórios. Quando chega a
Finished, os operadores podem pré-visualizar ou baixar o arquivo gerado.
Erros comuns e pontos de atenção
Gerar com o Template errado
Gerar com o Template errado
O Template controla o layout e o formato de saída. Se o Template errado for selecionado, gere um novo Relatório com o Template correto.
Usar um Data Source que não foi testado
Usar um Data Source que não foi testado
Conexões com falha ou desatualizadas podem causar erros de geração. Teste o Data Source antes de gerar Relatórios operacionais quando a saúde da conexão for incerta, especialmente para bancos externos ou credenciais recém-alteradas.
Usar filtros amplos por engano
Usar filtros amplos por engano
Filtros vazios podem incluir todos os dados disponíveis. Confirme se o Relatório deve cobrir todos os registros ou apenas um período, status ou entidade específicos.
Esperar download imediato
Esperar download imediato
O download só fica disponível após o Relatório chegar a
Finished.Próximos passos
- Use Baixar um Relatório quando o status for
Finished. - Use Corrigir um Relatório se o arquivo gerado tiver dados, layout ou formato errados.
- Use Testar uma conexão de Data Source se a geração falha por problemas de conexão ou schema.
Criar relatório
Gere Relatórios de forma programática.
Verificar status do relatório
Consulte o status da geração antes do download.