Início rápido do Reporter

Use este início rápido para gerar um relatório e confirmar que sua instalação do Reporter funciona de ponta a ponta. Para um workflow recorrente em produção, veja Usando o Reporter. Para schemas completos de requisição e resposta, use o Início rápido da API do Reporter e as páginas de referência de API vinculadas.

Objetivo

Você vai:

Criar um template .tpl mínimo.
Enviar esse template como um template HTML.
Gerar um relatório sem filtros de dados.
Acompanhar o relatório até o fim do processamento.
Baixar e verificar o arquivo finalizado.

Pré-requisitos

Você precisa de:

Uma instância do Reporter em execução
Um token de autenticação, se o Access Manager estiver habilitado
curl

Defina os valores usados nos exemplos:

export REPORTER_URL="https://reporter.example.com"
export TOKEN="your-access-token"

Crie um template mínimo

Crie first-report.tpl com conteúdo HTML estático:

<!doctype html>
<html>
  <body>
    <h1>My first Reporter output</h1>
  </body>
</html>

Templates do Reporter sempre usam a extensão .tpl. O conteúdo do template deve corresponder ao formato de saída selecionado. O Reporter aceita saídas em HTML, CSV, XML, PDF e TXT. Para saída em PDF, escreva o template em HTML e defina outputFormat=PDF. Para templates que leem dados, veja Formatos de template.

Envie o template

Envie o arquivo com os três campos multipart obrigatórios: template, outputFormat e description.

curl --fail-with-body -X POST "$REPORTER_URL/v1/templates" \
  -H "Authorization: Bearer $TOKEN" \
  -F "template=@first-report.tpl" \
  -F "outputFormat=HTML" \
  -F "description=First Reporter output"

Salve o id do template retornado como TEMPLATE_ID:

export TEMPLATE_ID="returned-template-id"

Veja Upload template para o contrato completo da operação.

Gere o relatório

Crie um relatório com os campos obrigatórios templateId e filters. Use um objeto vazio quando não precisar de filtros.

curl --fail-with-body -X POST "$REPORTER_URL/v1/reports" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"templateId\":\"$TEMPLATE_ID\",\"filters\":{}}"

Salve o id do relatório retornado como REPORT_ID:

export REPORT_ID="returned-report-id"

Veja Create report para a sintaxe dos filtros e o contrato completo da operação.

Acompanhe o processamento

Verifique o relatório até que ele saia do status Processing:

curl --fail-with-body \
  -H "Authorization: Bearer $TOKEN" \
  "$REPORTER_URL/v1/reports/$REPORT_ID"

O ciclo de vida ativo é:

Processing -> Finished | Partial | Error

Status	Significado	O que fazer
`Processing`	O Reporter está gerando a saída.	Verifique novamente mais tarde.
`Finished`	A geração foi concluída com sucesso.	Baixe o relatório.
`Partial`	A geração foi concluída com resultados incompletos.	Inspecione os detalhes do relatório e os logs da aplicação.
`Error`	A geração falhou.	Inspecione o erro e os logs da aplicação antes de tentar novamente.

Veja Check report status para o schema da resposta.

Baixe e verifique a saída

Baixe o arquivo apenas quando o status do relatório for Finished:

curl --fail-with-body \
  -H "Authorization: Bearer $TOKEN" \
  "$REPORTER_URL/v1/reports/$REPORT_ID/download" \
  -o first-report.html

Confirme que o arquivo não está vazio e contém o título esperado:

test -s first-report.html
grep -F "My first Reporter output" first-report.html

Veja Download report para os cabeçalhos de resposta e detalhes de erro.

Solução de problemas

Problema	Verificação
O upload do template é rejeitado	Inclua o arquivo `.tpl`, `outputFormat` e `description`; confirme que o conteúdo do arquivo corresponde ao formato.
A criação do relatório é rejeitada	Envie `templateId` e `filters`; use `{}` quando nenhum filtro se aplicar.
O relatório permanece em `Processing`	Verifique a saúde do worker e da fila do Reporter, depois inspecione os logs da aplicação.
O relatório termina em `Partial` ou `Error`	Inspecione os detalhes do relatório, as fontes de dados referenciadas e os logs da aplicação antes de tentar novamente.
O download é rejeitado	Confirme que o relatório existe e tem status `Finished`.

Próximos passos

Siga Usando o Reporter para projetar um workflow reutilizável e recorrente.
Aprenda a referenciar dados configurados em Formatos de template.
Revise as orientações especializadas em Formatos regulatórios do BACEN antes de trabalhar com estruturas de relatórios regulatórios.
Use o Início rápido da API do Reporter para exemplos completos da API.

Visão geral

Conceitos

Guias

Integração

Console

Operações

Início rápido do Reporter

Objetivo

Pré-requisitos

Crie um template mínimo

Envie o template

Gere o relatório

Acompanhe o processamento

Baixe e verifique a saída

Solução de problemas

Próximos passos

​Objetivo

​Pré-requisitos

​Crie um template mínimo

​Envie o template

​Gere o relatório

​Acompanhe o processamento

​Baixe e verifique a saída

​Solução de problemas

​Próximos passos

Objetivo

Pré-requisitos

Crie um template mínimo

Envie o template

Gere o relatório

Acompanhe o processamento

Baixe e verifique a saída

Solução de problemas

Próximos passos