Saltar al contenido 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.

El Módulo Reporter usa un pequeño conjunto de objetos centrales. Están relacionados, pero el operador no siempre empieza por crear un Data Source. En algunos entornos, los Data Sources internos para productos Lerian como Midaz o CRM ya están configurados. Esta página es el camino más corto al modelo mental.

​
Flujo principal

Reporter tiene dos puntos de entrada comunes:
  • Datos internos de producto ya configurados: Template → Report → Descarga
  • Conexión de datos externa o ausente: Data Source → Template → Report → Descarga
  • El Template dice cómo debe verse el informe y en qué formato.
  • El Data Source dice de dónde vienen los datos. Puede ya existir para productos internos o añadirse manualmente para bases de datos externas.
  • El Report es el archivo generado, producido al ejecutar un Template contra los datos conectados, opcionalmente acotado por filtros.
  • La Descarga es la acción del operador que saca el archivo finalizado de la Console.

​
Qué significa cada objeto

ObjetoQué representaPor qué existe antes o después
Data SourceUna conexión de datos configurada. Puede ser una conexión interna de producto ya creada para el entorno, o una conexión externa como PostgreSQL o MongoDB.Existe antes de la generación, pero el operador solo necesita crearla manualmente cuando la conexión requerida no está ya configurada.
TemplateUna definición reutilizable de estructura y formato de salida (CSV, XML, HTML, TXT o PDF), subida como archivo .tpl o construida visualmente con el Template Builder.Describe cómo debe verse el informe. Por sí mismo no ejecuta nada.
FilterUna regla opcional aplicada en el momento de la generación (Database + Table + Field + Operator + Value).Acota los datos usados en una ejecución concreta del Report, sin cambiar el Template.
ReportLa salida producida cuando un Template se ejecuta contra los datos. Tiene un estado (Processing, Finished, Failed, Error).Es el artefacto real que el operador entrega.
PreviewLa vista del Report Finished dentro de la Console, adaptada a su formato de salida.Permite al operador validar el resultado antes de enviarlo.
DescargaLa acción que saca el archivo del Report finalizado de la Console en su formato configurado.Es el punto final operativo del flujo.
ReminderUn plazo de entrega opcional gestionado desde la página Overview (Once, Daily, Weekly, Monthly, Semiannual, Annual).Se usa cuando un Report tiene una cadencia de entrega recurrente que hay que operar.

​
Cuándo un Template se convierte en un Report

Un Template por sí solo es solo una definición. Se convierte en un Report en un momento específico: cuando haces clic en Generate Report en el asistente de 4 pasos de la página Reports. En ese momento:
  1. Reporter toma el Template seleccionado.
  2. Aplica los filtros que hayas configurado.
  3. Lee desde los Data Sources referenciados por el Template.
  4. Produce un archivo en el formato de salida del Template y lo añade a la lista de Reports con estado Processing.
  5. Cuando termina la generación, el estado pasa a Finished y el archivo queda disponible para descarga.
Hasta ese momento, solo tienes una plantilla. Después de ese momento, tienes un informe.

​
Qué campos importan de verdad

Cuando los operadores se atascan, suele ser en torno al mismo puñado de campos. Esta es la lista corta de los que tienen efecto operativo real.

​
Al revisar o añadir un Data Source

  • Connection Name — Cómo aparece la conexión en todas partes (en templates, en filtros de informes). Para Data Sources externos, elige algo que identifique el entorno, no solo el motor (p. ej., production-db, no solo postgres).
  • Database Type — Determina el puerto por defecto, si se soportan schemas y el driver de conexión usado.
  • Host / Port / Database Name / Username / Password — Lo mínimo necesario para llegar a la base de datos.
  • Schemas (PostgreSQL, Oracle, SQL Server) — Limita qué schemas puede explorar Reporter. Déjalo vacío para usar el valor por defecto (public) en los motores que lo soportan.
  • SSL Configuration — Opcional, pero úsalo siempre que la ruta de red no sea totalmente confiable.

​
Al añadir un Template

  • Archivo .tpl (modo upload) — La definición real del template. Obligatorio.
  • Template Name — Cómo aparece el Template en listas y selectores.
  • Output Format — Fija el tipo de archivo final (CSV, XML, HTML, TXT o PDF). Cuando se selecciona PDF en el Template Builder, el código generado es HTML, renderizado como PDF en el momento de la generación.

​
Al generar un Report

  • Template — El Template que quieres ejecutar.
  • Filters (opcional) — Cada fila es Database + Table + Field + Operator + Value(s). Usa filtros para producir un corte más estrecho sin editar el Template.

​
Lectura práctica de la UI

Usa esta interpretación al guiar a los usuarios:
  • Templates define cómo debe verse la salida.
  • Reports es donde la estructura y los datos se juntan y producen un archivo.
  • Data Sources define lo que Reporter puede leer. Úsalo para inspeccionar conexiones existentes, probar conectividad o añadir bases de datos externas.
  • Overview es el dashboard operativo: KPIs, calendario de entregas y recordatorios de entregas próximas o atrasadas.

​
Dónde suelen perderse los usuarios

Un Template es una definición. Un Report es un archivo generado. El mismo Template puede convertirse en muchos Reports a lo largo del tiempo (cada uno con sus propios filtros, fecha de ejecución y estado).
El Data Source es la conexión que Reporter usa para leer datos. Un Filter es un acotamiento por ejecución que no cambia el Template ni el Data Source — solo qué datos incluye el Report actual.
El Template Builder genera código .tpl a partir de bloques que ensamblas en la Console. Subir un .tpl salta el builder y usa un archivo preparado fuera. Ambos terminan como el mismo tipo de Template, pero solo los creados con el builder pueden volver a editarse en el editor visual.
Que un Report llegue a Finished significa que el archivo está generado y descargable. Si realmente fue entregado (enviado a un regulador, archivado, etc.) se gestiona por separado mediante reminders en la página Overview.
Combina esta página con Setup path al hacer onboarding de nuevos usuarios. Una explica el modelo; la otra, el orden.