> ## 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. # Setup Path > Siga o caminho mínimo de configuração para operar o Reporter a partir do Lerian Console. Use este caminho quando precisar deixar o Reporter utilizável a partir do Console pela primeira vez. A sequência depende do seu modelo de Data Sources: se os Data Sources internos de produto já estão configurados, comece por Templates; se você precisa de um banco de dados externo, adicione e teste o Data Source primeiro. ## Antes de começar *** Leia o [Concepts Map](/pt/lerian-console/reporter-console/reporter-concepts-map) se você nunca usou o Reporter. Ele explica a cadeia operacional: * **Data Sources** definem de onde o Reporter lê os dados. * **Templates** definem a estrutura e o formato de saída do arquivo. * **Relatórios** são gerados a partir de um Template e podem ser monitorados, visualizados e baixados. Antes de abrir as telas de configuração, decida qual relatório você quer produzir primeiro. Por exemplo: "relatório fiscal mensal em CSV", "relatório operacional diário em PDF" ou "arquivo XML regulatório filtrado por intervalo de datas". Essa decisão diz se o Data Source necessário já existe, qual Template é exigido, qual formato de saída é esperado e quais filtros você precisa. ## Pré-requisitos *** | Requisito | O que precisa estar pronto | Onde é usado | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | Acesso ao Reporter | Sua organização consegue acessar o Reporter no Console. | Todas as páginas do Reporter | | Permissões no Console | Seu usuário pode gerenciar Data Sources, Templates e Relatórios da organização. | Data Sources, Templates, Relatórios | | Modelo de Data Source | Se o relatório usa um Data Source interno já configurado para produtos como Midaz ou CRM, ou um banco de dados externo que precisa ser adicionado manualmente. | Setup path | | Dados de conexão do banco | Host, porta, nome do banco, usuário, senha e qualquer informação de rede ou SSL exigida. Necessário só ao adicionar um Data Source externo. | Data Sources | | Contexto dos dados de origem | O banco, tabela, campos e filtros que devem alimentar o primeiro relatório. | Data Sources, Relatórios | | Insumo do Template | Um arquivo `.tpl` existente ou estrutura suficiente para construir 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 por API | Decisão sobre se a configuração permanecerá manual no Console ou será automatizada via API. | Referência da API | Se algum desses itens estiver faltando, pare aí primeiro. O Reporter só consegue gerar arquivos úteis quando o Template, a saída esperada e a conexão de dados relevante são conhecidos. ## Escolha o caminho de configuração *** Use esta decisão antes de seguir os passos: | Cenário | Comece por | Por quê | | ---------------------------------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | O relatório usa dados internos de produto já configurados no Reporter. | **Templates** | Os Data Sources internos 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 externo ou novo. | **Data Sources** | O Reporter precisa de uma conexão configurada manualmente e testada antes de templates ou filtros usarem os campos. | | O relatório falha porque os dados estão faltando ou inacessíveis. | **Data Sources** | Teste a conexão e confirme schemas, tabelas e campos antes de gerar de novo. | ## Sequência mínima de configuração *** Comece pela página Visão Geral do Reporter e confirme que o time sabe qual relatório será criado primeiro. Use a overview quando precisar explicar para que serve cada área do Reporter. Vá para [O que é o módulo Reporter?](/pt/lerian-console/reporter-console/reporter-module) e [Concepts Map](/pt/lerian-console/reporter-console/reporter-concepts-map). Verifique se o Data Source necessário já existe. Os Data Sources internos de produto podem já estar configurados para o ambiente. Se o relatório depende de um banco externo ou de uma conexão ausente, adicione e teste esse Data Source antes de construir relatórios. Na página **Data Sources**, use as conexões existentes quando elas já estiverem presentes. Adicione uma conexão nova apenas quando a fonte necessária não estiver disponível, e rode **Testar Conexão** antes de usá-la em um relatório. Use [Adicionar um Data Source](/pt/lerian-console/reporter-console/adding-a-data-source) e [Testar uma conexão de Data Source](/pt/lerian-console/reporter-console/testing-a-data-source). O Template define a estrutura do relatório e o formato de saída. Você pode subir um arquivo `.tpl` existente ou construir o Template visualmente no Console. Na página **Templates**, use [Adicionar um Template](/pt/lerian-console/reporter-console/adding-template). Se o operador precisa montar o layout a partir de blocos, use o [Template Builder](/pt/lerian-console/reporter-console/template-builder). 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/lerian-console/reporter-console/generating-a-report). Esse é o momento em que um Template vira um Relatório; antes da geração, é apenas uma definição reutilizável. Os relatórios gerados começam em `Processing`. Espere até o status chegar a `Finished` e então visualize ou baixe o arquivo de saída. Se o relatório terminar em `Failed` ou `Error`, inspecione os detalhes e rode de novo após corrigir o Data Source, o Template ou as entradas dos filtros. Use [Baixar um Relatório](/pt/lerian-console/reporter-console/downloading-a-report) quando o arquivo estiver pronto. Se o relatório tem prazo recorrente, use a página **Visão Geral** para adicionar o lembrete de entrega. Isso mantém visíveis as entregas próximas e atrasadas sem mudar como os relatórios são gerados. Use o lembrete apenas para acompanhamento operacional. Ele não cria nem agenda relatórios automaticamente. ## Quando usar a referência da API *** Use o Console para a primeira configuração operacional: confirmar ou criar o Data Source, testar conexões quando necessário, adicionar ou construir o Template, gerar o primeiro Relatório e baixar o arquivo. Use a [referência da API do Reporter](/pt/reference/reporter/reporter-developer-quick-start) quando precisar automatizar ou integrar o mesmo fluxo, por exemplo: * criar ou listar Templates a partir de outro sistema; * criar relatórios programaticamente; * consultar o status dos relatórios sem abrir o Console; * baixar arquivos gerados por meio de uma integração; * validar ou gerenciar conexões fora do fluxo do operador. A configuração manual no Console não exige a referência da API. A referência da API é para trabalho de implementação, automação e troubleshooting com times de engenharia. ## O que acontece depois *** No fim do caminho de configuração você deve ter: * um Data Source relevante disponível para o relatório, seja pré-configurado internamente ou adicionado e testado manualmente; * um Template que corresponda 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 tem prazos recorrentes. A partir daí, o ciclo operacional normal é simples: mantenha o Data Source relevante saudável quando o relatório depender de um, atualize o Template quando a estrutura do arquivo mudar, gere Relatórios quando necessário e baixe o resultado final. ## Erros comuns de sequência *** Alguns ambientes já incluem Data Sources internos para produtos Lerian como Midaz ou CRM. Cheque a lista existente antes de adicionar uma conexão externa duplicada. A conexão pode existir, mas credenciais, acesso de rede e schemas ainda precisam ser validados quando o relatório depende dessa fonte. Rode **Testar Conexão** antes de confiar nela. 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. Os operadores conseguem completar a primeira configuração no Console. Use a referência da API quando o mesmo fluxo precisar ser automatizado, integrado ou depurado com suporte de engenharia. ## Links relacionados *** Use quando o fluxo do Reporter precisa ser automatizado ou integrado via APIs.