Inicio rápido de Reporter

Usa este inicio rápido para generar un informe y confirmar que tu instalación de Reporter funciona de principio a fin. Para un workflow recurrente en producción, consulta Uso de Reporter. Para ver los esquemas completos de solicitud y respuesta, usa el Inicio rápido de la API de Reporter y las páginas de referencia de la API vinculadas.

Objetivo

Vas a:

Crear una plantilla .tpl mínima.
Subirla como plantilla HTML.
Generar un informe sin filtros de datos.
Hacer seguimiento del informe hasta que termine el procesamiento.
Descargar y verificar el archivo terminado.

Requisitos previos

Necesitas:

Una instancia de Reporter en ejecución
Un token de autenticación, si Access Manager está habilitado
curl

Define los valores usados en los ejemplos:

export REPORTER_URL="https://reporter.example.com"
export TOKEN="your-access-token"

Crea una plantilla mínima

Crea first-report.tpl con contenido HTML estático:

<!doctype html>
<html>
  <body>
    <h1>My first Reporter output</h1>
  </body>
</html>

Las plantillas de Reporter siempre usan la extensión .tpl. El contenido de la plantilla debe coincidir con el formato de salida seleccionado. Reporter admite salidas en HTML, CSV, XML, PDF y TXT. Para la salida en PDF, escribe la plantilla en HTML y define outputFormat=PDF. Para plantillas que leen datos, consulta Formatos de plantilla.

Sube la plantilla

Sube el archivo con los tres campos multipart obligatorios: template, outputFormat y description.

curl --fail-with-body -X POST "$REPORTER_URL/v1/templates" \
  -H "Authorization: Bearer $TOKEN" \
  -F "template=@first-report.tpl" \
  -F "outputFormat=HTML" \
  -F "description=First Reporter output"

Guarda el id de plantilla devuelto como TEMPLATE_ID:

export TEMPLATE_ID="returned-template-id"

Consulta Subir plantilla para ver el contrato completo de la operación.

Genera el informe

Crea un informe con los campos obligatorios templateId y filters. Usa un objeto vacío cuando no necesites filtros.

curl --fail-with-body -X POST "$REPORTER_URL/v1/reports" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"templateId\":\"$TEMPLATE_ID\",\"filters\":{}}"

Guarda el id de informe devuelto como REPORT_ID:

export REPORT_ID="returned-report-id"

Consulta Crear informe para ver la sintaxis de los filtros y el contrato completo de la operación.

Haz seguimiento del procesamiento

Verifica el informe hasta que salga del estado Processing:

curl --fail-with-body \
  -H "Authorization: Bearer $TOKEN" \
  "$REPORTER_URL/v1/reports/$REPORT_ID"

El ciclo de vida activo es:

Processing -> Finished | Partial | Error

Estado	Significado	Qué hacer
`Processing`	Reporter está generando la salida.	Vuelve a verificar más tarde.
`Finished`	La generación terminó correctamente.	Descarga el informe.
`Partial`	La generación terminó con resultados incompletos.	Revisa los detalles del informe y los logs de la aplicación.
`Error`	La generación falló.	Revisa el error y los logs de la aplicación antes de reintentar.

Consulta Verificar el estado del informe para ver el esquema de la respuesta.

Descarga y verifica la salida

Descarga solo cuando el estado del informe sea Finished:

curl --fail-with-body \
  -H "Authorization: Bearer $TOKEN" \
  "$REPORTER_URL/v1/reports/$REPORT_ID/download" \
  -o first-report.html

Confirma que el archivo no esté vacío y contenga el encabezado esperado:

test -s first-report.html
grep -F "My first Reporter output" first-report.html

Consulta Descargar informe para ver los encabezados de respuesta y los detalles de error.

Solución de problemas

Problema	Verificación
La subida de la plantilla es rechazada	Incluye el archivo `.tpl`, `outputFormat` y `description`; confirma que el contenido del archivo coincida con el formato.
La creación del informe es rechazada	Envía tanto `templateId` como `filters`; usa `{}` cuando no aplique ningún filtro.
El informe permanece en `Processing`	Verifica el estado del worker y de la cola de Reporter, luego revisa los logs de la aplicación.
El informe termina en `Partial` o `Error`	Revisa los detalles del informe, las fuentes de datos referenciadas y los logs de la aplicación antes de reintentar.
La descarga es rechazada	Confirma que el informe exista y tenga el estado `Finished`.

Próximos pasos

Sigue Uso de Reporter para diseñar un workflow reutilizable y recurrente.
Aprende a referenciar datos configurados en Formatos de plantilla.
Revisa la guía especializada en Plantillas BACEN antes de trabajar con estructuras de informes regulatorios.
Usa el Inicio rápido de la API de Reporter para ver ejemplos completos de la API.

Resumen

Conceptos

Guías

Integración

Console

Operaciones

Inicio rápido de Reporter

Objetivo

Requisitos previos

Crea una plantilla mínima

Sube la plantilla

Genera el informe

Haz seguimiento del procesamiento

Descarga y verifica la salida

Solución de problemas

Próximos pasos

​Objetivo

​Requisitos previos

​Crea una plantilla mínima

​Sube la plantilla

​Genera el informe

​Haz seguimiento del procesamiento

​Descarga y verifica la salida

​Solución de problemas

​Próximos pasos

Objetivo

Requisitos previos

Crea una plantilla mínima

Sube la plantilla

Genera el informe

Haz seguimiento del procesamiento

Descarga y verifica la salida

Solución de problemas

Próximos pasos