Skip to main content
Use este caminho quando precisar tornar o Reporter utilizável pelo Console pela primeira vez. A sequência depende do seu modelo de fonte de dados. Comece por Templates se as Fontes de Dados internas de produtos já estiverem configuradas. Se precisar de um banco de dados externo, adicione e teste a Fonte de Dados primeiro.

​
Antes de começar

Leia o mapa de conceitos do Reporter se você nunca usou o Reporter antes. Ele explica a cadeia operacional:
  • Fontes de Dados definem de onde o Reporter lê os dados.
  • Templates definem a estrutura e o formato de saída do arquivo.
  • Relatórios são os arquivos que o Reporter gera a partir de um Template. Você pode monitorá-los, visualizá-los e baixá-los.
Antes de abrir as telas de configuração, decida qual relatório você quer produzir primeiro. Por exemplo: “relatório mensal de impostos em CSV”, “relatório operacional diário em PDF” ou “arquivo XML regulatório filtrado por período”. Essa decisão indica se a Fonte de Dados necessária já existe. Também indica qual Template, formato de saída e filtros você precisa.

​
Pré-requisitos

Se um desses itens estiver ausente, resolva-o primeiro. O Reporter apenas consegue gerar arquivos úteis quando você conhece o Template, a saída pretendida e a conexão de dados relevante.

​
Escolha o caminho de configuração

Use esta decisão antes de seguir as etapas:

​
Sequência mínima de configuração

1

Confirmar o acesso e escolher o primeiro relatório

Comece pela visão geral do Reporter. Confirme que a equipe sabe qual relatório criar primeiro. Use a visão geral quando precisar explicar para que serve cada área do Reporter.Acesse Módulo Reporter e Mapa de conceitos do Reporter.
2

Confirmar o caminho da Fonte de Dados

Verifique se a Fonte de Dados necessária já existe. Fontes de Dados internas de produtos podem já estar configuradas para o ambiente. Se o relatório depender de um banco de dados externo ou de uma conexão ausente, adicione essa Fonte de Dados. Teste-a antes de criar relatórios.Na página Fontes de Dados, use as conexões existentes quando já estiverem presentes. Adicione uma nova conexão apenas quando a fonte necessária não estiver disponível. Depois execute Testar Conexão antes de usá-la em um relatório.Use Adicionar uma Fonte de Dados e Testar a conexão de uma Fonte de Dados.
3

Adicionar ou criar um Template

O Template define a estrutura do relatório e o formato de saída. Você pode enviar um arquivo .tpl existente ou criar o Template visualmente no Console.Na página Templates, use Adicionar um template. Se o operador precisar montar o layout a partir de blocos, use o Template Builder.
4

Gerar um Relatório

Na página Relatórios, crie um relatório a partir do Template. Selecione o Template, aplique filtros quando necessário, revise a configuração e gere o arquivo.Use Gerar um relatório. Este é o ponto em que um Template se torna um Relatório. Antes da geração, ele é apenas uma definição reutilizável.
5

Monitorar a conclusão e baixar o arquivo

Os relatórios gerados começam em Processing. Espere o status chegar a Finished e então visualize ou baixe o arquivo de saída.Se o relatório terminar em Error, verifique os detalhes e execute-o novamente depois de corrigir a Fonte de Dados, o Template ou os filtros. Use Baixar um relatório quando o arquivo estiver pronto.
6

Acompanhar datas de entrega recorrentes quando necessário

Se o relatório tiver um prazo recorrente, use a página Visão geral para adicionar o lembrete de entrega. Isso mantém as entregas futuras e vencidas visíveis. Isso não muda como o Reporter gera relatórios.Use o lembrete apenas para acompanhamento operacional. Ele não cria nem agenda relatórios automaticamente.

​
Quando usar a referência da API

Use o Console para a primeira configuração operacional:
  • confirmar ou criar a Fonte de Dados.
  • testar conexões quando necessário.
  • adicionar ou criar o Template.
  • gerar o primeiro Relatório.
  • baixar o arquivo.
Use a referência da API do Reporter quando precisar automatizar ou integrar o mesmo workflow, como:
  • criar ou listar Templates a partir de outro sistema.
  • criar relatórios de forma programática.
  • verificar o status do relatório sem abrir o Console.
  • baixar arquivos gerados por meio de uma integração.
  • validar ou gerenciar conexões fora do workflow do operador.
A configuração manual pelo Console não exige a referência da API. A referência da API é para trabalho de implementação, automação e resolução de problemas com equipes de engenharia.

​
O que acontece depois

Ao final do caminho de configuração, recomenda-se que você tenha:
  • uma Fonte de Dados relevante disponível para o relatório, pré-configurada internamente ou adicionada e testada manualmente.
  • um Template que corresponde ao formato de saída exigido.
  • um Relatório gerado com status Finished.
  • um arquivo baixado pronto para entrega ou validação.
  • lembretes de entrega opcionais na página Visão geral quando o relatório tiver prazos recorrentes.
Depois disso, o ciclo operacional normal é:
  • manter a Fonte de Dados relevante saudável quando o relatório depender de uma.
  • atualizar o Template quando a estrutura do arquivo mudar.
  • gerar Relatórios quando necessário.
  • baixar a saída final.

​
Erros comuns de sequenciamento

Alguns ambientes já incluem Fontes de Dados internas para produtos Lerian como Midaz ou CRM. Verifique a lista existente antes de adicionar uma conexão externa duplicada.
A conexão pode existir, mas credenciais, acesso à rede e schemas ainda precisam de validação quando o relatório depende dessa fonte. Execute Testar Conexão antes de confiar nela.
Recomenda-se que o Template corresponda ao formato de arquivo exigido. Confirme se a operação precisa de CSV, XML, HTML, TXT ou PDF antes de usá-lo para gerar relatórios.
Os operadores podem concluir a primeira configuração no Console. Use a referência da API quando você deve automatizar, integrar ou depurar o mesmo workflow com o apoio da engenharia.

Referência da API do Reporter

Use quando você deve automatizar ou integrar o workflow do Reporter por meio de APIs.