Pular para o conteúdo principal

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 Módulo Reporter usa um pequeno conjunto de objetos centrais. Eles estão relacionados, mas o operador nem sempre começa criando um Data Source. Em alguns ambientes, os Data Sources internos para produtos Lerian como Midaz ou CRM já estão configurados. Esta página é o caminho mais curto para o modelo mental.

​
Fluxo principal

O Reporter tem dois caminhos de entrada comuns:
  • Dados internos de produto já configurados: Template → Relatório → Download
  • Conexão de dados externa ou ausente: Data Source → Template → Relatório → Download
  • O Template diz como o relatório deve ficar e em que formato.
  • O Data Source diz de onde os dados vêm. Pode já existir para produtos internos ou ser adicionado manualmente para bancos de dados externos.
  • O Relatório é o arquivo gerado, produzido ao executar um Template contra os dados conectados, opcionalmente delimitado por filtros.
  • O Download é a ação do operador que tira o arquivo finalizado do Console.

​
O que cada objeto significa

ObjetoO que representaPor que existe antes ou depois
Data SourceUma conexão de dados configurada. Pode ser uma conexão interna de produto já criada para o ambiente, ou uma conexão externa como PostgreSQL ou MongoDB.Existe antes da geração, mas o operador só precisa criar uma manualmente quando a conexão necessária não está configurada.
TemplateUma definição reutilizável de estrutura e formato de saída (CSV, XML, HTML, TXT ou PDF), enviada como arquivo .tpl ou construída visualmente com o Template Builder.Descreve como o relatório deve ficar. Por si só não executa nada.
FilterUma regra opcional aplicada no momento da geração (Banco de Dados + Tabela + Campo + Operador + Value).Delimita os dados usados em uma execução específica do Relatório, sem mudar o Template.
RelatórioA saída produzida quando um Template é executado contra os dados. Tem um status (Processing, Finished, Failed, Error).É o artefato real que o operador entrega.
PreviewA visualização do Relatório Finished dentro do Console, adaptada ao formato de saída.Permite ao operador validar o resultado antes de enviá-lo.
DownloadA ação que tira o arquivo do Relatório finalizado do Console no formato configurado.É o ponto final operacional do fluxo.
ReminderUm prazo de entrega opcional gerenciado a partir da página Visão Geral (Once, Daily, Weekly, Monthly, Semiannual, Annual).Usado quando um Relatório tem uma cadência de entrega recorrente para operar.

​
Quando um Template vira um Relatório

Um Template por si só é apenas uma definição. Vira um Relatório em um momento específico: quando você clica em Gerar Relatório no wizard de 4 passos da página Relatórios. Nesse momento:
  1. O Reporter pega o Template selecionado.
  2. Aplica os filtros que você configurou.
  3. Lê dos Data Sources referenciados pelo Template.
  4. Produz um arquivo no formato de saída do Template e adiciona à lista de Relatórios com status Processing.
  5. Quando a geração termina, o status passa para Finished e o arquivo fica disponível para download.
Até esse momento, você só tem um template. Depois desse momento, você tem um relatório.

​
Quais campos realmente importam

Quando os operadores travam, normalmente é em torno do mesmo punhado de campos. Esta é a lista curta dos que têm efeito operacional real.

​
Ao revisar ou adicionar um Data Source

  • Nome da Conexão — Como a conexão aparece em todo lugar (em templates, em filtros de relatórios). Para Data Sources externos, escolha algo que identifique o ambiente, não só o engine (ex.: production-db, não só postgres).
  • Tipo de Banco de Dados — Determina a porta padrão, se schemas são suportados e o driver de conexão usado.
  • Host / Porta / Nome do Banco de Dados / Usuário / Senha — O mínimo necessário para alcançar o banco de dados.
  • Schemas (PostgreSQL, Oracle, SQL Server) — Limita quais schemas o Reporter pode navegar. Deixe vazio para usar o padrão (public) nos engines que suportam.
  • Configuração SSL — Opcional, mas use sempre que o caminho de rede não for totalmente confiável.

​
Ao adicionar um Template

  • Arquivo .tpl (modo upload) — A definição real do template. Obrigatório.
  • Nome do Template — Como o Template aparece em listas e seletores.
  • Formato de Saída — Trava o tipo de arquivo final (CSV, XML, HTML, TXT ou PDF). Quando PDF é selecionado no Template Builder, o código gerado é HTML, renderizado como PDF no momento da geração.

​
Ao gerar um Relatório

  • Template — O Template que você quer executar.
  • Filtros (opcional) — Cada linha é Database + Table + Field + Operator + Value(s). Use filtros para produzir um recorte mais estreito sem editar o Template.

​
Leitura prática da UI

Use esta interpretação ao orientar os usuários:
  • Templates define como a saída deve ficar.
  • Relatórios é onde a estrutura e os dados se encontram e produzem um arquivo.
  • Data Sources define o que o Reporter pode ler. Use para inspecionar conexões existentes, testar conectividade ou adicionar bancos de dados externos.
  • Overview é o dashboard operacional: KPIs, calendário de entregas e lembretes de entregas próximas ou atrasadas.

​
Onde os usuários costumam se perder

Um Template é uma definição. Um Relatório é um arquivo gerado. O mesmo Template pode virar muitos Relatórios ao longo do tempo (cada um com seus próprios filtros, data de execução e status).
O Data Source é a conexão que o Reporter usa para ler dados. Um Filter é um recorte por execução que não muda o Template nem o Data Source — apenas quais dados o Relatório atual inclui.
O Template Builder gera código .tpl a partir de blocos que você monta no Console. Subir um .tpl pula o builder e usa um arquivo preparado fora. Ambos terminam como o mesmo tipo de Template, mas só os criados pelo builder podem ser reeditados no editor visual.
Um Relatório chegar a Finished significa que o arquivo foi gerado e pode ser baixado. Se ele foi de fato entregue (enviado a um regulador, arquivado etc.) é acompanhado separadamente via reminders na página Visão Geral.
Combine esta página com o Setup path ao fazer onboarding de novos usuários. Uma explica o modelo; a outra, a ordem.