> ## 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 utilizá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](/pt/products/reporter/console/reporter-concepts-map) se você nunca usou o Reporter antes. Ele explica a cadeia operacional:

* **Fontes de Dados** definem de onde o Reporter lê os dados.
* **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.

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          | Recomenda-se que o banco de dados, a tabela, os campos e os filtros alimentem o primeiro relatório.                                                              | Fontes de Dados, Relatórios            |
| 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.

## Escolha o caminho de configuração

***

Use esta decisão antes de seguir as etapas:

| Cenário                                                                | Comece por          | Por quê                                                                                                                             |
| ---------------------------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| O relatório usa dados internos de produto já configurados no Reporter. | **Templates**       | Fontes de Dados internas para produtos como Midaz ou CRM podem já existir, então o operador não precisa criar uma conexão primeiro. |
| O relatório usa um banco de dados externo ou novo.                     | **Fontes de Dados** | O Reporter precisa de uma conexão configurada e testada manualmente antes que templates ou filtros possam usar os campos dela.      |
| O relatório falha porque os dados estão ausentes ou inacessíveis.      | **Fontes de Dados** | Teste a conexão e confirme schemas, tabelas e campos antes de gerar novamente.                                                      |

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

***

<Steps>
  <Step title="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](/pt/products/reporter/console/reporter-module) e [Mapa de conceitos do Reporter](/pt/products/reporter/console/reporter-concepts-map).
  </Step>

  <Step title="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 **Fontes de Dados**, 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. Depois execute **Testar Conexão** antes de usá-la em um relatório.

    Use [Adicionar uma Fonte de Dados](/pt/products/reporter/console/adding-a-data-source) e [Testar a conexão de uma Fonte de Dados](/pt/products/reporter/console/testing-a-data-source).
  </Step>

  <Step title="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](/pt/products/reporter/console/adding-template). Se o operador precisar montar o layout a partir de blocos, use o [Template Builder](/pt/products/reporter/console/template-builder).
  </Step>

  <Step title="Gerar um Relatório">
    Na página **Relatórios**, crie um relatório a partir do Template. Selecione o Template, aplique filtros quando necessário, revise a configuração e gere o arquivo.

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

  <Step title="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`, verifique os detalhes e execute-o novamente depois de corrigir a Fonte de Dados, o Template ou os filtros. Use [Baixar um relatório](/pt/products/reporter/console/downloading-a-report) quando o arquivo estiver pronto.
  </Step>

  <Step title="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. Isso não muda como o Reporter gera relatórios.

    Use o lembrete apenas para acompanhamento operacional. Ele não cria nem agenda relatórios automaticamente.
  </Step>
</Steps>

## Quando usar a referência da API

***

Use o Console para a primeira configuração operacional:

* confirmar ou criar a Fonte de Dados.
* testar conexões quando necessário.
* adicionar ou criar o Template.
* gerar o primeiro Relatório.
* baixar o arquivo.

Use a [referência da API do Reporter](/pt/reference/products/reporter/reporter-developer-quick-start) quando precisar automatizar ou integrar o mesmo workflow, como:

* criar ou listar Templates a partir de outro sistema.
* criar relatórios de forma programática.
* verificar o status do relatório sem abrir o Console.
* baixar arquivos gerados por meio de uma integração.
* validar ou gerenciar conexões fora do workflow do operador.

A configuração manual pelo Console não exige a referência da API. A referência da API é para trabalho de implementação, automação e resolução de problemas com equipes de engenharia.

## O que acontece depois

***

Ao final do caminho de configuração, recomenda-se que você tenha:

* uma Fonte de Dados relevante disponível para o relatório, pré-configurada internamente ou adicionada e testada manualmente.
* um Template que corresponde ao formato de saída exigido.
* um Relatório gerado com status `Finished`.
* um arquivo baixado pronto para entrega ou validação.
* lembretes de entrega opcionais na página Visão geral quando o relatório tiver prazos recorrentes.

Depois disso, o ciclo operacional normal é:

* manter a Fonte de Dados relevante saudável quando o relatório depender de uma.
* atualizar o Template quando a estrutura do arquivo mudar.
* gerar Relatórios quando necessário.
* baixar a saída final.

## Erros comuns de sequenciamento

***

<AccordionGroup>
  <Accordion title="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>

  <Accordion title="Usar uma Fonte de Dados que nunca foi testada">
    A conexão pode existir, mas credenciais, acesso à rede e schemas ainda precisam de validação quando o relatório depende dessa fonte. Execute **Testar Conexão** antes de confiar nela.
  </Accordion>

  <Accordion title="Enviar um Template sem saber o formato de saída">
    Recomenda-se que o Template corresponda 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>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>

## Links relacionados

***

<Card title="Referência da API do Reporter" icon="code" href="/pt/reference/products/reporter/reporter-developer-quick-start" horizontal>
  Use quando você deve automatizar ou integrar o workflow do Reporter por meio de APIs.
</Card>
