> ## 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 Fontes de Dados, crie Templates, gere Relatórios e baixe o resultado por meio de uma interface visual no Lerian Console.

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

Use-o para definir a estrutura da saída, gerar um Relatório, revisar seu status e baixar o arquivo final. Quando o relatório precisa de um banco de dados externo ou uma conexão precisa de validação, use **Fontes de Dados** para gerenciar essa conexão. Os casos de uso típicos incluem envios regulatórios, extratos de auditoria interna, relatórios operacionais recorrentes e relatórios avulsos para um período específico.

Esta página explica como operar o módulo Reporter pelo Console.

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

## Quem usa esta página

***

Use esta página se você produz ou gerencia Relatórios no Console. Isso costuma significar equipes de operações, compliance, financeiro, regulatório ou suporte. Essas equipes transformam dados armazenados em um arquivo para revisão, envio ou arquivamento.

Equipes de desenvolvimento e integração também podem usar o Reporter, mas a referência principal delas é a [referência da API do Reporter](/pt/reference/products/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 esta é sua primeira vez usando o Reporter, comece entendendo qual caminho de configuração se aplica. Alguns ambientes já incluem Fontes de Dados internas para produtos Lerian, como o Midaz ou o CRM. Nesse caso, o operador costuma conseguir começar por **Templates** e **Relatórios**. Use **Fontes de Dados** primeiro quando precisar adicionar um banco de dados externo ou validar uma conexão existente.

<CardGroup cols={2}>
  <Card title="Caminho de configuração" icon="clipboard-list-check" href="/pt/products/reporter/console/reporter-setup-path">
    Escolha o caminho certo: use Fontes de Dados internas existentes, ou adicione e teste uma Fonte de Dados externa antes de gerar Relatórios.
  </Card>

  <Card title="Mapa de conceitos" icon="network-wired" href="/pt/products/reporter/console/reporter-concepts-map">
    Entenda como Fontes de Dados, Templates, Relatórios, pré-visualizações e downloads se relacionam.
  </Card>
</CardGroup>

## O que você pode operar

***

No módulo Reporter, você pode:

* **Gerenciar Fontes de Dados**: revisar, testar ou registrar conexões de banco de dados de onde o Reporter pode ler durante a geração. Conexões internas de produtos podem já existir. Adicione bancos de dados externos nesta área.
* **Criar Templates**: defina a estrutura e o formato de saída do Relatório, enviando um arquivo `.tpl` já preparado ou criando um visualmente no Template Builder.
* **Gerar Relatórios**: execute um Template sobre os dados conectados, com filtros opcionais como período, status ou tipo de transação.
* **Revisar o status de geração**: acompanhe se um Relatório está `Processing`, `Finished`, `Partial` 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 Visão geral para seguir prazos de relatórios futuros e vencidos.

## Áreas operacionais

***

A barra lateral do Reporter segue o fluxo comum do operador: entender o estado atual, definir a saída e então gerar e baixar os arquivos. Gerencie Fontes de Dados quando adicionar, testar ou alterar uma conexão.

<Card title="Visão geral" horizontal icon="gauge" href="/pt/products/reporter/console/reporter-module">
  Monitore o workspace atual do Reporter: KPIs, lembretes de entrega, prazos futuros e contagem recente de erros.
</Card>

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

<Card title="Templates" horizontal icon="file-code" href="/pt/products/reporter/console/managing-templates">
  Crie, atualize, pré-visualize e exclua 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/products/reporter/console/managing-reports">
  Gere Relatórios, monitore o status deles, pré-visualize arquivos finalizados e baixe o resultado.
</Card>

## Área Visão geral

***

Quando você abre o Reporter, chega à **Visão geral**. Use-a como o dashboard operacional do módulo.

Ela inclui:

* **O que é o Reporter?** Uma breve descrição do módulo e um link para a documentação.
* **Templates**: número total de Templates registrados.
* **Relatórios gerados**: número total de Relatórios gerados.
* **Fontes de Dados**: número total de conexões de banco de dados configuradas.
* **Erros**: erros registrados nos últimos 30 dias.
* **Calendário de entregas**: prazos de relatórios recorrentes ou avulsos exibidos por data.
* **Próximos prazos**: os próximos lembretes, suas datas de vencimento e seu status.

Os lembretes de entrega ajudam os operadores a gerenciar rotinas de relatórios. Eles não geram nem enviam Relatórios automaticamente. A geração de relatórios continua acontecendo na área **Relatórios**.

## Principais tarefas

***

<CardGroup cols={2}>
  <Card title="Adicionar uma Fonte de Dados" icon="plus" href="/pt/products/reporter/console/adding-a-data-source">
    Registre uma conexão de banco de dados externa quando a Fonte de Dados necessária ainda não estiver configurada.
  </Card>

  <Card title="Testar a conexão de uma Fonte de Dados" icon="plug" href="/pt/products/reporter/console/testing-a-data-source">
    Confirme se as credenciais, o acesso à rede, as configurações de SSL e a visibilidade do schema estão corretos.
  </Card>

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

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

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

  <Card title="Corrigir um Relatório" icon="pen" href="/pt/products/reporter/console/editing-a-report">
    Saiba o que alterar quando um Relatório gerado tem dados, layout ou formato incorretos.
  </Card>
</CardGroup>

## Console x API

***

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

Use a **API** quando um sistema precisar automatizar as operações do Reporter, integrar o Reporter a outro workflow, ou gerenciar Templates, Relatórios e conexões de Fontes de Dados de forma programática.

Os mesmos conceitos do Reporter se aplicam nos dois lugares: as Fontes de Dados fornecem os dados, os Templates definem a saída e os Relatórios são os arquivos gerados. A Fonte de Dados pode ser pré-configurada para produtos Lerian internos ou adicionada manualmente para bancos de dados externos.
