> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# O que é o módulo Reporter?

> Configure Data Sources, construa Templates, gere Relatórios e baixe a saída por uma interface visual no Lerian Console.

**Reporter** é um módulo dentro do [Lerian Console](/pt/lerian-console/about-lerian-console) para operar a geração de relatórios a partir dos dados já disponíveis no seu ambiente.

Use-o para definir a estrutura da saída, gerar um Relatório, revisar o status e baixar o arquivo final. Quando o relatório precisa de um banco de dados externo ou uma conexão precisa ser validada, use **Data Sources** para gerenciar essa conexão. Casos de uso típicos incluem envios regulatórios, extratos de auditoria interna, relatórios operacionais recorrentes e relatórios pontuais para um período específico.

O Reporter não muda como a geração de relatórios se comporta no produto. Esta página apenas explica como operar o Módulo Reporter a partir do Console.

<Warning>
  O Reporter está disponível apenas se você adquiriu o produto Reporter. Quer acesso? [Entre em contato com nossa equipe](https://lerian.studio/contact) para saber mais.
</Warning>

## Quem usa esta página

***

Esta página é para operadores que precisam produzir ou gerenciar Relatórios no Console. Normalmente são times de operações, compliance, financeiro, regulatório ou suporte responsáveis por transformar os dados armazenados em um arquivo que pode ser revisado, enviado ou arquivado.

Times de desenvolvimento e integração também podem usar o Reporter, mas a referência principal deles é a [referência da API do Reporter](/pt/reference/reporter/reporter-developer-quick-start). A documentação do Console explica o fluxo visual. A referência da API explica o acesso programático.

## Comece por aqui

***

Se é a sua primeira vez usando o Reporter, comece entendendo qual caminho de configuração se aplica. Alguns ambientes já incluem Data Sources internos para produtos Lerian, como Midaz ou CRM. Nesse caso, o operador costuma começar por **Templates** e **Relatórios**. Use **Data Sources** primeiro quando precisar adicionar um banco de dados externo ou validar uma conexão existente.

<CardGroup cols={2}>
  <Card title="Setup Path" icon="clipboard-list-check" href="/pt/lerian-console/reporter-console/reporter-setup-path">
    Escolha o caminho certo: use os Data Sources internos existentes, ou adicione e teste um Data Source externo antes de gerar Relatórios.
  </Card>

  <Card title="Concepts Map" icon="network-wired" href="/pt/lerian-console/reporter-console/reporter-concepts-map">
    Entenda como Data Sources, Templates, Relatórios, previews e downloads se relacionam.
  </Card>
</CardGroup>

## O que você pode operar

***

A partir do Módulo Reporter, você pode:

* **Gerenciar Data Sources** — Revise, teste ou cadastre conexões de banco de dados que o Reporter pode ler durante a geração. Conexões internas de produto podem já existir; bancos de dados externos são adicionados a partir desta área.
* **Construir Templates** — Define a estrutura e o formato de saída do Relatório, enviando um arquivo `.tpl` preparado ou construindo-o visualmente no Template Builder.
* **Gerar Relatórios** — Executa um Template contra os dados conectados, com filtros opcionais como intervalo de datas, status ou tipo de transação.
* **Revisar o status da geração** — Acompanhe se um Relatório está em `Processing`, `Finished`, `Failed` ou `Error`.
* **Pré-visualizar e baixar a saída** — Abra um Relatório finalizado no Console e baixe o arquivo gerado no formato configurado, como CSV, XML, HTML, TXT ou PDF.
* **Acompanhar lembretes de entrega** — Use a área de Visão Geral para acompanhar prazos próximos e atrasados.

## Áreas operacionais

***

A sidebar do Reporter está organizada em torno do fluxo comum do operador: entender o estado atual, definir a saída, gerar e baixar arquivos, e então gerenciar Data Sources quando uma conexão precisar ser adicionada, testada ou alterada.

<Card title="Visão Geral" horizontal icon="gauge" href="/pt/lerian-console/reporter-console/reporter-module">
  Monitore o workspace atual do Reporter: KPIs, lembretes de entrega, próximos prazos e contagem de erros recentes.
</Card>

<Card title="Data Sources" horizontal icon="database" href="/pt/lerian-console/reporter-console/managing-data-sources">
  Revise conexões internas e configure ou teste conexões externas de banco de dados que o Reporter usa para obter dados.
</Card>

<Card title="Templates" horizontal icon="file-code" href="/pt/lerian-console/reporter-console/managing-templates">
  Crie, atualize, pré-visualize e exclua os Templates que definem o layout e o formato de saída do Relatório.
</Card>

<Card title="Relatórios" horizontal icon="file-chart-column" href="/pt/lerian-console/reporter-console/managing-reports">
  Gere Relatórios, monitore o status, pré-visualize os arquivos finalizados e baixe o resultado.
</Card>

## Área Visão Geral

***

Ao abrir o Reporter, você cai em **Visão Geral**. Use-a como o dashboard operacional do módulo.

Inclui:

* **O que é o Reporter?** — uma descrição curta do módulo e um link para a documentação.
* **Templates** — total de Templates cadastrados.
* **Relatórios Gerados** — total de Relatórios gerados.
* **Data Sources** — total de conexões de banco de dados configuradas.
* **Erros** — erros registrados nos últimos 30 dias.
* **Calendário de Entregas** — prazos de entrega recorrentes ou pontuais exibidos por data.
* **Próximos Prazos** — os próximos lembretes, suas datas de vencimento e seus status.

Os lembretes de entrega ajudam o operador a gerenciar as rotinas de reporting. Eles não geram nem enviam Relatórios automaticamente. A geração continua acontecendo a partir da área **Relatórios**.

## Tarefas principais

***

<CardGroup cols={2}>
  <Card title="Adicionar um Data Source" icon="plus" href="/pt/lerian-console/reporter-console/adding-a-data-source">
    Cadastre uma conexão externa de banco de dados quando o Data Source necessário não está configurado.
  </Card>

  <Card title="Testar uma conexão de Data Source" icon="plug" href="/pt/lerian-console/reporter-console/testing-a-data-source">
    Confirme que credenciais, acesso de rede, ajustes SSL e visibilidade do schema estão corretos.
  </Card>

  <Card title="Adicionar um Template" icon="file-code" href="/pt/lerian-console/reporter-console/adding-template">
    Envie um arquivo `.tpl` preparado ou construa um Template visualmente com o Template Builder.
  </Card>

  <Card title="Gerar um Relatório" icon="play" href="/pt/lerian-console/reporter-console/generating-a-report">
    Execute um Template contra seus dados e produza um arquivo para download.
  </Card>

  <Card title="Baixar um Relatório" icon="download" href="/pt/lerian-console/reporter-console/downloading-a-report">
    Salve o arquivo final a partir de uma geração finalizada.
  </Card>

  <Card title="Corrigir um Relatório" icon="pen" href="/pt/lerian-console/reporter-console/editing-a-report">
    Aprenda o que mudar quando um Relatório gerado está com dados, layout ou formato errados.
  </Card>
</CardGroup>

## Console vs API

***

Use o **Console** quando um operador precisa configurar, gerar, revisar e baixar Relatórios pela interface visual.

Use a **API** quando um sistema precisa automatizar operações do Reporter, integrar o Reporter em outro fluxo ou gerenciar Templates, Relatórios e conexões de Data Source de forma programática.

Os mesmos conceitos do Reporter se aplicam nos dois lugares: os Data Sources fornecem os dados, os Templates definem a saída e os Relatórios são os arquivos gerados. O Data Source pode estar pré-configurado para produtos internos da Lerian ou ser adicionado manualmente para bancos de dados externos.

## Nota sobre comportamento

***

Esta atualização de documentação não introduz uma mudança de comportamento do produto. Ela esclarece como operar o Módulo Reporter existente no Console e onde usar a referência da API para trabalho de integração.