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.

Usa este camino cuando necesites dejar Reporter usable desde la Console por primera vez. La secuencia depende de tu modelo de Data Sources: si los Data Sources internos de producto ya están configurados, empieza por Templates; si necesitas una base de datos externa, añade y prueba el Data Source primero.

​
Antes de empezar

Lee el Concepts Map si nunca has usado Reporter. Explica la cadena operativa:
  • Data Sources definen de dónde lee los datos Reporter.
  • Templates definen la estructura y el formato de salida del archivo.
  • Reports se generan a partir de un Template y se pueden monitorear, visualizar y descargar.
Antes de abrir las pantallas de configuración, decide qué informe quieres producir primero. Por ejemplo: “informe fiscal mensual en CSV”, “informe operativo diario en PDF” o “archivo XML regulatorio filtrado por rango de fechas”. Esa decisión te dice si el Data Source necesario ya existe, qué Template se requiere, qué formato de salida se espera y qué filtros necesitas.

​
Prerrequisitos

RequisitoQué debe estar listoDónde se usa
Acceso a ReporterTu organización puede acceder a Reporter en la Console.Todas las páginas de Reporter
Permisos de ConsoleTu usuario puede gestionar Data Sources, Templates y Reports para la organización.Data Sources, Templates, Reports
Modelo de Data SourceSi el informe usa un Data Source interno ya configurado para productos como Midaz o CRM, o una base de datos externa que debe añadirse manualmente.Setup path
Datos de conexión a la base de datosHost, puerto, nombre de base de datos, usuario, contraseña y la información de red o SSL necesaria. Solo requerido al añadir un Data Source externo.Data Sources
Contexto de los datos de origenLa base de datos, tabla, campos y filtros que deben alimentar el primer informe.Data Sources, Reports
Entrada del TemplateUn archivo .tpl existente o estructura suficiente para construir uno en el Template Builder.Templates, Template Builder
Expectativa de salidaEl formato de archivo requerido, como CSV, XML, HTML, TXT o PDF.Templates, Reports
Necesidad de automatización por APIUna decisión sobre si la configuración será manual en la Console o se automatizará por API.Referencia de la API
Si falta uno de estos elementos, detente primero ahí. Reporter solo puede generar archivos útiles cuando se conocen el Template, la salida prevista y la conexión de datos relevante.

​
Elige el camino de configuración

Usa esta decisión antes de seguir los pasos:
EscenarioEmpezar porPor qué
El informe usa datos internos de producto ya configurados en Reporter.TemplatesLos Data Sources internos para productos como Midaz o CRM pueden ya existir, así que el operador no necesita crear una conexión primero.
El informe usa una base de datos externa o nueva.Data SourcesReporter necesita una conexión configurada manualmente y probada antes de que los templates o filtros puedan usar sus campos.
El informe falla porque faltan datos o no son alcanzables.Data SourcesPrueba la conexión y confirma schemas, tablas y campos antes de regenerar.

​
Secuencia mínima de configuración

1

Confirma el acceso y elige el primer informe

Empieza desde la página Overview de Reporter y confirma que el equipo sabe qué informe se creará primero. Usa la overview cuando necesites explicar para qué sirve cada área de Reporter.Ve a ¿Qué es el módulo Reporter? y al Concepts Map.
2

Confirma el camino del Data Source

Comprueba si el Data Source necesario ya existe. Los Data Sources internos de producto pueden ya estar configurados para el entorno. Si el informe depende de una base de datos externa o de una conexión ausente, añade y prueba ese Data Source antes de construir informes.En la página Data Sources, usa las conexiones existentes cuando ya están presentes. Añade una conexión nueva solo cuando la fuente requerida no esté disponible y ejecuta Test Connection antes de usarla en un informe.Usa Añadir un Data Source y Probar una conexión de Data Source.
3

Añade o construye un Template

El Template define la estructura del informe y el formato de salida. Puedes subir un archivo .tpl existente o construir el Template visualmente en la Console.En la página Templates, usa Añadir un Template. Si el operador necesita ensamblar el diseño a partir de bloques, usa el Template Builder.
4

Genera un Report

En la página Reports, crea un informe a partir del Template. Selecciona el Template, aplica filtros cuando sea necesario, revisa la configuración y genera el archivo.Usa Generar un Report. Este es el momento en el que un Template se convierte en un Report; antes de la generación, es solo una definición reutilizable.
5

Monitorea la finalización y descarga el archivo

Los informes generados empiezan en Processing. Espera a que el estado llegue a Finished y luego visualiza o descarga el archivo de salida.Si el informe termina en Failed o Error, inspecciona los detalles y reejecuta tras corregir el Data Source, el Template o las entradas de los filtros. Usa Descargar un Report cuando el archivo esté listo.
6

Haz seguimiento de fechas de entrega recurrentes cuando aplique

Si el informe tiene un plazo recurrente, usa la página Overview para añadir el recordatorio de entrega. Eso mantiene visibles las entregas próximas y atrasadas sin cambiar cómo se generan los informes.Usa el recordatorio solo para seguimiento operativo. No crea ni programa informes automáticamente.

​
Cuándo usar la referencia de la API

Usa la Console para la primera configuración operativa: confirmar o crear el Data Source, probar conexiones cuando sea necesario, añadir o construir el Template, generar el primer Report y descargar el archivo. Usa la referencia de la API de Reporter cuando necesites automatizar o integrar el mismo flujo, por ejemplo:
  • crear o listar Templates desde otro sistema;
  • crear informes programáticamente;
  • consultar el estado de los informes sin abrir la Console;
  • descargar archivos generados a través de una integración;
  • validar o gestionar conexiones fuera del flujo del operador.
La configuración manual en la Console no requiere la referencia de la API. La referencia de la API es para trabajo de implementación, automatización y troubleshooting con equipos de ingeniería.

​
Qué pasa después

Al final del camino de configuración deberías tener:
  • un Data Source relevante disponible para el informe, ya sea preconfigurado internamente o añadido y probado manualmente;
  • un Template que coincide con el formato de salida requerido;
  • un Report generado con estado Finished;
  • un archivo descargado listo para entrega o validación;
  • recordatorios de entrega opcionales en la página Overview cuando el informe tiene plazos recurrentes.
A partir de ahí, el ciclo operativo normal es simple: mantén saludable el Data Source relevante cuando el informe dependa de uno, actualiza el Template cuando cambie la estructura del archivo, genera Reports cuando sea necesario y descarga el resultado final.

​
Errores comunes de secuencia

Algunos entornos ya incluyen Data Sources internos para productos Lerian como Midaz o CRM. Revisa la lista existente antes de añadir una conexión externa duplicada.
La conexión puede existir, pero las credenciales, el acceso de red y los schemas aún necesitan validación cuando el informe depende de esa fuente. Ejecuta Test Connection antes de confiar en ella.
El Template debe coincidir con el formato de archivo requerido. Confirma si la operación necesita CSV, XML, HTML, TXT o PDF antes de usarlo para generar informes.
Los operadores pueden completar la primera configuración en la Console. Usa la referencia de la API cuando el mismo flujo deba automatizarse, integrarse o depurarse con soporte de ingeniería.

​
Enlaces relacionados

Referencia de la API de Reporter

Úsala cuando el flujo de Reporter deba automatizarse o integrarse vía APIs.