> ## 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 tipos de saída. Um Relatório operacional vem de um Template. Um envio regulatório vem de um documento do catálogo e não precisa de um Template que você envia. Para um envio regulatório, veja [Envio Regulatório](https://docs.lerian.studio/pt/products/reporter/console/regulatory-filing.md): assine um documento, mapeie seus dados, gere um rascunho, revise-o e aprove-o.

Para um Relatório operacional, 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. |
| `Institution` | Um declarante regulatório do tenant, com o CNPJ dele e as linhas de cada Fonte de Dados que pertencem a ele. | Um Relatório lê para uma instituição, ou para todas. Um envio regulatório é feito para uma instituição. |
| `Parameter` | Um valor que o Template declara e que o operador informa no momento da geração, como um mês de referência. | Ele define o período ou a opção de uma única execução de Relatório. |
| `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 failure` ou `Error`. Um envio regulatório tem os próprios status, `Draft` e `Final`, em **Entregas**. | É 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 gerados**.

Nesse momento:

1. O Reporter usa o Template selecionado, a instituição e os parâmetros.
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.

## Onde os usuários costumam se perder

***

> [accordion] 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] 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] 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, e os dois abrem no mesmo assistente de edição.

> [accordion] 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.

> [!TIP]
>
> Combine esta página com [Caminho de configuração](https://docs.lerian.studio/pt/products/reporter/console/reporter-setup-path.md) ao integrar novos usuários. Uma página explica o modelo. A outra explica a ordem.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.