Explicacin del modulo Alfresco Business Reporting

Explicacin del modulo Alfresco Business Reporting

1.Introduccin.......................................................................................................................... 3
2.Alfresco Business Reporting................................................................................................4
2.1.Instalacin del mdulo Alfresco Business Reporting en Alfresco..................................4
2.2.Instalacin de Pentaho Reporting Designer..................................................................5
3.Manos a la obra................................................................................................................... 7
3.1.Configurar Alfresco Business Reporting para crear tablas de reportes.........................7
3.2.Disear un reporte simple con Pentaho Reporting Designer........................................8
3.3.Catalogar un reporte en Alfresco Business Reporting................................................11
4.Mas informacin.................................................................................................................13

Pgina 2

Explicacin del modulo Alfresco Business Reporting

1.Introduccin
El presente documento tiene como finalidad, explicar el funcionamiento, instalacin,
configuracin bsica y puesta en marcha del mdulo Alfresco Business Reporting para una
instalacin de Alfresco Community 4.2.c, en ningn momento se comentaran temas
avanzados de configuracin o funcionamiento sobre Alfresco, Alfresco Business Reporting o
Pentaho Designer.
Este documento tambin asume que el lector posee conocimientos bsicos sobre SQL,
herramientas de reportes y el lenguaje de consulta Lucene. El no conocimiento de algunas
de estas tecnologa no es motivo para pensar que el lector no sea capaz de utilizar el
mdulo Alfresco Business Reporting, sin embargo, sera necesario por parte del lector, leer
sobre estos temas para poder entender mejor los puntos que no se explican en este
documento.
Para realizar las pasos de instalacin y configuracin de Alfresco, Alfresco Business
Reporting, sera necesario que el lector tenga instalado Java 7 y un cliente de
administracin para MySQL.

Pgina 3

Explicacin del modulo Alfresco Business Reporting

2.Alfresco Business Reporting

El mdulo de Alfresco Business Reporting es un proyecto alojado en Code Google y se
distribuye bajo la licencia GPL 3, el mdulo, tal como cuenta su creador, se creo con la
finalidad de facilitar la creacin de reportes con los datos almacenados y generados en un
repositorio de Alfresco. Para lograr el objetivo planteado el mdulo nos brinda herramientas
para:
1. Trasladar la informacin almacenada en Alfresco a una base de datos relacional,
esto lo realiza creando un puente entre la ejecucin de consultas Lucene en el
repositorio de Alfresco y el almacenamiento de los resultados de la ejecucin de
dichas consultas en una base de datos.
2. Catalogacin, planificacin de la ejecucin y sustitucin de parmetros de los
reportes, esto lo realiza utilizando la especializacin (aplicacin de aspectos) de
documentos que se almacenan en determinadas carpetas del modulo.

2.1.Instalacin del mdulo Alfresco Business Reporting en Alfresco

Para instalar el mdulo primero tendremos que descargar los archivos:
1. alfresco-business-reporting-explorer-0.8.0.3.amp 1Este archivo, contiene el core del
modulo y deber ser instalado en el archivo alfresco.war
2. alfresco-business-reporting-share-0.8.0.3.jar Contiene la configuracin de formularios
en Alfresco Share y se ubicara en la carpeta de extensiones de Share.
Despus de descargado los archivos deberemos seguir los siguientes pasos:
1. Instalar el archivo alfresco-business-reporting-explorer-0.8.0.3.amp en el archivo
alfresco.war, para ello abra una consola del sistema y dirjase a la carpeta donde se
encuentra el SDK de Alfresco y ejecute el siguiente comando:
java -jar alfresco-mmt.jar install /RUTA/AMP/alfresco-business-reporting-explorer0.8.0.3.amp /RUTA/WAR/alfresco.war -verbose -nobackup -force
Comando para instalar el archivo AMP en el repositorio de Alfresco

2. Luego copie el archivo alfresco-business-reporting-share-0.8.0.3.jar en la carpeta

de web-extension que se encuentra contenida en la carpeta shared de tomcat,
para realizar esto, dirjase a la carpeta donde esta el archivo alfresco-businessreporting-share-0.8.0.3.jar y ejecute el comando:
cp

alfresco-business-reporting-share-0.8.0.3.jar

/RUTA/TOMCAT/shared/classes/alfresco/web-extension/
Copiar el archivo jar a la carpeta de extensin de Alfresco Share

El numero de versin puede ser distinto al utilizado en este documento, en el presente documento
se tratara con la versin 0,8,3 del mdulo.

Pgina 4

Explicacin del modulo Alfresco Business Reporting

3. Abra una session en MySQL y cree la base de datos donde se debern almacenar
los datos obtenidos desde el repositorio, para ellos ejecute los siguientes comandos:
mysql -u USUARIO_MYSQL -p

Dentro de MySQL ejecute los siguientes comandos:

create database alfrescoreporting default character set utf8 collate utf8_bin;
grant all on alfrescoreporting.* to 'alfresco'@'localhost' identified by 'alfresco'
with grant option;
grant all on alfrescoreporting.* to 'alfresco'@'localhost.localdomain' identified by
'alfresco' with grant option;
Comandos para crear la BBDD para los reportes y dar permiso al usuario alfresco

4. Configurar la conexin JNDI a la base de datos, para esto edite el archivo

/RUTA/TOMCAT/conf/Catalina/localhost/alfresco.xml, si el archivo no existe crelo,
he incluya el siguiente contenido, debajo de la etiqueta Context del XML.
<Resource defaultTransactionIsolation="-1" defaultAutoCommit="true"
maxActive="5" maxIdle="3" initialSize="1"
username="alfresco" password="alfresco"
url="jdbc:mysql://localhost:3306/alfrescoreporting"
driverClassName="org.gjt.mm.mysql.Driver"
type="javax.sql.DataSource" auth="Container"
name="jdbc/alfrescoReporting"/>

Despus de realizar estos pasos, inicie tomcat, si la instalacin se ha realizado de manera

correcta al entrar a Alfresco, debera poder ver una carpeta con el nombre Reporting
ubicada debajo de la carpeta Diccionario de datos y tambin deberan existir tablas nuevas
en la base de datos que se creo en un punto anterior.

2.2.Instalacin de Pentaho Reporting Designer

Para realizar la instalacin de Pentaho Reporting Designer, dirijase a la direccion URL
http://reporting.pentaho.com/report_designer.php y descargue la ultima versin estable del
archivo prd-ce-X.Y.Z-stable.zip, despus de descargado descomprima el archivo en la
Pgina 5

Explicacin del modulo Alfresco Business Reporting

carpeta del usuario y ejecute el archivo report-designer.sh o report-designer.bat, si todo

esta correcto despus de ejecutar el archivo debera ver el editor de reportes de Pentaho.

Pgina 6

Explicacin del modulo Alfresco Business Reporting

3.Manos a la obra
Llegados a este punto, debemos tener todo lo necesario para crear y ejecutar reportes en
Alfresco, ahora mostraremos las tareas comunes que se deben realizar para incluir un
nuevo reporte en el modulo de Alfresco Business Reporting, para esto realizaremos las
explicaciones a modo de tutorial y asumiremos que se desea crear un reporte con datos que
no existen en la base de datos de Alfresco Business Reporting
Como se comento al principio de este documento, el modulo Alfresco Business Reporting
bsicamente nos ayuda a:
1. Trasladar la informacin de Alfresco a una base de datos relacional y.
2. Catalogar y ejecutar los reportes con cierta informacin.
Estos puntos los tenemos que tener en cuenta, porque ellos determinan los pasos bsicos
que debemos seguir para ejecutar los reportes, bsicamente lo que tendremos que hacer es
lo siguiente:
1. Definir que datos debe almacenar Alfresco Business Reporting en la base de datos.
2. Disear el reporte que utilizara los datos del punto anterior.
3. Almacenar el reporte creado en el paso anterior en Alfresco e indicarle al modulo
Alfresco Business Reporting como debe ejecutar el reporte y cual es su salida.

3.1.Configurar Alfresco Business Reporting para crear tablas de reportes

Antes de comenzar a disear nuestro reporte, tendremos que indicar al mdulo de reportes
como obtener los datos que queremos y donde debe almacenarlos, para realizar esto
tenemos los archivos harvestDefinitionLesFrequent y harvestDefinitionMoreFrequent
ubicados en la carpeta /Repositorio/Diccionario de datos/Reporting dentro del repositorio
de Alfresco, la diferencia entre los dos archivos esta en los tiempos en los que son
ejecutados por el mdulo de reportes, el primero se ejecutara por defecto todos los das a
las 23:50 y el segundo cada hora.
Una vez decido en que intervalo de tiempo se deben obtener los datos, debemos modificar
el
archivo
correspondiente
y
aadir
una
linea
con
la
estructura
NOMBRE_TABLA=CONSULTA_LUCENE, donde el NOMBRE_TABLA sera el nombre que queremos
que tenga la tabla en la base de datos y CONSULTA_LUCENE la consulta Lucene a
ejecutar para obtener los datos.
Asumamos, que deseamos obtener los datos de todos los tipos de documentos que poseen
el aspecto infoRad:radicado2 y que sean almacenados en una tabla con el nombre
radicados_todos y adems queremos que estos datos se refresquen cada hora en la base
de datos, para ello tendremos que descargar desde Alfresco el archivo
harvestDefinitionMoreFrequent incluir la linea
radicados_todos=ASPECT: infoRad:radicado
2

Este aspecto los poseen todos los documentos de tipo radicado (radicados de entrada, salida y
comunicaciones internas)

Pgina 7

Explicacin del modulo Alfresco Business Reporting

Despus de hacer esto subimos el archivo modificado como una nueva versin en Alfresco
Share, pasada una hora la tabla se creara y se poblara con los datos arrojados por la
consulta Lucene. Tambin se puede forzar la ejecucin del archivo, para ello tenemos que
iniciar sesin en Alfresco Explorer, ir hasta la carpeta /Repositorio/Diccionario de
datos/Reporting y hacer click en la opcin Fill Reporting Database que aparece debajo del
archivo.

Forzar ejecucin de relleno de tablas

3.2.Disear un reporte simple con Pentaho Reporting Designer

Antes de iniciar con el diseo del reporte, tendremos que configurar el diseador de reportes
para que sepa como obtener los datos del origen de datos JNDI, para eso editaremos el
archivo /HOME_USUARIO/.pentaho/simple-jndi/default.properties he incluiremos los
siguientes datos:
alfrescoReporting/type=javax.sql.DataSource
alfrescoReporting/driver=org.gjt.mm.mysql.Driver
alfrescoReporting/user=alfresco
alfrescoReporting/password=alfresco
alfrescoReporting/url=jdbc:mysql://localhost:3306/alfrescoreporting

Despus de modificar el archivo, abrimos Pentaho Reporting Designer, crearemos un

reporte en blanco y registraremos la conexin JNDI, para realizar esto haga click en el men
File->New, luego seleccione la pestaa Data que se encuentra al lado derecho de la
ventana, haga click con el botn secundario del ratn sobre Data Sets y seleccione la
opcin JDBC.

Pgina 8

Explicacin del modulo Alfresco Business Reporting

En la nueva ventana que se abre (JDBC Data Source), haga click en botn con el smbolo
+ del lado derecho.

En la nueva ventana que se abre, en Connection Name, incluya un nombre para la

conexin que esta creando, en el cuadro Connection Type seleccione la opcin Generic
database, en el campo Acces seleccione la opcin JNDI y en el campo JNDI Name
incluya alfrescoReporting, despus de hacer esto debera tener algo parecido a la imagen:

Pgina 9

Explicacin del modulo Alfresco Business Reporting

Para probar la conexin puede hacer click en el botn Test, si los ltimos pasos se han
realizado de manera correcta se mostrara un mensaje indicando que la conexin se realizo
con xito.
Despus de haber configurado la conexin, crearemos la consulta que debe ejecutar el
reporte para obtener los datos, para esto en la ventana JDBC Data Source, haremos click
sobre el icono + que se encuentra de lado derecho de la ventana, colocaremos un nombre
a nuestra consulta y luego haremos click al icono en forma de lpiz que esta al lado de la
etiqueta Query.

Pgina 10

Explicacin del modulo Alfresco Business Reporting

Al hacer click, en el icono de lpiz, se abrir una nueva ventana, en la parte inferior
izquierda, estarn listadas todas las tablas que existen en la base de datos,
seleccionaremos la tabla radicados_todos y la arrastraremos al lado derecho de la
ventana, seleccionaremos los campos que necesitamos y haremos click en OK, luego en la
ventana JDBC Data Source nos aparecer la consulta generada, hacemos click en el
botn Ok.
Despus de realizar el ultimo paso, los campos seleccionados aparecern al lado derecho
de la ventana, arrastraremos todos los campos al lado izquierdo en la seccin Details y
guardaremos el reporte en el disco.

3.3.Catalogar un reporte en Alfresco Business Reporting

Despus de crear el reporte, tendremos que subir el reporte al Alfresco e indicarle al
mdulo de reportes la periodicidad de ejecucin y donde debe dejar el resultado.
La manera de indicarle al modulo cada cuanto tiempo se debe ejecutar el reporte, es por
medio de carpetas contenedoras, al instalar el mdulo se crearan debajo de la carpeta
/Repositorio/Diccionario de datos/Reporting de Alfresco las siguientes carpetas
Nombre de la carpeta

Periodicidad

Daily

Todos los reportes contenido se ejecutaran diariamente

Hourly

Todos los reportes se ejecutaran cada hora

Monthly

Todos los reportes se ejecutaran cada mes

Weekly

Los reportes se ejecutaran semanalmente

Pgina 11

Explicacin del modulo Alfresco Business Reporting

Como se detalla en el cuadrado cada carpeta indica cuando se ejecutaran los reportes que
contiene, para este tutorial asumiremos que deseamos que el reporte debe ser ejecutado
cada, por lo que el reporte que creamos anteriormente lo subiremos a la carpeta Hourly.
Despues de subido el reporte, haremos click en la opcion de Editar propiedades del nodo.
En la nueva ventana, en el campo outputFormat seleccionaremos el formato en el que
deseamos el resultado, en el campo Target Path incluiremos lo siguiente RADICADOS/$
{yyyy}/${MM}/${dd} y en el campo targetNode seleccionaremos la carpeta Reports que
se encuentra en /Repositorio/Diccionario de datos/Reporting

Pgina 12

Explicacin del modulo Alfresco Business Reporting

4.Mas informacin
Este apartado agrupa una serie de enlaces tiles sobre temas y tecnologas, comentadas y
de las que no se hablan en profundidad este documento.
1. https://code.google.com/p/alfresco-business-reporting/ Pagina principal del proyecto
de Alfresco business
2. http://www.gnu.org/licenses/gpl.html Licencia GPL v3
3. http://www.oracle.com/technetwork/java/javase/downloads/index.html
descargar Java 7

Pagina

4. http://wiki.alfresco.com/wiki/Community_file_list_4.2.c Pagina
Alfresco Community 4.2.c, el SDK de Alfresco y otros mdulos.

descarga

de

para
de

5. http://wiki.alfresco.com/wiki/Module_Management_Tool Explicacin de la herramienta

de instalacin de archivos AMP en Alfresco
6. http://wiki.alfresco.com/wiki/Search#Lucene Documentacin sobre bsquedas en
Alfresco utilizando Lucene.
7. https://code.google.com/p/alfresco-business-reporting/wiki/AdvancedReportBuilding
Enlace con vdeos explicativos de como construir un reporte.

Pgina 13