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 fluxo de produção recorrente, consulte Usar o Reporter. Para consultar os schemas completos de requisições e respostas, use o Início rápido da API do Reporter e as páginas de referência da API vinculadas.

Objetivo

Você vai:

Criar um template .tpl mínimo.
Fazer upload dele como um template HTML.
Gerar um relatório sem filtros de dados.
Acompanhar o relatório até o processamento terminar.
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

Configure os valores usados nos exemplos:

export REPORTER_URL="https://reporter.example.com"
export TOKEN="seu-token-de-acesso"

Criar um template mínimo

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

<!doctype html>
<html>
  <body>
    <h1>Meu primeiro resultado do Reporter</h1>
  </body>
</html>

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

Fazer upload do template

Faça upload do 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=Primeiro resultado do Reporter"

Salve o id do template retornado como TEMPLATE_ID:

export TEMPLATE_ID="id-da-template-retornado"

Consulte Fazer upload de template para conhecer o contrato completo da operação.

Gerar 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="id-do-relatorio-retornado"

Consulte Criar relatório para conhecer a sintaxe dos filtros e o contrato completo da operação.

Acompanhar o processamento

Consulte o relatório até que ele saia de 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 o arquivo.	Consulte novamente mais tarde.
`Finished`	A geração terminou com sucesso.	Baixe o relatório.
`Partial`	A geração terminou com resultados incompletos.	Verifique os detalhes do relatório e os logs da aplicação.
`Error`	A geração falhou.	Verifique o erro e os logs da aplicação antes de tentar novamente.

Consulte Verificar status do relatório para conhecer o schema da resposta.

Baixar e verificar o resultado

Baixe o arquivo somente 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 "Meu primeiro resultado do Reporter" first-report.html

Consulte Baixar relatório para conhecer os headers da resposta e os detalhes de erros.

Solução de problemas

Problema	O que verificar
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 for aplicável.
O relatório permanece em `Processing`	Verifique a saúde do worker e da fila do Reporter e, depois, os logs da aplicação.
O relatório termina em `Partial` ou `Error`	Verifique 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 está com status `Finished`.

Próximos passos

Siga Usar o Reporter para projetar um fluxo reutilizável e recorrente.
Aprenda a referenciar dados configurados em Formatos de templates.
Consulte a orientação especializada em Templates BACEN antes de trabalhar com estruturas de relatórios regulatórios.
Use o Início rápido da API do Reporter para consultar exemplos completos da API.

Visão geral

Guias

Console

Início rápido do Reporter

Objetivo

Pré-requisitos

Criar um template mínimo

Fazer upload do template

Gerar o relatório

Acompanhar o processamento

Baixar e verificar o resultado

Solução de problemas

Próximos passos

​Objetivo

​Pré-requisitos

​Criar um template mínimo

​Fazer upload do template

​Gerar o relatório

​Acompanhar o processamento

​Baixar e verificar o resultado

​Solução de problemas

​Próximos passos

Objetivo

Pré-requisitos

Criar um template mínimo

Fazer upload do template

Gerar o relatório

Acompanhar o processamento

Baixar e verificar o resultado

Solução de problemas

Próximos passos