Liferay Jasper

Andrés Aznar Royo Página 1

Aperte Reports: Integrando informes de Jasper en Liferay

Andrés Aznar [email protected]


INDICE

1.- La creación de informes y su publicació ..................................... 3 1.1.- Jaspersoft iReports .................................................................. 3 1.2.- Aperte Reports ........................................................................ 3 2.- Prerrequisitos para la instalación ............................................... 5 3.- Instalando Aperte Reports .......................................................... 6 3.1.- El software de Aperte .............................................................. 6 4.- Instalación de Aperte Reports .................................................... 8 4.1.- Despliegue del WAR File ......................................................... 8 4.2.- La configuración de la conexión JNDI ..................................... 8 4.3.- Actualización de Vaadin ........................................................ 10 5.- Los portlets de Aperte Reports ................................................. 13 5.1.- El portlet de administración ................................................... 13 5.3.- El portlet de visualización .................................................. 16 5.4.- Los portlets para informes en background....................... 17 6.- La generación de los informes en Jasper ................................. 18 6.1- La definición del parámetro datasource ................................. 18 6.2.- La sintaxis de los parámetros propios de informes ......... 18 7.- Conclusiones ............................................................................ 20


1.- La creación de informes y su publicación

1.1.- Jaspersoft iReports

La gestión de la información a partir de su almacenamiento en bases de datos relacionales permite realizar una exportación de las mismas y una representación en listados o gráficos que mejora la comprensión de los datos. Este ha sido el origen de las aplicaciones de reporting, datawarehousing, business intelligence, datamining etc…

Dentro de las aplicaciones open source destinadas a este tipo de sistemas la más significativa y más utilizada ha sido la herramienta de Jaspersoft comúnmente conocida como Jasper Reports. El programa iReport permite la generación de informes a partir de datos clasificados, ya sean estos tablas de una base de datos, hojas de cálculo, ficheros ASCII o datos embebidos en Javabeans.

Muchos sistemas realizados a medida en tecnología J2EE han utilizado estos informes y las librerías de Jasper para integrar la visión de esa información embebida. Teniendo en cuenta que Liferay es un portal basado en Java es lógico pensar que existan formas de poder embeber esos informes dentro del portal y generar portlets para visualizar o exportar en formato documental dichos informes.

Vista de Liferay con la integración de el visor de informes de Jasper de Aperte Reports

1.2.- Aperte Reports

Aperte Reports es un desarrollo realizado desde la empresa Bluesoft, open source, y que permite introducir dentro de Liferay la visión de los informes generados con Jaspersoft iReports. A partir de su web en el vault de desarrollos de Google


http://code.google.com/p/aperte-reports es posible descargar su aplicación y las instrucciones propias para ser integrado dentro de nuestro entorno Liferay (o utilizar un bundle de prueba ya creado con Liferay+Aperte Reports). No obstante este documento pretende realizar dicha tarea de una forma más ilustrativa y en lengua castellana.

Aperte Reports nos permitirá insertar dentro de Liferay aquellos informes que hayamos realizado con iReports, incluyendo la posibilidad de que integren parámetros a fin de poder visualizarlos de forma dinámica en función de los mismos. También será posible realizar exportación de los informes a formatos como PDF o MS Excel.

Vista de la generación de informes en PDF desde Aperte Reports en Liferay


2.- Prerrequisitos para la instalación

Aperte Reports está basado en estándares open source, desde el propio Liferay, hasta Vaadin, Hibernate o Quarz. En base a ello es muy posible que el funcionamiento del sistema pueda extrapolarse a otros entornos no listados en este capítulo. No obstante, el testing realizado desde Bluesoft y, por tanto, los entornos sobre los cuales el software está certificado, son los siguientes:

• Base de datos: o HSQL (embebido en el bundle de descarga de Liferay 6). Esta base de

datos no se recomienda desde Liferay para entornos de producción. o PostgreSQL en su versión 9.1 o MySQL en su versión 5.0.77 o Oracle en su versión 10g

• Servidor de aplicaciones: o Glashfish en versión 3.0.1 o JBoss en su versión 5.1 o Tomcat en versión 6.0.29 (con funcionalidad limitada ya que no permite

la funcionalidad de Cyclic reports). • Contenedor de portlet:

o Liferay 6.0.6 Community Edition o Liferay 6.1 Community Edition

El presente documento está realizado con una configuración de MySQL 5.5, Liferay 6.1 bajo Tomcat 7.0.29, siendo totalmente operativo.


3.- Instalando Aperte Reports

3.1.- El software de Aperte

El software de Aperte Reports está disponible para la descarga en la dirección:

http://code.google.com/p/aperte-reports/downloads/list

Este directorio contiene dos tipos de ficheros:

• El fichero WAR de la aplicación para ser desplegado sobre un servidor de aplicaciones (en diferentes versiones)

• Un bundle de Liferay (bajo Tomcat) preconfigurado para poder desplegar en él la aplicación. El bundle no contiene Aperte Reports.

Pantalla de descarga de Aperte Reports

3.1.1.- El bundle de Liferay preconfigurado

El bundle de Liferay configurado y descargable contiene dos modificaciones respecto de la instalación estándar del portal:

• Dispone de la versión 6.7.4 de Vaadin, una versión más reciente y necesaria para el uso de Aperte Reports que la que trae de serie Liferay.

• Ya tiene configurada la conexión JNDI con una base de datos a fin de cargar los datos de los reports.


3.1.2.- El fichero WAR de despliegue

El fichero WAR de la aplicación es un fichero estándar para ser desplegado en un servidor de aplicaciones como Tomcat o JBoss. Como cualquier otra aplicación que se vaya a incluir como portlets dentro de Liferay la forma de realizar esta instalación es colocar el fichero en el directorio

{Directorio de Liferay}\deploy


4.- Instalación de Aperte Reports

4.1.- Despliegue del WAR File

Para instalar Aperte Reports simplemente situaremos el fichero WAR descargado en el directorio de despliegue de Liferay {Directorio de Liferay}\deploy. De esta manera el servidor de aplicaciones realizará el despliegue y la aplicación nos aparecerá en nuestro portal.

Si la instalación la realizamos sobre el bundle preconfigurado que podemos descargar de la página de Aperte Reports no tendremos que realizar ninguna acción adicional para tener disponible el aplicativo. Si nuestro despliege se realiza sobre una instalación ya realizada de Liferay tendremos que realizar dos operaciones adicionales para que Aperte Reports funcione:

• Configurar la conectividad de nuestro servidor de aplicaciones con la fuente de alimentación de datos (la base de datos o de donde se vayan a extraer los datos para la generación de los informes).

• Actualizar la versión de Vaadin si la que disponemos es anterior a la 6.7.4.

4.2.- La configuración de la conexión JNDI

Aperte Reports utiliza una conexión con la fuente de datos de los informes JNDI que nombre como jdbc/aperte-reports.

Esto nos obligará a realizar dos cosas en nuestra instalación y utilización del sistema:

• Deberemos configurar dicha conexión en nuestro servidor de aplicaciones. • Los informes generados desde iReport deberán incluir esta conexión como

parámetro a fin que Liferay encuentre donde debe ir a buscar los datos. Esta segunda parte la trataremos más adelante.

Para dar de alta una conexión JNDI del servidor de aplicaciones contra una base de datos debemos configurarla en su fichero context.xml. Este fichero se halla ubicado en el directorio {Directorio del servidor de aplicaciones}\conf. Si, por ejemplo, hemos instalado el bundle de Liferay extraído de su propia web en nuestra unidad D: lo deberemos buscar en: D:\Liferay\tomcat-7.0.23\conf.

En nuestro caso basaremos nuestra conexión en los siguientes parámetros:

• Usaremos un motor de base de datos mySQL 5.5 • Nuestro usuario será “root” con contraseña “admin” • Nuestra base de datos se llamará jasper • La tendremos localizada en la misma máquina que Liferay y Aperte (en el

localhost)


Vista de la base de datos mySQL desde Quest Toad

En base a todo lo anterior deberemos declarar en nuestro context.xml la siguiente instrucción:

<Resource name="jdbc/aperte-reports" auth="Container" type="javax.sql.DataSource" driverClassName="com.mysql.jdbc.Driver" url="jdbc:mysql://localhost:3306/jasper" maxActive="8" maxIdle="4" username="root" password="admin" />

Fichero context.xml del servidor de aplicaciones con la conexión jdbc/aperte-reports


Esta instrucción creará la conexión desde el servidor de aplicaciones a la base de datos en mySQL, y Aperte Reports la utilizará para obtener los datos con los que generar el informe.

4.3.- Actualización de Vaadin

El bundle de Liferay ya incopora Vaadin en su estructura. Vaadin es un framework web creado para desarrollar aplicaciones RIA (Rich Internet Applications) sin plugins y con una arquitectura server-driven, con un modelo orientado a componentes y pensando en la simplificación de la programación; no es necesario conocer ni HTML, ni XML ni Javascript.

La versión de Vaadin incorporada en el último bundle de Liferay es anterior a la 6.7.4 que es la que nos solicita Aperte Reports para funcionar. Por tanto, si vamos a trabajar sobre el bundle o sobre una instalación con un Vaadin anterior, debemos realizar la actualización.

Si nuestra instalación además de las librerías y ficheros dispone del portlet de Vaadin, esta actualización se puede realizar directamente desde Liferay. Hay determinadas aplicaciones, como por ejemplo Aperte Workflow (otra aplicación de origen similar a la que tratamos pensada para la generación de workflows jBPM dentro de Liferay) que en sus bundles incorporan no sólo la actualización de los ficheros de Vaadin, sino el propio portlet de administración.

Acceso al gestor de Vaadin en el panel de control de Liferay


Este portlet de administración se sitúa en la parte del menú de portal. El portlet nos muestra la información sobre la versión en los settings, además de indicarnos cual es la versión más actual disponible. Desde allí podemos utilizar la opción change version para actualizarlo.

Una vez actualizado hemos de recordar que hemos de recompilarlo. Para ello usaremos el botón compile widget set que está encima de la consola de mensajes.

Portlet de gestión de Vaadin en el panel de control de Liferay

Si no disponemos del portlet de control de Vaadin en nuestra instalación de Liferay deberemos aplicar los cambios de manera manual. Estos cambios consisten en:

• Cambiar la librería vaadin.jar de Vaadin ubicada en el directorio {servidor de aplicaciones}\webapps\ROOT\WEB-INF\lib.

• Actualizar el denominado widget set, que corresponde a los ficheros de Vaadin ubicados en el directorio del servidor de aplicaciones (Tomcat) {servidor de aplicaciones}\webapps\ROOT\html\VAADIN.

Para realizar estos cambios iremos a la página web de versiones de Vaadin (https://vaadin.com/releases) y descargaremos el software necesario. En principio la versión sobre la que está desarrollado Aperte Reports es la 6.7.4, pero sobre las posteriores hasta la 6.7.6 se ha comprobado el correcto funcionamiento.

Debemos descargar el paquete denominado Vaadin 6 Jar-only for all platforms que incluye el fichero vaadin.jar y el denominado Vaadin 6 Liferay update package. El primero sólo contiene la librería .jar. El segundo contiene un fichero comprimido con el widget set.


Vista de la página de descarga de versiones de Vaadin

Vista del contenido del fichero vaadin-6.7.5-liferay.zip el widget set de Vaadin para Liferay

Seguiremos ahora los pasos indicados:

• El fichero .jar descargado (que tendrá como nombre vaadin-6.7.x.jar) lo pondremos en el directorio {servidor de aplicaciones}\webapps\ROOT\WEB-INF\lib y lo renombraremos a vaadin.jar. Deberemos borrar o renombrar el existente previamente con ese nombre perteneciente a la versión anterior. Es posible que existan otras aplicaciones (no sólo el propio Liferay)

• A continuación descomprimiremos el fichero con los archivos del widget set (vaadin-6.7.x-liferay.zip) en el directorio del servidor de aplicaciones {servidor de aplicaciones}\webapps\ROOT\html reescribiendo los ficheros nuevos sobre aquellos ya existentes de la versión anterior

La actualización de Vaadin se deberá completar rearrancando el servidor de aplicaciones y Liferay.

Una vez generada la conexión JNDI en el servidor, actualizado Vaadin, y desplegado el fichero WAR ya dispondremos de Aperte Reports en nuestro gestor de contenidos.


5.- Los portlets de Aperte Reports

Aperte reports nos generará, en su despliegue los siguientes portlets dentro de Liferay:

• Portlet de administración en el panel de control (Aperte Reports Manager). • Cuatro portlets de utilización dentro del portal

o Aperte Cyclic Reports o Aperte Resports Dashboard o Aperte Reports Invoker o Aperte Reports Order Browser

Visión del portal y de los cuatro posibles portlets que se pueden integrar

5.1.- El portlet de administración

El portlet de administración (Aperte Reports Manager) nos aparecerá en nuestro panel de control de Liferay. Será con él que podamos realizar la importación de los informes generados en iReport de Jasper que queremos que sean visualizados y gestionados en nuestro portal.


Acceso al portlet de administración desde el panel de control de Liferay

En el portlet veremos que por una parte disponemos del botón upload new… que nos permitirá insertar nuevos informes dentro de Liferay. Por otro lado tenemos los diferentes informes ya insertados donde mediante la opción de show parameters podemos desplegar las propiedades e incluso generar la exportación de los mismos para ver el resultado.

Portlet de administración de Aperte Reports en el panel de control

Ejemplo de generación de un report en PDF desde el portlet de administración

5.2.- El portlet de generación y exportación

Aperte report invoker es un portlet que nos permite generar informes y exportarlos a diferentes formatos: CSV, HTML, MS Excel y PDF. Básicamente nos traslada la funcionalidad que ya tiene el portlet de administración en el panel de control a un portlet publicable en cualquiera de las páginas de nuestro portal de Liferay.


Visión del portlet Aperte Reports Invoker

Vista de la exportación a Excel del informe


5.3.- El portlet de visualización

El portlet de visualización (Aperte Reports Dashboard) permite realizar la visualización de los informes dentro de la propia interfaz de Liferay (sin necesidad de generarlo sobre un formato externo como PDF o XLS).

Visión del portlet Aperte Reports Dashboard

En este portlet se nos permitirá visualizar aquel informe que queramos (y, obviamente, cambiar de uno a otro). Para realizar la visualización del informe los pasos a seguir serán:

1. Seleccionar desde el menú de herramientas la opción de preferencias.

2. Seleccionar el informe y completar los parámetros adicionales que el propio informe requiera.

3. Salvar mediante el botón Save e indicar que se desea volver a la página índice.


Repitiendo la misma acción se podrá seleccionar otro informe y seguir viendo los diferentes resultados.

5.4.- Los portlets para informes en background

Aperte reports permite la generación de informes en background, así que los resultados no se generan de forma automática e inmediata. Estos informes se pueden guardar en el sistema e incluso enviar por correo electrónico. Existen dos porlets para tratar estos tipos de informes:

• Aperte reports order browser nos permite acceder a todos los reports generados en background para poder visualizarlos en pantalla.

• Aperte cyclic reports permite gestionar la generación de informes periódicos, que se generarán en background cuando pertoque.

Los informes en background no son operativos si el entorno de implementación de Liferay es Tomcat, por lo que no serán tratados en este documento en profundidad.


6.- La generación de los informes en Jasper

A fin que los informes generados en iReports puedan ser introducidos en nuestro Aperte Reports para su integración en Liferay se han de realizar algunas implementaciones en nuestro fichero jrxml del informe.

6.1.- La definición del parámetro datasource

En el fichero del informe deberemos añadir un parámetro que deberá llamarse “datasource”. Este parámetro tendrá en su descripción la cadena de conexión que usaremos y que habíamos definido con anterioridad, en la instalación de Aperte, en el fichero context.xml. Será un parámetro estático cuya única validez será para que lo interpreten nuestros portlet.

<parameter name="datasource" class="java.lang.String" isForPrompting="false"> <parameterDescription> <![CDATA[java:comp/env/jdbc/aperte-reports]]></parameterDescription>

</parameter>

F

Vista de iReport: código XML con el parámetro datasource y su definición

6.2.- La sintaxis de los parámetros propios de informes

El resto de parámetros que utilicen los informes deberán estar introducidos también mediante la llamada a nuestra cadena de conexión JNDI que tenemos definida java:comp/env/jdbc/aperte-reports.


Así la sintaxis de un parámetro como puede ser el mes (para extraer el informe de ventas mensual) tendrá un códico xml como el siguiente:

<parameter name="mes" class="java.lang.String"> <property name="input_type" value="select"/> <property name="dict_query" value="java:comp/env/jdbc/aperte-reports; select distinct(ven_mes), ven_mes as displayed_username from jas_ventas"/> </parameter>

Vista de iReport: código XML con la sintaxis indicada para los parámetros.


7.- Conclusiones

Mediante Aperte Reports podemos integrar informes realizados en iReports de Jasper en nuestro portal de Liferay. Estos informes deben tener un código XML adaptado (en la definición de los parámetros) para que puedan ser leídos en nuestro sistema.

La funcionalidad que nos presenta Aperte con los informes incluye:

• Inclusión de los informes dentro de Liferay y visualización a través del portlet de dashboard.

• Gestión y exportación de los informes a formatos CSV, Excel, HTML y PDF desde el portlet invoker (y desde el manager).

• Posibilidad de generar informes en background y cíclicos (no válido si se utiliza Tomcat como servidor de aplicaciones).

En la página siguiente se muestra el código del report utilizado como ejemplo en este manual.


<?xml version="1.0" encoding="UTF-8"?> <jasperReport xmlns="http://jasperreports.sourceforge.net/jasperreports" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://jasperreports.sourceforge.net/jasperreports http://jasperreports.sourceforge.net/xsd/jasperreport.xsd" name="04_2011Quat3_Mes_P.jrxml" language="groovy" pageWidth="595" pageHeight="842" columnWidth="555" leftMargin="20" rightMargin="20" topMargin="20" bottomMargin="20"> <property name="ireport.zoom" value="1.0"/> <property name="ireport.x" value="0"/> <property name="ireport.y" value="218"/> <style name="Title" fontName="Times New Roman" fontSize="50" isBold="true" pdfFontName="Times-Bold"/> <style name="SubTitle" forecolor="#736343" fontName="Arial" fontSize="18"/> <style name="Column header" forecolor="#666666" fontName="Arial" fontSize="12" isBold="true"/> <style name="Detail" fontName="Arial" fontSize="12"/> <style name="Row" mode="Transparent"> <conditionalStyle> <conditionExpression><![CDATA[$V{REPORT_COUNT}%2 == 0]]></conditionExpression> <style backcolor="#E6DAC3"/> </conditionalStyle> </style> <parameter name="datasource" class="java.lang.String" isForPrompting="false"> <parameterDescription><![CDATA[java:comp/env/jdbc/aperte-reports]]></parameterDescription> </parameter> <parameter name="mes" class="java.lang.String"> <property name="input_type" value="select"/> <property name="dict_query" value="java:comp/env/jdbc/aperte-reports; select distinct(ven_mes), ven_mes as displayed_username from jas_ventas"/> </parameter> <queryString> <![CDATA[select * from jas_ventas where ven_mes = $P{mes} order by ven_idZona]]> </queryString> <field name="ven_idEntrada" class="java.lang.Integer"/> <field name="ven_idEmpresa" class="java.lang.Integer"/> <field name="ven_nomEmpresa" class="java.lang.String"/> <field name="ven_anyo" class="java.lang.Integer"/> <field name="ven_mes" class="java.lang.String"/> <field name="ven_idComercial" class="java.lang.Integer"/> <field name="ven_nomComercial" class="java.lang.String"/> <field name="ven_idZona" class="java.lang.Integer"/> <field name="ven_nomZona" class="java.lang.String"/> <field name="ven_cifra" class="java.lang.Float"/> <field name="ven_idMes" class="java.lang.Long"/> <variable name="ven_cifra_1" class="java.lang.Float" calculation="Sum"> <variableExpression><![CDATA[$F{ven_cifra}]]></variableExpression> </variable> <background> <band height="802" splitType="Stretch"> <image> <reportElement x="0" y="289" width="555" height="513"/> <imageExpression><![CDATA["D:\\Liferay\\imagenes\\jaspersoftlogobackground.jpg"]]></imageExpression> </image> </band> </background> <title> <band height="65" splitType="Stretch"> <staticText> <reportElement x="149" y="10" width="404" height="32"/> <textElement textAlignment="Center"> <font size="20" isBold="true"/> </textElement> <text><![CDATA[INFORME DE VENTAS POR MES]]></text> </staticText> <staticText>

Liferay Jasper

Documents

Transcript of Liferay Jasper