Usando Reporter

Reporter ayuda a los usuarios de Midaz Ledger a crear reportes dinámicos basados en datos sin escribir SQL. En lugar de construir consultas complejas, defines dominios, tablas y campos usando marcadores de posición simples.

​

Uso típico

---

Así es como funciona el flujo de trabajo de principio a fin:

​

Paso 1 – Crear el archivo .tpl

Escribe tu plantilla usando la estructura que coincida con tu salida deseada: HTML, XML, CSV o TXT. Por ejemplo, si tu objetivo es un reporte XML, el archivo debe seguir la sintaxis XML e incluir bloques de Reporter. Consulta las páginas de Ejemplos de plantillas para ver algunos ejemplos de cómo crear tu archivo.

​

Paso 2 – Subir la plantilla

Una vez que tu archivo .tpl esté listo, súbelo usando el endpoint Subir una Plantilla.

• Establece el campo outputFormat para definir el formato de reporte esperado.
• El sistema nombra automáticamente el archivo usando un UUID: 0196159b-4f26-7300-b3d9-f4f68a7c85f3.tpl.

Gestionando plantillas

Puedes gestionar tus plantillas con los siguientes endpoints:

• Listar Plantillas – Ver todas las plantillas en tu organización.
• Recuperar detalles de Plantilla – Acceder a la información de una plantilla específica.
• Actualizar una Plantilla – Reemplazar el archivo .tpl, editar la descripción o cambiar el formato de salida.
• Eliminar una Plantilla – Marca una plantilla como eliminada estableciendo la marca de tiempo deletedAt. Los datos permanecen almacenados, pero no aparecerán en consultas estándar.

​

Paso 3 – Generar el reporte

Con tu plantilla subida, usa el endpoint Crear un Reporte para activar la generación del reporte.

• La API devuelve un reportId que puedes usar para rastrear el proceso y obtener la salida final cuando esté lista.

​

Paso 4 – Verificar el estado del reporte

Usa el endpoint Verificar Estado del Reporte para monitorear el progreso.

• Verás si el reporte está en processing (procesando) o finished (finalizado).
• Puede incluirse contexto adicional para ayudar a solucionar problemas o confirmar la finalización.

​

Paso 5 – Descargar el reporte

Una vez que el estado del reporte sea finished, descarga el archivo usando el endpoint Descargar un Reporte.

• El archivo se devuelve en el cuerpo de la respuesta.
• El encabezado Content-Disposition establece el nombre de archivo y formato correcto para soportar una experiencia de descarga fluida.

​

Mapeo de fuentes de datos para filtros dinámicos

---

Para soportar filtrado dinámico durante la generación de reportes, el plugin Reporter ofrece dos endpoints de soporte:

• Listar Fuentes de Datos: Lista las fuentes de datos disponibles en el sistema.
• Recuperar una Fuente de Datos por id: Devuelve el esquema para la fuente de datos seleccionada, incluyendo tablas y campos.

Estos endpoints son especialmente útiles si estás construyendo una interfaz donde los usuarios pueden seleccionar una fuente de datos y aplicar filtros dinámicamente antes de generar un reporte. Esta separación ayuda a reducir el tamaño de la carga útil y mejora el rendimiento al permitir que los sistemas carguen solo lo que necesitan, cuando lo necesitan.