Eneboo Reports - Miguel-J/doc GitHub Wiki

Eneboo-Reports es una extensión de Eneboo que añade un visor interno de informes que usa plantillas Jasper (.jrxml) y que puede sustituir o complementar al viejo sistema de informes oficial (que usa los .kut)

Para usar Eneboo-Reports necesitamos lo siguiente:

  1. Aplicar a nuestro código las extensiones de eneboo-repots
  2. Instalar Java SDK (javac es necesario para "compilar" los reportes).
  3. [Las librerías y el ejecutable .jar del proyecto eneboo-reports](#3-la-librería-y-el ejecutable-eneboo-reports)
  4. Plantillas .jrxml para cada informe que se quiera generar con eneboo-reports
  5. Configurar eneboo-reports

1. Aplicar las extensiones de eneboo-reports:

Para usar eneboo-repots tenemos que aplicar las siguientes extensiones a nuestro código:

  • ext9002-jasper_plugin - Implementación de Jasper Reports para el uso de informes Jasper
  • ext1058-jplugin_plus - jasper_plugin extendida para listar informes de un directorio al imprimir

Para conseguir esto podemos cargar el paquete 'Eneboo Standard' o aplicar las extensiones manualmente, como se describe a continuación.

Paquete de módulos de Eneboo Standard:

Hay disponible un paquete standard que ya tiene aplicadas las extensiones necesarias para usar eneboo-reports, pero que también incluye muchas otras que tal vez no necesites.

Para cargar este paquete o consultar la lista de extensiones incluidas, se puede consultar [aqui.]([Eneboo Standard] Instalación#4-cargar-el-paquete-de-eneboo-standard)).

www.eneboo.org/pub/contrib/2.4.5.1-rc7/prj0001-standard-2015_06_25.eneboopkg

Aplicar las extensiones manualmente:

Para aplicar estas extensiones manualmente necesitamos tener instaladas las eneboo-tools y seguir el siguiente proceso:

  1. Descargar ext9002 y ext1058 de github.
  2. Hacer una copia de las carpetas que encontraremos dentro de la carpeta "patches" de cada extension (carpetas 'jasper_plugin' y 'jplugin_plus').
  3. Hacer una copia de nuestra carpeta de módulos (la podemos nombrar 'original').
  4. En la misma ruta donde colocamos las 3 carpetas anteriores, ejecutar los siguientes comandos:
    • # eneboo-mergetool folder-patch ./jasper_plugin ./original ./parcheado9002
    • # eneboo-mergetool folder-patch ./jplugin_plus ./parcheado9002 ./final
  5. En el paso anterior se crean 2 carpetas nuevas:
    • carpeta 'parcheado9002' que podemos eliminar (es nuestro código parcheado sólo con la ext9002)
    • carpeta 'final' que es nuestro código parcheado para usar eneboo-reports
  6. En eneboo, cargamos los módulos de la carpeta 'final' que acabamos de generar

2. Instalar Java SDK:

(javac es necesario para "compilar" los reportes)

sólo versiones java7 o java8

3. La librería y el ejecutable eneboo-reports:

Eneboo-Repoprts necesita un ejecutable y unas librerías para hacer su trabajo. Podemos obtener la versión más reciente desde el GIT oficial

Una vez descargada la versión adecuada para nuestra versión de java, descomprimimos el .zip y encontraremos dentro un ejecutable .jar y una carpeta 'lib' que debemos colocar, dentro de una misma carpeta, en una ruta disponible para cualquier equipo que necesite usar eneboo-reports.

P.ej. las rutas pueden ser estas:

/servidor/eneboo-reports/plugin/enebooreports.jar

/servidor/eneboo-reports/plugin/lib/*

4. Plantillas .jrxml para eneboo-reports:

Consigue plantillas jasper listas para usar en: https://github.com/eneboo/reports4eneboo-reports

Consulta la guía básica para crear o modificar plantillas para eneboo-reports en: https://github.com/eneboo/doc/wiki/Crear-plantillas-Jasper-para-Eneboo-Reports

Para que eneboo-reports pueda localizar la plantilla adecuada para cada informe, tenemos que organizarlas en carpetas siguiendo el siguiente criterio:

  • Todas plantillas tenemos que colocarlas dentro de una misma carpeta, en una ruta disponible para cualquier equipo que necesite usar eneboo-reports.
  • Dentro de esta carpeta tenemos que crear otra carpeta con el nombre de base de datos que usamos para acceder a eneboo (una carpeta para cada base de datos)
  • Dentro de esta última carpeta tenemos que crear 3 carpetas con los siguientes nombres:
    • 'reports'
    • 'subreports'
    • 'temp_files'
  • Dentro de la carpeta 'reports' tenemos que crear otras carpetas con el nombre de cada informe que queramos generar con eneboo-reports (este nombre será el el mismo que tiene el .kut para ese informe)
  • Dentro de cada una de las anteriores carpetas con el nombre del informe, podemos poner todas las diferentes plantillas que necesitemos usar para ese informe (si tenemos varias plantillas para un mismo informe, el plugin eneboo-reports nos mostrará una ventana de selección cuando pulsemos el botón 'imprimir')
  • Dentro de la carpeta 'subreports' tenemos que colocar los subreportes (algunas plantillas usan subreportes para "incrustarlos" dentro de un reporte)

Listado de nombres de plantillas:

  • Presupuestos a Cliente: i_presupuestoscli
  • Pedidos de Cliente: i_pedidoscli
  • Albaranes a Cliente: i_albaranesscli
  • Servicios a Cliente: i_servicioscli
  • Facturas a Cliente: i_facturasscli
  • Pedidos a Proveedor: i_pedidosprov
  • Albaranes de Proveedor: i_albaranessprov
  • Facturas de Proveedor: i_facturassprov
  • Recibos a Cliente: i_reciboscli
  • Remesas a Cliente: i_remesascli
  • Resumen de Facturas a Cliente: i_resfacturascli
  • Resumen de Recibos a Cliente: i_resreciboscli
  • Fichas de Clientes: i_clientes
  • Fichas de Proveedores: i_proveedores
  • Inventario sin valorar: i_iventario
  • Inventario valorado: i_iventarioval

P.ej. la ruta a las plantillas para facturas a cliente puede ser esta:

/servidor/eneboo-reports/informes/nombre-empresa/reports/i_facturascli

  • Nota: Si necesitamos modificar las plantillas para adaptarlas a nuestras necesidades, podemos usar la aplicación JasperStudio.

5. Configurar eneboo-reports:

En eneboo, menú Facturación > Informes > Datos generales, en la pestaña 'Jasper Plgin' configuramos lo siguiente:

  • Ruta a los informes: Es la ruta a la carpeta 'informes' donde colocamos las plantillas .jrxml (en el punto 4)

  • Ruta a la librería eneboo-reports: Es la ruta a la carpeta donde colocamos el ejecutable y la carpeta de librerías (en el punto 3)

Para los ejemplos de los puntos 3 y 4, deberíamos configurar lo siguiente:

  • Ruta informes: /servidor/eneboo-reports/informes/
  • Ruta librería: /servidor/eneboo-reports/plugin/

Para comprobar si está bien configurado podemos usar los botones de test que encontraremos debajo: 'Java JRE' y 'Conexión a librería'.