> ## 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.

# Mapa de conceitos

> Entenda como Templates, Relatórios, Fontes de Dados e downloads se relacionam no Reporter antes de usar o módulo no Lerian Console para relatórios regulatórios.

O Módulo Reporter usa um pequeno conjunto de objetos principais. Eles se conectam entre si, mas o operador nem sempre começa criando uma Fonte de Dados. Em alguns ambientes, as Fontes de Dados internas de produtos Lerian como Midaz ou CRM já estão configuradas.

## Fluxo principal

***

O Reporter tem dois caminhos comuns de entrada:

* **Dados de produto interno já configurados:** `Template → Report → Download`

* **Conexão de dados externa ou ausente:** `Data Source → Template → Report → Download`

* O **Template** diz *como o relatório deve ficar e em qual formato*.

* A **Fonte de Dados** diz *de onde vêm os dados*. Ela pode já existir para produtos internos. Para bancos de dados externos, você a adiciona manualmente.

* O **Relatório** é o arquivo que o Reporter produz quando executa um Template sobre os dados conectados. Filtros podem restringir o resultado.

* O **Download** é a ação do operador que leva o arquivo finalizado para fora do Console.

### O que cada objeto significa

| Objeto        | O que representa                                                                                                                                                           | Por que existe antes ou depois                                                                                                           |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `Data Source` | Uma conexão de dados configurada. Pode ser uma conexão de produto interno já criada para o ambiente, ou uma conexão de banco de dados externo, como PostgreSQL ou MongoDB. | Ela existe antes da geração, mas o operador apenas precisa criar uma manualmente quando a conexão necessária ainda não está configurada. |
| `Template`    | Uma definição reutilizável de estrutura e formato de saída (CSV, XML, HTML, TXT ou PDF), enviada como um arquivo `.tpl` ou montada visualmente com o Template Builder.     | Ele descreve *como* o relatório deve ficar. Não executa nada por conta própria.                                                          |
| `Filter`      | Uma regra opcional aplicada no momento da geração (Database + Table + Field + Operator + Value).                                                                           | Ela restringe os dados usados em uma única execução de Relatório, sem alterar o Template.                                                |
| `Report`      | A saída produzida quando um Template é executado sobre os dados. Tem um status (`Processing`, `Finished`, `Partial`, `Error`).                                             | É o artefato real que o operador entrega.                                                                                                |
| `Preview`     | A visualização dentro do Console de um relatório `Finished`, adaptada ao formato de saída dele.                                                                            | Ela permite que o operador valide o resultado antes de enviá-lo.                                                                         |
| `Download`    | A ação que leva o arquivo do relatório finalizado para fora do Console no formato configurado.                                                                             | É o ponto final operacional de todo o fluxo.                                                                                             |
| `Reminder`    | Um prazo de entrega opcional rastreado pela página Visão geral (Once, Daily, Weekly, Monthly, Semiannual, Annual).                                                         | Usado quando um Relatório tem uma cadência de entrega recorrente para gerenciar operacionalmente.                                        |

## Quando um Template se torna um Relatório

***

Um Template sozinho é apenas uma definição. Ele se torna um Relatório quando você clica em **Gerar Relatório** no assistente de 4 etapas na página **Relatórios**.

Nesse momento:

1. O Reporter usa o Template selecionado.
2. Ele aplica os filtros que você configurou.
3. Ele lê as Fontes de Dados referenciadas pelo Template.
4. Ele produz um arquivo no formato de saída do Template e o adiciona à lista de Relatórios com status `Processing`.
5. Quando a geração termina, o status muda para `Finished` e o arquivo fica disponível para download.

## Quais campos realmente importam

***

Quando os operadores ficam travados, geralmente é em torno do mesmo pequeno grupo de campos.

### Ao verificar ou adicionar uma Fonte de Dados

* **Nome da Conexão**: como a conexão aparece em todos os outros lugares (nos templates, nos filtros de relatório). Para Fontes de Dados externas, escolha algo que identifique o ambiente, não apenas o mecanismo (por exemplo, `production-db`, e não apenas `postgres`).
* **Tipo de Banco de Dados**: selecione PostgreSQL ou MongoDB. Ele determina a porta padrão e o driver de conexão.
* **Host / Porta / Nome do Banco de Dados / Usuário / Senha**: o mínimo necessário para acessar o banco de dados.
* **Schemas** (PostgreSQL): limita quais schemas o Reporter pode navegar. Deixe em branco para usar o padrão (`public`).
* **Configuração SSL**: opcional, mas use quando você não confia totalmente no caminho de rede.

### Ao adicionar um Template

* **Arquivo `.tpl`** (modo de envio): a definição real do template. Obrigatório.
* **Nome do Template**: como o Template aparece em listas e seletores.
* **Formato de Saída**: define o tipo final do arquivo (CSV, XML, HTML, TXT ou PDF). Quando você seleciona PDF no Template Builder, o código gerado é HTML, renderizado como PDF no momento da geração.

### Ao gerar um Relatório

* **Template**: o Template que você quer executar.
* **Filtros** (opcional): cada linha é `Database + Table + Field + Operator + Value(s)`. Use filtros para produzir um recorte mais restrito sem editar o Template.

## Leitura prática da interface

***

Use esta interpretação ao orientar usuários:

* `Templates` define *como a saída deve ficar*.
* `Reports` é onde a estrutura e os dados se juntam e produzem um arquivo.
* `Data Sources` define *o que o Reporter tem permissão para ler*. Use-o para inspecionar conexões existentes, testar a conectividade ou adicionar bancos de dados externos.
* `Overview` é o painel operacional: KPIs, o calendário de entregas e lembretes para entregas futuras ou atrasadas.

## Onde os usuários costumam se perder

***

<AccordionGroup>
  <Accordion title="Template vs Relatório">
    Um Template é uma definição. Um Relatório é um arquivo gerado. Você pode gerar muitos Relatórios a partir do mesmo Template ao longo do tempo (cada um com seus próprios filtros, data de execução e status).
  </Accordion>

  <Accordion title="Fonte de Dados vs Filtro">
    A Fonte de Dados é a conexão que o Reporter usa para ler dados. Um Filtro é uma restrição por execução que não altera o Template nem a Fonte de Dados, apenas quais dados o Relatório atual inclui.
  </Accordion>

  <Accordion title="Template Builder vs enviar um `.tpl`">
    O Template Builder gera código `.tpl` a partir dos blocos que você monta no Console. Enviar um `.tpl` pula o builder e usa um arquivo preparado externamente. Os dois resultam no mesmo tipo de Template, mas apenas os templates criados no builder podem ser editados novamente no editor visual.
  </Accordion>

  <Accordion title="Por que um Relatório finalizado não é o mesmo que um Relatório entregue">
    Quando um Relatório atinge `Finished`, o Reporter já produziu o arquivo e você pode baixá-lo. Os lembretes na página Visão geral acompanham a entrega separadamente, como enviar o arquivo a um regulador ou arquivá-lo.
  </Accordion>
</AccordionGroup>

<Tip>
  Combine esta página com [Caminho de configuração](/pt/products/reporter/console/reporter-setup-path) ao integrar novos usuários. Uma página explica o modelo. A outra explica a ordem.
</Tip>
