> ## 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 Reporter?

> Transforme dados financeiros em relatórios de negócio e operacionais repetíveis com o Reporter: templates reutilizáveis, renderização automatizada e saída pronta para o BACEN.

O Reporter é o mecanismo de relatórios licenciado da Lerian. Ele transforma
dados dos seus sistemas financeiros em relatórios repetíveis com base em
templates `.tpl` de texto simples. Você define a estrutura do documento uma
vez e gera saídas atualizadas sempre que precisar.

O Reporter pode renderizar arquivos HTML, CSV, XML, PDF e TXT. A Lerian
licencia o Reporter para instituições e mantém seu código-fonte em um repositório
privado.

## Para que você pode usar o Reporter

O Reporter dá às equipes de produto, operações e engenharia uma forma
compartilhada de produzir documentos consistentes a partir de dados que
mudam. Você pode usá-lo para:

* Substituir a montagem manual e recorrente de relatórios por um processo repetível
* Manter a estrutura do documento separada dos dados usados para preenchê-lo
* Reutilizar um template em diferentes períodos de relatório e conjuntos de dados
* Produzir vários formatos de saída por meio de um único workflow de relatórios
* Armazenar templates e arquivos gerados para recuperação posterior

## Problemas que o Reporter resolve

O Reporter separa a extração de dados, a formatação do documento e a entrega.
As fontes de dados fornecem os valores, os templates descrevem a saída e o
workflow de renderização produz o arquivo final. Essa separação ajuda você a
atualizar um layout sem reconstruir a integração de dados, ou conectar novos
dados sem redesenhar cada relatório.

## Como o Reporter funciona

Cada relatório segue o mesmo fluxo:

1. Você cria ou seleciona um template `.tpl`.
2. Você solicita um relatório com os parâmetros e filtros relevantes.
3. O Reporter recupera dados das fontes PostgreSQL ou MongoDB configuradas.
4. O mecanismo de templates aplica a lógica do documento e renderiza a saída.
5. O Reporter armazena o arquivo gerado e o disponibiliza para o sistema
   solicitante.

![Workflow do Reporter, de um template e fontes de dados configuradas até um relatório gerado](https://mintcdn.com/lerian-49cb71fc/TGLv2g3qhXqf0dqb/images/pt/d2/reporter-workflow.svg?fit=max\&auto=format\&n=TGLv2g3qhXqf0dqb\&q=85\&s=a890eb5ae7351eba6f5d17c847fba847)

## Principais capacidades

* **Relatórios orientados por template:** Defina layouts e lógica de documento
  em arquivos `.tpl` reutilizáveis.
* **Múltiplas fontes de dados:** Leia dados de relatório do PostgreSQL e do
  MongoDB.
* **Lógica de documento flexível:** Construa seções condicionais, conteúdo
  repetido, cálculos e agregações nos templates.
* **Múltiplos formatos de saída:** Gere arquivos HTML, CSV, XML, PDF ou TXT.
* **Processamento assíncrono:** Execute a geração de relatórios fora do
  caminho da requisição quando uma carga de trabalho exigir processamento em
  segundo plano.
* **Artefatos duráveis:** Mantenha templates e relatórios gerados em um
  object storage compatível com S3.
* **Ciclo de remessa regulatória:** Quando o deploy carrega um catálogo
  regulatório curado, inscreva-se em um documento, mapeie os campos dele para as
  suas tabelas e transforme cada rascunho gerado em uma remessa aprovada com um
  registro de proveniência.
* **Operação baseada em API:** Crie templates, solicite relatórios e recupere
  resultados por meio da API do Reporter.

## Modelo de arquitetura e deploy

O Reporter mantém o acesso a dados, o processamento de templates, o
armazenamento e a entrega via API como responsabilidades separadas:

* A camada de dados se conecta às fontes PostgreSQL e MongoDB configuradas.
* A camada de templates resolve os dados e renderiza o formato solicitado.
* A camada de armazenamento usa um serviço compatível com S3 para templates e
  saídas.
* A camada de API expõe os recursos de relatórios para aplicações e
  operadores.

![Arquitetura do Reporter com camadas de dados, processamento de templates, armazenamento e API](https://mintcdn.com/lerian-49cb71fc/TGLv2g3qhXqf0dqb/images/pt/d2/reporter-layers.svg?fit=max\&auto=format\&n=TGLv2g3qhXqf0dqb\&q=85\&s=76fdaa4bdf5436f4f855b6b61e585604)

Você faz o deploy do Reporter junto com os bancos de dados e o object storage
que ele precisa acessar. A topologia exata depende do seu ambiente e modelo
operacional.

O Reporter pode se integrar ao [Access Manager](https://docs.lerian.studio/pt/platform/access-manager.md)
para controlar o acesso aos recursos de relatórios. Se essa integração está
habilitada, e quais políticas se aplicam, depende do seu deploy e da oferta
licenciada.

O Reporter concede três dos seus papéis a grupos do Access Manager:

| Grupo | Papel | Acesso |
| - | - | - |
| `reporter-viewer-group` | `viewer` | Leitura. |
| `reporter-contributor-group` | `operator` | Leitura, criação e alteração. |
| `reporter-editor-group` | `editor` | Leitura, criação, alteração, exclusão e aprovação de uma remessa regulatória. |

O grupo de administradores do Access Manager (`admin-group`) também tem o papel
`editor`.

## Próximos passos

> [card] [Comece com o Reporter](https://docs.lerian.studio/pt/products/reporter/reporter-quick-start.md)
>
> Complete o caminho mais curto do acesso até um relatório gerado.

> [card] [Conecte o Reporter ao Midaz](https://docs.lerian.studio/pt/products/reporter/connecting-reporter-to-midaz.md)
>
> Entenda como o Reporter lê dados de um deploy do Midaz.

> [card] [Use o Reporter](https://docs.lerian.studio/pt/products/reporter/using-reporter.md)
>
> Siga orientações orientadas a tarefas para templates, fontes de dados e relatórios.

> [card] [Explore as capacidades de template](https://docs.lerian.studio/pt/products/reporter/template-reference.md)
>
> Revise as tags, filtros e expressões de template disponíveis.


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