ATLAS MANUAL DE USUARIO COMPONENTES JSF BUSINESS OBJECTS XI Versión 1.1 Área de Aplicaciones Especiales y Arquitectura de Software 9
Hoja de Control Título Documento de Referencia Responsable ICM Versión 1.1 Fecha Versión Registro de Cambios Versión Causa del Cambio Responsable del Cambio Fecha del Cambio 1.0 Versión inicial del documento Área de Aplicaciones Especiales y Arquitectura de Software 12/03/2010 Las preguntas frecuentes se 1.1 consultarán en el portal de Área de Aplicaciones Especiales y 05/07/2011 arquitectura. Arquitectura de Software Se modifica el nombre del área Página 2 de 12
Índice 1. INTRODUCCIÓN... 4 1.1. AUDIENCIA OBJETIVO... 4 1.2. CONOCIMIENTOS PREVIOS... 4 2. INSTALACIÓN Y CONFIGURACIÓN... 5 2.1. INSTALACIÓN... 5 2.2. CONFIGURACIÓN... 5 3. USO... 7 3.1. COMPONENTES BUSINESS OBJECTS... 7 3.2. COMPONENTES CRYSTAL REPORTS... 8 4. PREGUNTAS MÁS FRECUENTES... 10 5. ENLACES RELACIONADOS... 11 Página 3 de 12
Contenido 1. INTRODUCCIÓN El presente documento contiene el manual de integración y uso de los componentes JSF de Business dentro de una aplicación web Atlas. 1.1. Audiencia objetivo El lector objetivo de este documento debe ser todo aquel que necesite hacer uso de los componentes JSF de BO dentro de una aplicación web Atlas. 1.2. Conocimientos Previos Para una completa comprensión del actual documento, se recomienda tener un conocimiento medio de las siguientes tecnologías: Lenguaje Java Java Server Faces (JSF) Facelets Extensible Markup Language (XML) Apache Maven Business 2008 Para saber más sobre dichas tecnologías, consultar los accesos referenciados en el apartado 0 de este documento, Página 4 de 12
ENLACES RELACIONADOS. Página 5 de 12
2. INSTALACIÓN Y CONFIGURACIÓN A lo largo de este apartado se especifica como configurar una aplicación web Atlas 2 para que pueda hacer uso de los componentes JSF de Business Objects. 2.1. INSTALACIÓN La instalación de las librerías necesarias para la utilización de los componentes JSF es bastante simple, únicamente es necesario establecer en el fichero pom.xml de la aplicación web una dependencia hacia el proyecto dependenciasjsf. Basta con copiar y pegar el fragmento de código que se muestra a continuación: Pom.xml <dependency> <groupid>atlas.bo</groupid> <artifactid>dependenciasjsf</artifactid> <version>${versionaespecificar}</version> </dependency> 2.2. CONFIGURACIÓN La librería de componentes de BO no está preparada para ser utilizada a través de Facelets de forma directa. Es necesario, por tanto, dar uno pasos previos a su uso dentro de una aplicación web Atlas. Facelets provee de un mecanismo de extensibilidad a partir de la carga de librerías de componentes. Facelets carga, por defecto, las librerías de MyFaces y JSTL, sin embargo otras librerías deben ser cargadas explícitamente. Como por ejemplo, Tomahawk. Para indicar a Facelets que debe cargar una librería adicional se debe especificar dentro del fichero web.xml alojado bajo el directorio WEB-INF de la aplicación web. Dentro de este fichero se debe localizar una variable de contexto con identificador facelets.libraries y especificar como valor, la ruta de los ficheros descriptores de las librerías de componentes de Business Objects. Por ej. web.xml... <context-param> <param-name>facelets.libraries</param-name> <param-value>/web-inf/bobj-jsf.taglib.xml; /WEB-INF/jsfviewer.taglib.xml <param-value> </context-param> Página 6 de 12
... Como se aprecia en el fragmento de código anterior, los ficheros que describen los componentes JSF de Business Objects para Facelets son: bobj-jsf.taglib.xml jsfviewer.taglib.xml Siempre que se especifique más de un fichero descriptor de librerías, deben separarse las rutas, mediante un símbolo de punto y coma ( ; ), tal y como aparece en el fragmento de código de la Error! No se encuentra el origen de la referencia.. Estos ficheros han sido creados ad-hoc para poder utilizar los componentes con Facelets. Se pueden encontrar en el directorio META-INF del jar de dependencias JSF mencionado previamente, en el apartado de INSTALACIÓN. Deben ser extraídos y situados en alguna parte de la aplicación web para posteriormente poder ser referenciados en el fichero web.xml como puede verse en el fragmento de código de la Error! No se encuentra el origen de la referencia.. Es ese ejemplo los ficheros están situados en el directorio WEB-INF. Dentro del directorio META-INF también se encuentra el fichero descriptor de la gramática utilizada para definir los ficheros descriptores de librerías en Facelets, facelet-taglib_1_0.dtd. Este fichero debe ser situado en el mismo directorio donde se coloquen los ficheros descriptores de los componentes BO. Página 7 de 12
3. USO Una vez ha sido configurado el entono para la utilización de los componentes JSF de BO, es necesario indicar, en cada página donde quieran ser usados, cual es el espacio de nombres asociado a cada librería. Descripción URI Prefijo Componentes Business Objects http://www.businessobjects.com/jsf/enterprise boe Visor Crystal Reports http://www.businessobjects.com/jsf/crystalreportsviewers bocrv El uso de Facelets se está realizando junto a xhtml, la definición de un nuevo espacio de nombres dentro de una página xhtml debe hacerse de la siguiente forma: Fichero.xhtml <html xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" xmlns:atlas="http://atlas.core.componentes/jsf"... xmlns:boe="http://www.businessobjects.com/jsf/enterprise" xmlns:bocrv="http://www.businessobjects.com/jsf/crystalreportsviewers"> En el fragmento anterior se puede apreciar que, además de definir los espacios de nombres para las librerías de componentes de Business Objects, aparecen los asociados a Facelets, JSF y Componentes Atlas. 3.1. Componentes Business Objects Business Objects provee un conjunto de componentes para realizar diversas tareas muy concretas y comunes sobre el repositorio de BO. A continuación se muestra la lista de componentes junto a una breve descripción. Nombre changepassword destination itemsgrid itemscolumn Descripción Genera un formulario HTML que permite modificar la contraseña BO del usuario. Genera un formulario HTML que permite al usuario especificar el destino de salida de un trabajo planificado. Genera una tabla HTML que muestra los items de un bean de tipo EnterpriseItem o EnterpriseItems. Subetiqueta de itemsgrid que genera una columna de una tabla HTML que muestra una propiedad de un bean EnterpriseItem o EnterpriseItems. Página 8 de 12
logon path reportdatabaselogon reportfilters reportformat reportparameters reportprint schedule Genera un formulario HTML que permite al usuario autenticarse y asociarse a una sesión Business Objects Enterprise. Genera un conjunto de enlaces Genera un formulario HTML que permite al usuario autenticarse en una bb.dd. de la que el informe recupera la información. Genera un formulario HTML que permite al usuario especificar, grabar y agrupar fórmulas de selección para recuperar y filtrar en la bb.dd. los registros de un informe. Genera un formulario HTML que permite al usuario especificar el tipo de formato de los objetos que van a ser planificados. Genera un formulario HTML que permite al usuario especificar parámetros que pertenecen a un informe particular. Genera un formulario HTML que permite al usuario especificar las opciones de impresión para un informe. Genera un formulario HTML que permite al usuario crear una planificación para un objeto Business Objects. Facelets xmlns:boe="http://www.businessobjects.com/jsf/enterprise" JSF <%@ taglib uri="http://www.businessobjects.com/jsf/enterprise" prefix="boe" %> 3.2. Componentes Crystal Reports Crystal Reports proporciona un visor de informes muy completo. Nombre reportpageviewer Descripción Genera una página DHTML que muestra un informe Cristal Reports. Facelets xmlns:bocrv="http://www.businessobjects.com/jsf/crystalreportsviewers" JSF Página 9 de 12
<%@ taglib uri="http://www.businessobjects.com/jsf/crystalreportsviewers" prefix="bocrv" %> Página 10 de 12
4. PREGUNTAS MÁS FRECUENTES La lista de preguntas frecuentes se encuentra en el portal de arquitectura. Página 11 de 12
5. ENLACES RELACIONADOS Producto url Plataforma Java Spring MyFaces (JSF) Facelets Maven XML Business Objects http://java.sun.com http://www.springframework.org http://myfaces.apache.org https://facelets.dev.java.net/ http://maven.apache.org http://www.w3schools.com/xml/default.asp http://help.sap.com/businessobject/product_guides/ Página 12 de 12