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

# Caminho de configuração

> Siga o caminho mínimo de configuração para operar o Reporter a partir do Lerian Console: fontes de dados, templates, primeira geração de relatório e verificação de download.

Use este caminho quando precisar tornar o Reporter usável pelo Console pela primeira vez. A sequência depende do seu modelo de fonte de dados. Comece por Templates se as Fontes de Dados internas de produtos já estiverem configuradas. Se precisar de um banco de dados externo, adicione e teste a Fonte de Dados primeiro.

## Antes de começar

***

Leia o [mapa de conceitos do Reporter](https://docs.lerian.studio/pt/products/reporter/console/reporter-concepts-map.md) se você nunca usou o Reporter antes. Ele explica a cadeia operacional:

* **Fontes de Dados** definem de onde o Reporter lê os dados.
* **Instituições** definem para quem é um Relatório e quais linhas cada instituição lê.
* **Templates** definem a estrutura e o formato de saída do arquivo.
* **Relatórios** são os arquivos que o Reporter gera a partir de um Template. Você pode monitorá-los, visualizá-los e baixá-los.

Este caminho configura Relatórios operacionais a partir de Templates. Para entregar um documento regulatório do catálogo, use o [Envio Regulatório](https://docs.lerian.studio/pt/products/reporter/console/regulatory-filing.md) depois de cadastrar as Fontes de Dados e as instituições.

Antes de abrir as telas de configuração, decida qual relatório você quer produzir primeiro. Por exemplo: "relatório mensal de impostos em CSV", "relatório operacional diário em PDF" ou "arquivo XML regulatório filtrado por período". Essa decisão indica se a Fonte de Dados necessária já existe. Também indica qual Template, formato de saída e filtros você precisa.

## Pré-requisitos

***

| Requisito | O que deve estar pronto | Onde é usado |
| - | - | - |
| Acesso ao Reporter | Sua organização pode acessar o Reporter no Console. | Todas as páginas do Reporter |
| Permissões do Console | Seu usuário pode gerenciar Fontes de Dados, Templates e Relatórios da organização. | Fontes de Dados, Templates, Relatórios |
| Modelo de Fonte de Dados | Se o relatório usa uma Fonte de Dados interna já configurada para produtos como Midaz ou CRM, ou um banco de dados externo que deve ser adicionado manualmente. | Caminho de configuração |
| Detalhes da conexão de banco de dados | Host, porta, nome do banco de dados, usuário, senha e qualquer informação de rede ou SSL necessária. Obrigatório apenas ao adicionar uma Fonte de Dados externa. | Fontes de Dados |
| Contexto dos dados de origem | O banco de dados, a tabela, os campos e os filtros que devem alimentar o primeiro relatório. | Fontes de Dados, Relatórios |
| Detalhes das instituições | O CNPJ de cada instituição pela qual o tenant declara e as linhas que pertencem a ela. Um envio regulatório precisa de uma instituição. | Instituições, Relatórios, Envio Regulatório |
| Entrada do Template | Um arquivo `.tpl` existente ou estrutura de relatório suficiente para criar um no Template Builder. | Templates, Template Builder |
| Expectativa de saída | O formato de arquivo exigido, como CSV, XML, HTML, TXT ou PDF. | Templates, Relatórios |
| Necessidade de automação via API | Uma decisão sobre se a configuração vai continuar manual no Console ou ser automatizada pela API. | Referência da API |

Se um desses itens estiver ausente, resolva-o primeiro. O Reporter apenas consegue gerar arquivos úteis quando você conhece o Template, a saída pretendida e a conexão de dados relevante.

## Sequência mínima de configuração

***

**1. Confirmar o acesso e escolher o primeiro relatório**

Comece pela visão geral do Reporter. Confirme que a equipe sabe qual relatório criar primeiro. Use a visão geral quando precisar explicar para que serve cada área do Reporter.

Acesse [Módulo Reporter](https://docs.lerian.studio/pt/products/reporter/console/reporter-module.md) e [Mapa de conceitos do Reporter](https://docs.lerian.studio/pt/products/reporter/console/reporter-concepts-map.md).

**2. Confirmar o caminho da Fonte de Dados**

Verifique se a Fonte de Dados necessária já existe. Fontes de Dados internas de produtos podem já estar configuradas para o ambiente. Se o relatório depender de um banco de dados externo ou de uma conexão ausente, adicione essa Fonte de Dados. Teste-a antes de criar relatórios.

Na página **Data Sources**, use as conexões existentes quando já estiverem presentes. Adicione uma nova conexão apenas quando a fonte necessária não estiver disponível. O Console testa a conexão quando você a salva.

Use [Adicionar uma Fonte de Dados](https://docs.lerian.studio/pt/products/reporter/console/adding-a-data-source.md) e [Testar a conexão de uma Fonte de Dados](https://docs.lerian.studio/pt/products/reporter/console/testing-a-data-source.md).

**3. Registrar as instituições**

Registre cada instituição pela qual o tenant declara, com o CNPJ e o escopo dela. Um Relatório lê para uma instituição ou para todas. Um envio regulatório é feito para uma instituição.

Use [Gerenciar Instituições](https://docs.lerian.studio/pt/products/reporter/console/managing-institutions.md). Use **Propor a partir do Midaz** para começar pelas organizações que o Midaz já tem.

**4. Adicionar ou criar um Template**

O Template define a estrutura do relatório e o formato de saída. Você pode enviar um arquivo `.tpl` existente ou criar o Template visualmente no Console.

Na página **Templates**, use [Adicionar um template](https://docs.lerian.studio/pt/products/reporter/console/adding-template.md). Se o operador precisar montar o layout a partir de blocos, use o [Template Builder](https://docs.lerian.studio/pt/products/reporter/console/template-builder.md).

**5. Gerar um Relatório**

Na página **Relatórios gerados**, crie um relatório a partir do Template. Selecione o Template. Escolha a instituição e preencha os parâmetros quando o assistente pedir. Aplique filtros quando necessário, revise a configuração e gere o arquivo.

Use [Gerar um relatório](https://docs.lerian.studio/pt/products/reporter/console/generating-a-report.md). Este é o ponto em que um Template se torna um Relatório. Antes da geração, ele é apenas uma definição reutilizável.

**6. Monitorar a conclusão e baixar o arquivo**

Os relatórios gerados começam em `Processing`. Espere o status chegar a `Finished` e então visualize ou baixe o arquivo de saída.

Se o relatório terminar em `Error` ou `Partial failure`, verifique os detalhes. Depois execute-o novamente quando corrigir a Fonte de Dados, o Template ou os filtros. Use [Baixar um relatório](https://docs.lerian.studio/pt/products/reporter/console/downloading-a-report.md) quando o arquivo estiver pronto.

**7. Acompanhar datas de entrega recorrentes quando necessário**

Se o relatório tiver um prazo recorrente, use a página **Visão geral** para adicionar o lembrete de entrega. Isso mantém as entregas futuras e vencidas visíveis.

## Erros comuns de sequenciamento

***

> [accordion] Criar uma Fonte de Dados quando já existe uma
>
> Alguns ambientes já incluem Fontes de Dados internas para produtos Lerian como Midaz ou CRM. Verifique a lista existente antes de adicionar uma conexão externa duplicada.

> [accordion] Usar uma Fonte de Dados que nunca foi testada
>
> Uma conexão externa pode existir, mas as credenciais e o acesso à rede dela ainda precisam de validação quando o relatório depende dessa fonte. Execute **Testar Conexão** antes de confiar nela.

> [accordion] Enviar um Template sem saber o formato de saída
>
> O Template deve corresponder ao formato de arquivo exigido. Confirme se a operação precisa de CSV, XML, HTML, TXT ou PDF antes de usá-lo para gerar relatórios.

> [accordion] Esperar que a referência da API substitua a configuração no Console
>
> Os operadores podem concluir a primeira configuração no Console. Use a referência da API quando você deve automatizar, integrar ou depurar o mesmo workflow com o apoio da engenharia.

## Links relacionados

***

> [card] [Referência da API do Reporter](https://docs.lerian.studio/pt/reference/products/reporter/reporter-developer-quick-start.md)
>
> Use quando você deve automatizar ou integrar o workflow do Reporter por meio de APIs.


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