PR Plataforma JasperServer Manual de instalación para JasperServer 3.5

(1)

PR-166-544-1000 – Manual de instalación para JasperServer

Edición: 01 1/16 _02/12/2009

PR-166-544-1000

Plataforma JasperServer

(2)

Edición: 01 2/16 _02/12/2009

00 | Control del documento

00.1 Información general

Funcional Técnico

Título PR-166-544-1000-MIA-01-20091026.doc

Jefe de proyecto Benjamín García Benjamín García

A revisar por Antonio Carro Antonio Carro

A aprobar por Antonio Carro Antonio Carro

00.2 Lista de distribución

Nombre Puesto Departamento e-mail Observaciones

Antonio Carro Gerente Treelogic

Consulting

antonio.carro@treelogic .com

Benjamín García Jefe de Proyecto

Treelogic Consulting

benjamin.garcia@treelo gic.com

Alfonso Fernández Consultor Senior Treelogic Consulting alfonso.fernandez@tree logic.com

00.3 Histórico de revisiones

Versión Fecha Departamento Autor Observaciones

1.0 26-10-2009 Treelogic Consulting Benjamín García 1.1 02-12-2009 Treelogic Consulting Benjamín García

00.4 Estado del documento

Versión Fecha Estado Responsable Firma

1.0 26-10-2009 Borrador Benjamín García

(3)

Edición: 01 3/16 _02/12/2009

01 | Índice

00 | Control del documento ... 2

00.1 Información general ... 2

00.2 Lista de distribución ... 2

00.3 Histórico de revisiones ... 2

00.4 Estado del documento ... 2

01 | Índice ... 3

02 | Introducción ... 4

03 | Instalación JasperServer ... 5

03.1 Introducción ... 5

03.2 Pasos a seguir ... 5

03.3 Iniciando sesión en JasperServer ... 10

03.4 Desinstalando JasperServer ... 11

04 | Instalación de la API ... 12

04.1 Introducción ... 12

04.2 Pasos a seguir ... 12

05 | Anexos ... 13

05.1 Procesos utilizados por la plataforma JasperServer ... 13

05.2 Arrancando y parando JasperServer ... 14

05.3 Ubicación de Logs ... 14

05.4 Iniciando sesión en MySQL ... 14

05.5 Backup MySQL ... 15

05.6 Configurando dataSources en JasperServer ... 15

05.6.1 Oracle ... 15

(4)

Edición: 01 4/16 _02/12/2009

02 | Introducción

En este manual se detallan los pasos a seguir para la instalación del servidor de informes JasperServer 3.5 y la API de invocación al mismo. Estas instrucciones son válidas para un Linux Debian 4.0 y OpenSuse 11.

(5)

Edición: 01 5/16 _02/12/2009

03 | Instalación JasperServer

03.1 Introducción

La instalación de JasperServer se efectuará conforme a los pasos definidos en el siguiente punto abriendo un terminal de acceso a la máquina sobre la que se realizará la instalación.

03.2 Pasos a seguir

A continuación se describen los pasos seguidos para la instalación del sistema: 1. Añadir un nuevo grupo de seguridadmysql al sistema.

groupadd mysql

2. Descargar el instalador de la versión 3.5 de JasperServer. Para esto utilizaremos el comando Wget:

Wget http://sourceforge.net/projects/jasperserver/files/JasperServer/JasperServer %203.5.0/ jasperserver-3.5.0-linux-installer.bin/download

Ilustración 1. Descargar instalador

3. Aceptar licencia. Finalizada la descarga acceder a la ruta en la que se ha descargado el instalador y ejecutar el siguiente comando:

./jasperserver-3.5.0-linux-installer.bin

(6)

Edición: 01 6/16 _02/12/2009

Tras la ejecución de este comando se mostrará el contrato de licencia el cual tiene que aceptar para continuar con la instalación, mostrándose una pantalla de confirmación como la que se muestra en la siguiente ilustración:

Ilustración 2. Aceptar licencia

4. Indicar directorio de instalación. Se indica el directorio de instalación del servidor de informes, por defecto /opt/jasperserver-3.5.0 ([rootInstallServer] en adelante).

Ilustración 3. Indicar directorio instalación

5. Configurar la instalación. Una vez indicado el [rootInstallServer] se continuará con la configuración del modo de instalación de Apache Tomcat y MySQL, el instalador en ambas ocasiones permite elegir si deseamos instalar ambos productos a partir de los bundles que incluye o bien utilizar los productos previamente instalados de forma

(7)

Edición: 01 7/16 _02/12/2009

independiente. La opción seleccionada en este caso es la primera, con lo que se instalarán las versiones de Apache Tomcat 5.5 y MySQL 5.0 incluidas en el instalador, seleccionando la primera opción en la ventana de confirmación tanto para Tomcat como para MySQL.

Ilustración 4. Configurando instalación

Durante la configuración de estos dos pasos se nos indicará el puerto de instalación de Tomcat y MySQL. La opción seleccionada en este caso ha sido la asignación de puertos por defecto, el puerto 8080 para Tomcat y 3306 para MySQL. El usuario de acceso por defecto a MySQL es jasperdb con la contraseña password.

(8)

Edición: 01 8/16 _02/12/2009

En el siguiente paso se indicará si se desean instalar datos de ejemplo los cuales hemos optado por instalar.

Ilustración 6. Instalando ejemplos

A continuación se indica la posibilidad de instalar iReport 3.5.0, una herramienta gráfica para el diseño de informes. Se opta por su instalación.

Ilustración 7. Instalando iReport

6. Instalar JasperServer 3.5.0. Finalizada la configuración se procederá a la instalación del servidor de informes previa confirmación por parte del usuario.

(9)

Edición: 01 9/16 _02/12/2009

Ilustración 8. Confirmando instalación

7. Fin de la instalación. Una vez finalizada la instalación podremos acceder al servidor de informes del siguiente modo:

http://[host]:8080/jasperserver/

Donde [host] indica la máquina en la que hemos instalado el servidor.

Ilustración 9. Página inicial JasperServer

Por último y opcionalmente, se podría añadir al arranque del sistema un script que nos permita parar y arrancar el servidor de informes JasperServer.

(10)

PR-166-544-1000 – Manual de instalación para JasperServer Edición: 01 10/16 _02/12/2009 #!/bin/sh # Inicia el JasperServer case "$1" in 'start') /opt/jasperserver-3.5.0/jasperctl.sh start ;; 'stop') /opt/jasperserver-3.5.0/jasperctl.sh stop ;; *)

echo "Usage: $0 { start | stop }" ;;

esac exit 0

03.3 Iniciando sesión en JasperServer

Una vez finalizada la instalación y validado el correcto funcionamiento del servidor podremos iniciar sesión en JasperServer accediendo a través de la URL http://[host]:8080/jasperserver/ donde [host] representa la máquina en la que se ha instalado el servidor y 8080 es el puerto configurado para Apache Tomcat.

Si no ocurre ningún problema, aparecerá la página inicial de acceso en la que el usuario podrá autenticarse en el sistema introduciendo los siguientes datos:

Usuario: jasperadmin (Usuario administrador) Contraseña: jasperadmin

Si se ha optado por instalar los datos de ejemplo adicionalmente se crearán nuevos usuarios finales. Estos usuarios no son usuarios administradores con lo que tienen menos privilegios que el usuario administrado, los datos de acceso son los siguientes:

Usuario: joeuser Contraseña: joeuser

(11)

Edición: 01 11/16 _02/12/2009

03.4 Desinstalando JasperServer

El directorio de instalación [rootInstallServer] incluye un ejecutable que permite desinstalar el servidor de informes JasperServer. Para su utilización debe ubicarse en el directorio de instalación [rootInstallServer] y ejecutar el siguiente comando:

./uninstall

Se le preguntará si desea eliminar JasperServer del sistema con lo que para completar la desinstalación deberá presionar la tecla Y.

(12)

Edición: 01 12/16 _02/12/2009

04 | Instalación de la API

04.1 Introducción

La instalación de la API desarrollada para la invocación al servidor JasperServer se llevará a cabo conforme a los pasos definidos en el siguiente punto.

04.2 Pasos a seguir

A continuación se describen los pasos necesarios para la instalación de la API:

1. Ubicar el .jar de la API (es.xunta.edu.jasperserver.api.jar) en un directorio origen, por defecto hemos seleccionado /opt/api ([rootInstallAPI] en adelante)

2. Ubicar las dependencias de la API en la ruta [rootInstallAPI]/libs .

3. Los scripts para la ejecución de los comandos de la API estarán almacenados en

[rootInstallAPI]/scripts. Copiar los ".sh" a esta carpeta. 4. Definir las siguientes variables de entorno en el sistema:

JAVA_HOME='[directorio jdk_1.5]’ PATH=$PATH:${JAVA_HOME}/bin JRE_HOME=${JAVA_HOME}/jre JASPERSERVER_API='/opt/api/es.xunta.edu.utils.jasperserver.api-x.x.x.jar ' JASPERSERVER_USER='jasperadmin' JASPERSERVER_PASSWORD='jasperadmin'

Donde [jdk_1.5] indica el directorio donde se encuentra ubicada la jdk_1.5. Si realizamos la instalación de la API y el servidor Jasper Server en la misma máquina en la ubicación indicada por defecto, podremos definir la variable JAVA_HOME como se describe a continuación:

(13)

Edición: 01 13/16 _02/12/2009

05 | Anexos

05.1 Procesos utilizados por la plataforma JasperServer

Se han monitorizado el número de procesos que ejecuta JasperServer tanto en condiciones normales como en condiciones de saturación. Estos procesos no varían según la carga de trabajo que tenga la plataforma y pueden observarse ejecutando el comando ps de unix.

Ilustración 10. Procesos en ejecución

Los procesos lanzados por JasperServer son tres y pueden identificarse en la lista de procesos activos por los siguientes valores bajo la columna CMD:

/bin/sh /opt/jasperserver-3.5.0/mysql/bin/mysqld_safe /opt/jasperserver-3.5.0/mysql/bin/mysqld

/opt/jasperserver-3.5.0/java/bin/java

Durante la realización de este estudio no se ha observado ningún hilo ni proceso en estado inconsistente (Stopped o Zombie). Si, en algún caso, fuese necesaria la interrupción manual de algún hilo o proceso, esto podría lograrse utilizando el comando de Linux: Kill -9 pid (siendo pid el identificador del proceso).

(14)

Edición: 01 14/16 _02/12/2009

05.2 Arrancando y parando JasperServer

Para restaurar el sistema, la plataforma cuenta con un script (jasperctl.sh) dentro del directorio de instalación jasperserver-3.5.0 que permite arrancar y parar todo el entorno. Los comandos a ejecutar para el arranque y la parada del sistema serían los siguientes:

./ jasperctl.sh start ./ jasperctl.sh stop

05.3 Ubicación de Logs

Dos son los archivos log a observar para el control de errores. El primero registra los errores pertenecientes al servidor JasperServer. El segundo, es el log asociado al API. Las rutas donde se encuentran estos logs son las siguientes:

Log JasperServer: [rootInstallServer]/apache-tomcat/webapps/jasperserver/ WEB-INF/logs/jasperserver.log. Puede configurarse el nivel de depuración modificando el fichero log4j.properties desde la ubicación [rootInstallServer]/apache-tomcat/webapps/jasperserver/WEB-INF/log4j.properties, por defecto jasperServer solo muestra información sobre errores y avisos.

Log API: [rootInstallAPI]/scripts/logfile.log. Puede configurarse el nivel de depuración modificando el fichero log4j.properties incluido en el archivo log4j-1.2.12.jar.

Adicionalmente pueden consultarse los logs del servidor de aplicaciones (por defecto en la ubicación [rootInstallServer]/apache-tomcat/logs/) y de la base de datos instalada para obtener información sobre el propio JasperServer.

05.4 Iniciando sesión en MySQL

Por defecto se instala un MySQL que contiene el modelo de datos de la plataforma JasperServer, puede acceder a él desde la línea de comandos utilizando el usuario jasperdb

del siguiente modo:

<mysql>/bin/mysql -u jasperdb -p or <mysql>/bin/mysql -u root -p

(15)

Edición: 01 15/16 _02/12/2009

05.5 Backup MySQL

Se recomienda para salvaguardar los datos almacenados realizar periódicamente copias de seguridad de la base de datos.

La copia de seguridad podrá realizarse utilizando el comando mysqldump. La sentencia a ejecutar sería mysqldump -u<username> -p<password> <database name> > <output file>. Para restaurar una copia de seguridad será necesario ejecutar: mysql u<username> -p<password> <database name> < <input file>.

Una buena práctica es crear un script y ejecutarlo regularmente a través de cron o de cualquier otra herramienta de planificación de tareas.

05.6 Configurando dataSources en JasperServer

05.6.1 Oracle

Para configurar la plataforma de generación de informes JasperServer permitiendo la creación de dataSources en Oracle 10 tenemos que realizar los siguientes pasos:

1. Copiar el archivo ojdbc14.jar en la ubicación [rootInstallServer]/apache-tomcat/common/lib para que el servidor pueda cargar el driver JDBC de Oracle. Este paso es necesario tanto para el acceso a datasources mediante jdbc como jndi, los siguientes pasos recogen la configuración para datasources jndi.

2. Editar el fichero context.xml ubicado en la ruta [rootInstallServer]/apache-tomcat/webapps/jasperserver/META-INF añadiendo el siguiente recurso

<Resource name="jdbc/oracleDS" auth="Container" type="javax.sql.DataSource" driverClassName="oracle.jdbc.OracleDriver"

url="jdbc:oracle:thin:@[host]:1521:[dbName]"

username="user" password="pass" maxActive="100" maxIdle="30" maxWait="10000"/>

Donde [host] indica la ip de la máquina en la que se ha instalado Oracle y [dbName] el nombre de la base de datos.

3. Editar el fichero web.xml ubicado en la ruta [rootInstallServer]/apache-tomcat/webapps/jasperserver/WEB-INF añadiendo la siguiente configuración:

(16)

Edición: 01 16/16 _02/12/2009

<resource-ref>

<description>Oracle Datasource example</description> <res-ref-name>jdbc/oracleDS</res-ref-name>

<res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth>

</resource-ref>

4. Una vez finalizada esta configuración se podrán crear dataSources cuyo origen sea Oracle haciendo uso del script correspondiente (ver manual de usuario).

06 | Referencias

Puede obtener mas información sobre la instalación y administración de JasperServer 3.5 consultando la guía de instalación JasperServer-Install-Guide.pdf incluida en los entregables en el apartado Documentación.