manuales adempiere manual... · web viewofb manual adempiere-jasper v5.docx versión 5 página 12...

Ofb Consulting

Manuales ADempiere

Manual de IReport

MANUAL DE USUARIO – USO DE IREPORT

Fase Tarea DescripciónPos implantación Manual de Usuario Uso de IReport

Tipo de Documento: Documento informativo

Objetivo del Documento: Crear reportes con el aplicativo IReport

Seguimiento Documento:Versió

nDescripción Autor (es) Revisado por Fecha

Revisión126

Versión 1Versión 2Versión 6

Italo Niñoles

José Leyton G.

Alberto AbudinenJulio Farías 2011

ContenidoI. Descripción general..................................................................................................3II. Conectar IReport a la Base de datos.....................................................................4III. Crear estructura del reporte.................................................................................6

Construcción base del reporte.....................................................................................6Elegir un Formato.....................................................................................................6Definir nombre y lugar..............................................................................................7Construir la consulta.................................................................................................7Campos a mostrar....................................................................................................8Agrupar campos.......................................................................................................9

Diseñar el Reporte.....................................................................................................10IV. Visualizar Reporte...............................................................................................13V. Cargar los reportes en Adempiere......................................................................14

Preparar servidor de Adempiere................................................................................14Agregar el módulo “webApp”.................................................................................14Crear la carpeta “webApp”.....................................................................................14

Crear proceso Jasper en Adempiere...........................................................................14Crear proceso Jasper adjunto (Recomendado)...........................................................16Agregar el proceso a una ventana.............................................................................17

VI. Creación de Parámetros.....................................................................................19Tipos de parámetros..................................................................................................20

FORMATO A: $P{Nombre_Parámetro}....................................................................20FORMATO B: $P!{Nombre_Parámetro}...................................................................20

Añadir parámetros en Adempiere..............................................................................22VII. Creación de gráficos...........................................................................................23

document.docx Versión 5 Página 1 de 35



Series Expresión (required):....................................................................................25Category Expresión (required):...............................................................................25Value Expresión (required):....................................................................................25




I. Descripción generalEn este manual se explicará de manera sencilla la creación de reportes por

medio del aplicativo IReport. Para esto se necesitan 3 pasos fundamentales:

1. Conectar el IReport a la base de datos deseada.2. Crear la estructura del reporte3. Pre visualizar el reporte para ver los resultados.




II. Conectar IReport a la Base de datos

Para comenzar a usar IReport debemos definir a que base de datos nos vamos a conectar para luego realizar los reportes basados en esta. IReport cuenta con “Wizards” para poder guiarte en los distintos pasos para usar IReport.

Cuando uno abre IReport le aparece la ventana de Bienvenida en donde aparecen los 3 pasos antes mencionados, para nuestro caso usaremos el Step 1 (Paso 1) que es el Wizard para la conexión a la base de datos, esta nos permitirá hacer las conexiones que deseemos a las bases de datos que tengamos.




Una vez le demos clic al Wizard del Step 1 aparecerá la ventana para la conexión a la base de datos:

En esta ventana se define qué tipo de base de datos es a la que nos vamos a conectar o donde vamos a trabajar nuestros reportes. En nuestro caso usaremos la primera opción “Database JDBC conection”. Una vez teniendo eso ya definido presionamos siguiente (Next).

Nos aparecerá la ventana en donde debemos colocar los datos específicos de la base de datos a la cual nos vamos a conectar, comenzando con el Nombre de la conexión que estamos creando (Podemos tener muchas conexiones creadas a distintas bases de datos), en nuestro caso le colocaremos Reporte Prueba. Ademas del nombre de la conexión también debemos definir los controladores de la base de datos y la dirección de esta. En este caso como es una base de datos de PostgresSQL se elegirá el driver “PostrgeSQL (org.postgresql.Driver)” y la dirección para la base de datos es “jdbc:postgresql://localhost:5432/erp”.

Obviamente también nos pide el usuario y la clave de la misma base de datos las cuales son “adempiere”. Grabamos (Save) y se crea nuestra conexión.




III. Crear estructura del reporte

Una vez hecha la conexión con la base de datos a trabajar ya se puede empezar a crear el reporte. Al igual que el paso anterior, este tiene un Wizard el cual nos guía a crear nuestro reporte.

Construcción base del reporte

Elegir un Formato

En el wizard podemos ver que hay distintos formatos de reportes prediseñados con los cuales poder empezar a trabajar, además de definir el tamaño y posición de este.

En nuestro caso elegiremos un diseño en blanco tamaño carta.




Una vez escogido el formato debemos dar clic en Launch Report Wizard para empezar a crear el contenido de nuestro reporte.




Definir nombre y lugar

Es necesario colocar un nombre al reporte y el lugar donde será guardado este en donde creará los archivos que genera IReport. En nuestro caso lo llamaremos “Facturas Emitidas”.

Al presionar siguiente (Next) pasaremos a la ventana en donde se creará nuestra base del reporte.

Construir la consulta

Aquí es donde escogeremos la conexión a la base de datos que anteriormente creamos en donde se aplicará la consulta SQL que nos pide el reporte.

En la parte




superior de la ventana aparecerá un listado con todas las conexiones creadas y abajo tenemos el cuadro de texto donde construiremos la consulta de nuestro reporte. Abajo también tenemos 3:

_ Design query: este botón nos abrirá una ventana en donde podemos construir de manera más “Gráfica” nuestro reporte (al igual que muchos sistemas de gestión de base de datos).

_ Load query: Para cargar una consulta ya guardada en SQL. Herramienta muy útil para los que ya tienen las vistas de sus reportes hechas en formato .sql o .txt.

_ Save query: botón para guardar la consulta hecha.

Una vez ya definido la conexión a usar y el SQL de la consulta presionamos siguiente.

Campos a mostrar

Si bien en la consulta ya definimos que campos queríamos mostrar IReport te permite escoger que campos usaremos en el reporte a construir. En esta ventana hay 4 botones los cuales tienen la función de agregar y/o quitar campos de manera masiva o individual. En nuestro caso elegiremos todos los campos.

Una vez escogidos los campos que usaremos en el reporte presionamos “Next” para ir a la siguiente ventana.




Agrupar campos

También tenemos la opción de agrupar nuestros campos para mostrar de una manera más ordenada los datos. Esto es porque IReport manea los grupos con diseños distintos para dar una mejor experiencia visual.

Como pueden ver, se pueden realizar hasta 4 niveles de agrupamiento. En el caso de nosotros no usaremos agrupamientos así que nos saltaremos esta ventana para finalizar con la construcción de la base del reporte.

En la siguiente ventana solo se coloca finalizar para empezar con la construcción gráfica del reporte.




Diseñar el Reporte

Una vez ya tengamos la base del reporte creada ya solo nos queda diseñarlo, o sea crear el enterno gráfico en donde se pondrán los campos que anteriormente seleccionamos y para esto IReport maneja una serie de elementos que nos pueden ayudar a una mejor experiencia de diseño para los reportes.

Una hoja de reportes en IReport Designer por defecto está dividida en 7 secciones las cuales son: título, cabecera de la página, cabecera de los campos, detalle, pie de los campos, pie de página y resumen. En esas secciones es donde debemos ir colocando nuestros elementos ya sea una imagen, un texto, una tabla, un código de barra, un campo etc. Estos elementos estarán disponibles en una Paleta de herramientas para trabajar.

Áreas de la página de trabajo y Paleta de herramientas y elementos

Estas áreas o secciones de la hoja son modificables en tamaño y además pueden agregar otras áreas (en el caso de detalle).


Título

Cabecera de la página

Cabecera de las columnasDetalle

Pie de las columnas

Pie de la página

Resumen



Para colocar algún elemento a nuestra hoja de reporte solo hace falta arrastrar dicho elemento y colocarlo donde uno quiera, después podrá modificarlo con el panel de herramientas de arriba o bien ir a las propiedades del elementos para hacer cambios más específicos.

Esto mismo también se puede hacer con los campos de nuestro reporte solo que se obtienen de otra ventana llamada “Report Inspector” y los campos se ven en el aparcado Fields (Campos).


Panel de Herramientas

Propiedades del elemento ->

Arrastrar

Arrastrar



Si debemos nuevamente editar nuestro consulta porque nos faltó un campo o los cálculos y la funcionalidad no es la correcta, se debe presionar el botón que está en la parte superior en el Panel de Herramientas para que se les habrá el editor de SQL en donde podremos modificar los campos a mostrar y la funcionalidad de nuestro Reporte.


Aquí se puede editar la consulta

Presionando este botón nos desprenderá abajo los datos que trae la consulta.



IV. Visualizar ReporteUna vez que tengamos el diseño del reporte listo lo que queda por hacer es ver

cómo va quedando. Esto lo podemos hacer yendo a la pestaña “Preview” en la ventana del diseño del reporte.

Una vez escojamos esta opción IReport comenzará a generar el reporte. Este proceso puede tardar dependiendo de la complejidad de la consulta realizada.

Una vez procesado el reporte generará la vista previa y ya estará completado nuestro Reporte.




V. Cargar los reportes en Adempiere

Preparar servidor de Adempiere

Cuando ya tengamos el reporte probado y listo, este ya estaría disponible para ser cargado a Adempiere. Pero antes hay que hacer algunos pasos para poder visualizarlo en Adempiere, estos pasos se hacen “ANTES” de levantar el servidor. Estos pasos son los siguientes:

Agregar el módulo “webApp” Para que Adempiere cargue o reconozca los archivos Jasper (jrxml) de cualquier equipo conectado al servidor, estos deben estar en algún lugar en la red. Por eso es necesario crear un módulo en el servidor para que lo levante como servicio, a este servicio lo llamaremos “webApp”. Este módulo se crea modificando un código que se encuentra en \Adempiere\jboss\server\adempiere\deploy\adempiere.ear\META-INF donde encontramos el archivo llamado application.xml. En él se pueden ver todos los modulos que levanta el servidor, lo que haremos es agregar el módulo que necesitamos. El código que se agrega es el siguiente:

<module><web>

<web-uri>webApp.war</web-uri><context-root>/webApp</context-root>

</web></module>

Crear la carpeta “webApp”Lo otro que debemos hacer es cargar o colocar los archivos .jrxml que vamos a usar en Adempiere, estos se deben almacenar en la carpeta “webApp.war” en la ubicación \Adempiere\jboss\server\adempiere\deploy\adempiere.ear\. Una vez hecho esto ya se puede levantar el servidor.

Es importante recalcar que el archivo “application.xml” es un archivo nativo de Adempiere y es necesario editarlo cada vez que corra el proceso de “configuracion” (RUN_Setup), ya que este deja este archivo a su estado natural, o sea sin el modulo que agregamos.

Crear proceso Jasper en Adempiere

Una vez tengamos el servidor arriba y con los cambios antes señalados se debe agregar el proceso que nos creara el reporte Jasper en Adempiere. Para crear el proceso hay que agregar una clase de JAVA que hace referencia a este tipo de reportes, la clase es “org.compiere.report.ReportStarter”. Esta clase se debe




agregar en el campo “Nombre de Clase” en la ventana “Informe y proceso”. Siguiendo con la creación del proceso se debe agregar el archivo Jasper (jrxml) que se va a usar, como es un archivo en red se debe colocar el nombre de red del servidor o la IP de este para que todos los equipos que vayan a usar el reporte puedan visualizarlo. Entonces la forma de colocarlo es: http://192.168.0.108:1024/webApp/prueba.jrxml. Esta dirección se coloca en el campo “Reporte Jasper de la misma ventana”.

Una vez hecho todo esto, agregamos el proceso al menú como Reporte y podremos ver si se cargó correctamente o no:


http://192.168.0.108:1024/webApp/prueba.jrxml



Crear proceso Jasper adjunto (Recomendado)

Existe otra forma de cargar un reporte Jasper en adempiere el cual simplifica mucho el hecho de tener que colocarlo en una carpeta y llamarlo del proceso, además este modo de cargar el reporte nos deja el reporte en la misma base de datos y si hacemos un respaldo de esta ya vendría con el reporte integrado.

Esta forma de cargar el reporte jasper consiste en “Adjuntar” el archivo Jasper (jrxml) en el mismo “Proceso” donde se usará este, por ende la llamada no será a una dirección en nuestro equipo sino que al archivo adjunto del proceso tal.

Adjuntar el archivo jrxml al proceso se realiza de la misma forma en como adjuntamos una imagen o pdf a un documento.




Lo único que cambia en el proceso (además de que debe tener el jasper adjunto) es la llamada, la cual será: attachment:[nombre jasper].jrxml




Agregar el proceso a una ventana

El proceso Jasper también se puede usar para predeterminar el proceso de una ventana (cuando se quiera imprimir desde la ventana). Esto sirve para predeterminar la impresión de una “Pestaña” de la ventana para que aparezca la información del Jasper antes elaborado.

Primero debes ir a la ventana y a la pestaña en la cual vas a ejecutar el proceso que deseas, y luego en el campo “Proceso” debes seleccionar el proceso Jasper que elaboraste

Listo esto ya podemos probarlo en la pestaña señalada para ver cómo quedó:




VI. Creación de Parámetros Una de las grandes cualidades de iReport es el funcionamiento de los

parámetros en los reportes, ya que estos al tener un carácter “dinámico” se pueden hacer varias combinaciones y filtrados de información.

Una de las formas para crear un parámetro en iReport, es en la misma ventana donde generamos el “Query” (consulta), justo donde está el botón “New Parameter”. Ahí podemos seleccionar el nombre, tipo y valor por defecto del parámetro:




Tipos de parámetros

Los parámetros de Jasper, pueden ser de 2 tipos, siendo referenciados dentro del informe Jasper con un formato distinto para cada tipo.

FORMATO A: $P{Nombre_Parámetro}

Este parámetro podrá ser utilizado tanto en el Select, como en cualquier variable calculada o en las diferentes expresiones Java que Jasper permite introducir.

La ventaja de este sistema es que como el parámetro tiene un tipo, cualquier expresión Java que utilice el parámetro podrá ser comprobada por Jasper cuando se compile el informe, y por tanto se nos informará de todos los errores cuando este se compile.

Se pueden crear tantos parámetros de tipo $P{Nombre_Parámetro} como se necesiten en el informe.

Para estos parámetros opcionales existe la posibilidad de escribir el WHERE del Select de la siguiente forma, suponiendo que "mes" es un parametro opcional y su valor por defecto se ha fijado a "null": to_char(ci.dateinvoice,’MM’) = COALESCE($P{mes},to_char(ci.dateinvoice,’MM’))

Este "método" NO funcionará bien cuando la columna en cuestión (ci.dateinvoice) admita el valor NULL, en cuyo caso NO se debe utilizar este sistema.

El método anterior se basa en que el parámetro $P{mes} tiene valor por defecto "null", por lo que cuando no se pasa $P{mes} se queda a null y como la función SQL COALESCE devuelve el primer valor no nulo, devolverá el segundo parámetro reduciéndose la condición a to_char(ci.dateinvoice,’MM’) = to_char(ci.dateinvoice,’MM’), que es una operación trivial que devuelve siempre verdadero (TRUE)... excepto cuando el valor de “to_char(ci.dateinvoice,’MM’)” sea NULL, porque en SQL se considera que “NULL = NULL” no devuelve Verdadero sino que devuelve NULL, el resultado es que aquellas filas que contengan NULL se pierden porque no pueden satisfacer la condición.

La solución en este caso pasa por utilizar la otra forma alternativa de parámetros que tiene JasperReports, el formato B.

FORMATO B: $P!{Nombre_Parámetro}

Este parámetro se da de alta como un parámetro normal, pero deberá tener siempre el tipo de valor "java.lang.String" y el valor por defecto a "". Lo que cambia es la forma de referenciarlo en el informe que será siempre como $P!{Nombre_Parámetro}.

Los parámetros $P!{Nombre_Parámetro} se interpretan antes que los parámetros $P{Nombre_Parámetro}, por tanto, en teoría, es posible que la cadena que pasemos como valor de $P!{Nombre_Parámetro} contenga a su vez expresiones que deban ser posteriormente calculadas o pasadas desde otra fuente. Se supone que




podríamos llegar a incluir un parámetro de formato A $P{Nombre_Parámetro} dentro del valor que pasemos a una cadena de formato B $P!{Nombre_Parámetro}.

Los parámetros $P!{Nombre_Parámetro} permiten modificar la cadena SQL que sirve de base para el informe. En concreto pueden contener:

La totalidad de la sentencia SQL en la que se basa el informe: en ese caso el informe solo contiene en su cláusula base: $P!{Cadena_SQL}

Una clausula completa de las que compone una sentencia SQL, como por ejemplo "ORDER BY 1,2" o "WHERE TO_CHAR(ci.dateinvoice,’MM’) = ’02’ "

Una parte de alguna cláusula de las que compone una sentencia SQL, por ejemplo (dentro de la cláusula WHERE) "AND TO_CHAR(ci.dateinvoice,’MM’)= ‘02’ ".

Para utilizar esta última solución, en la sentencia SQL debemos añadir un parámetro $P!{CadenaWhereOpcional} al final de la cláusula WHERE:

Cuando el usuario no especifique un valor para el campo opcional "mes", el parámetro $P!{CadenaWhereOpcional} se pasará como cadena vacía (“”) y cuando el usuario rellene por ejemplo el parámetro opcional "mes" con el valor "02" el parámetro $P!{CadenaWhereOpcional} tomará el valor "AND TO_CHAR(ci.dateinvoice,’MM’) = ’02’ "

Un ejemplo de esto último es lo que se hizo en el parámetro “where_mes” en el siguiente reporte:




En esta sentencia estamos diciendo que si el parámetro “mes” ($P(mes)) es igual a “null” este me devuelva “”, sino, que me devuelva “AND TO_CHAR(ci.dateinvoiced,’MM’=”+$P(mes). Eso hará que si no escogemos algo en el parámetro “mes” entonces no agregará texto en el parámetro “where_mes”.




Para colocar después el parámetro creado en el reporte, es tan simple como solo arrastrar el nombre del elemento al script del Query, tal como lo muestra la siguiente imagen:

Una vez teniendo los parámetros bien definidos en Jasper se deben crear en Adempiere.

Añadir parámetros en Adempiere

Al igual que cualquier reporte de Adempiere, en los reportes Jasper también se pueden colocar Parámetros para tener nuestro nivel de filtrado de la información. Y para agregarlos es de la misma forma de la que regularmente creamos los parámetros, sin embargo esta vez en el campo donde tienes que colocar el “Nombre de Columna en BD” debes colocar el nombre del Parámetro Jasper que creamos en el iReport.

Una vez hecho esto ya tienes el reporte Jasper con parámetros listo para ser usado en Adempiere.

NOTA: recuerda que los tipos de datos de Adempiere deben coincidir con el del reporte Jasper, ejemplo donde hay un parámetro tipo cadena es porque en Jasper está definido como texto (string) o cuando es un ID (numero) es porque en Jasper es BigDecimal etc.


Arrastrar



VII. Creación de gráficosLa creación de gráficos en Jasper es una de las tantas herramientas útiles que

iReport nos ofrece. Con una interfaz bastante fácil de usar en cuanto a su modelación se pueden realizar reportes de más calidad visual.

Para insertar un gráfico en un reporte Jasper hay que tener claro en qué zona del documento es que se ubican estos elementos. Como un gráfico es un resumen de una información x e y esta solo se puede colocar en la sección SUMARY de nuestro “Template”, y la forma de colocarlo ahí es la misma con la cual se colocan todos los elementos al reporte “Arrastrándolo”. El icono para los gráficos es el llamado “Chart” en la “Paleta de Elementos”.

Una vez colocado el gráfico hay que configurar los ejes X e Y. Esta función se realiza en el aparcado “Chart Data” que aparece cuando le damos clic derecho al grafico insertado.




Una vez allí verán una ventana donde aparecerán las características del gráfico en una pestaña y en la otra el detalle de los datos que va a tener nuestro gráfico.

En esta ventana es donde vamos a colocar las “series” que va a tener nuestro gráfico. Para agregar una nueva serie solo hay que presionar Add y Remove para eliminar una.

Para crear una serie debemos tener claro cuál es la función de cada campo que nos pide la ventana que a continuación aparece:




Series Expresión (required): En este campo se define la expresión que se usara para definir cada “Serie” que

tendrá el elemento del eje X.

Category Expresión (required): En este campo se define la expresión que se usará para presentar los conjuntos

“X” de datos en el gráfico.

Value Expresión (required): En este campo se define la expresión del valor que tomará la serie especificada

(eje Y).

En mi ejemplo especifique la serie “Ventas” con el grupo de categoría por “Vendedor” y con el valor de las “Ventas” de cada uno de ellos.




El reporte de este gráfico en Adempiere quedó así:

Y si aplicamos un filtro por mes (ejemplo diciembre) aparecerá así:




VIII. Estilos (Styles)Los estilos en iReport nos permiten mantener un formato predeterminado como parámetro para ser usado en cualquier elemento del jasper. Estos formatos no solo están orientados a textos sino que a TODO elemento que pueda tener parámetros de visualización y estilo. Por ejemplo se pueden definir una fuente, color y tamaño de letra para un texto, el margen de una celda para una tabla, el grosor de las líneas de una figura y hasta la rotación y formato del elemento.Estos estilos se crean en la opción “Styles” del panel izquierdo del iReport. Al dar clic derecho encima de esta opción seleccionamos “Agregar” y nos creará nuestro estilo que podremos usar mas adelante. Las propiedades se configuran igual como configuramos cualquier otro campo en iReport, modificando sus propiedades.

Estilos Condicionales

Esta función que tiene iReport nos permite crear un estilo para algún campo de manera condicional, o sea, que al momento de que se cumpla dicha condición se aplique un formato al campo al cual le apliquemos el estilo. Por ejemplo se puede usar para colocar en color rojo cuando un número sea menor a 0 indicando perdida o pintar el fondo del campo indicando algo destacado dependiendo de algún parámetro o variable dentro del reporte.Este se crea dentro de un estilo ya creado. Al igual que crear un estilo se le da clic derecho al estilo al cual le queremos agregar esta condición y seleccionamos la opción “Agregar Conditional Style”


manuales adempiere manual... · web viewofb manual adempiere-jasper v5.docx versión 5 página 12...

Documents