ATLAS MANUAL DE USUARIO DEL ARQUETIPO WEB CON DOCUMENTUM

Transcripción

1 ATLAS MANUAL DE USUARIO DEL ARQUETIPO WEB CON DOCUMENTUM Versión 1.4 Área de Aplicaciones Especiales y Arquitectura de Software

2 Hoja de Control Título Documento de Referencia Responsable Manual de usuario del Arquetipo Web con Documentum NORMATIVA ATLAS Área de Aplicaciones Especiales y Arquitectura de Software Versión 1.4 Fecha Versión 27/09/ Revisado/Validado por: Fecha Revisión/Validación 2 Aprobado por: Fecha Aprobación Registro de Cambios Versión Causa del Cambio Responsable del Cambio Fecha del Cambio 1.0 Versión inicial del documento Área de Integración y Arquitectura de aplicaciones 25/05/ Nueva configuración de arquetipo web Incluida creación previa del arquetipo de proyecto Apartado 3.4: Nueva configuración de URLs de servicios de documentum 1.3 Modificaciones para ATLAS Las preguntas frecuentes se Área de Integración y Arquitectura de 16/09/2010 Aplicaciones Área de Integración y Arquitectura de 08/11/2010 Aplicaciones Área de Integración y Arquitectura de 15/02/2011 Aplicaciones consultarán en el portal de Área de Aplicaciones Especiales y /07/2011 arquitectura. Arquitectura de Software Cambio del nombre de área 2 de 14

3 Índice 1. INTRODUCCIÓN AUDIENCIA OBJETIVO CONOCIMIENTOS PREVIOS REQUISITOS PREVIOS INFORMACIÓN SOBRE EL ARQUETIPO CREACIÓN DE UNA APLICACIÓN PARTIENDO DEL ARQUETIPO ESTRUCTURA DEL ARQUETIPO ESTRUCTURA DE DIRECTORIOS Y ARCHIVOS Módulo web Módulo test CONFIGURACIÓN DE LA APLICACIÓN PARA ACCESO A DOCUMENTUM DESPLIEGUE Y EJECUCIÓN DE LA APLICACIÓN VISUALIZACIÓN DE LA APLICACIÓN DESPLEGADA, Y COMPROBACIÓN DE LA CONECTIVIDAD CON DOCUMENTUM PREGUNTAS MÁS FRECUENTES ENLACES RELACIONADOS de 14

4 1. INTRODUCCIÓN Los arquetipos son las plantillas para la generación de los distintos proyectos dentro del Framework Atlas. Estos arquetipos utilizan el plugin archetype de maven para generar la estructura de ficheros y directorios necesarios para nuestro proyecto, gestionando las librerías que le indiquemos así como las dependencias. Todas las librerías serán incluidas durante el empaquetado del proyecto, por lo que para generar y compilar un arquetipo debe estar conectado al repositorio de artefactos de la Comunidad de Madrid (Artifactory). El framework Atlas consta de los siguientes arquetipos: - Arquetipo para inicio de proyecto - Arquetipo para módulos de tipo web - Arquetipo para módulos de tipo jar. - Arquetipo para módulos de tipo webservice o servicios web - Arquetipo para módulos de tipo batch - Arquetipo para módulos de gestión documental (documentum) Básicamente, el arquetipo de gestión documental es un arquetipo web al que se ha añadido la configuración del gestor documental, y algunas pantallas que interaccionan con Documentum (utilizando los componentes visuales que Atlas proporciona para ello). En este documento no se repetirán todos los temas que coincidan con el arquetipo web normal, se hará referencia a la documentación de este arquetipo en los puntos donde así proceda. Al igual que el arquetipo web, el arquetipo Documentum genera un proyecto web multimodular (esto significa que cuando lo generamos estamos generando un proyecto con varios módulos). El submódulo web es un proyecto de tipo war, que incluye la implementación del negocio de la aplicación y está preparado para desplegar la vista con JSF; el submódulo test es un proyecto web réplica (solo en cuanto a configuración) del modulo web y preparado para realizar las pruebas de integración y carga de la parte web (en otro contexto de servidor de aplicaciones) AUDIENCIA OBJETIVO Este documento está dirigido a desarrolladores de proyectos java para ICM en los que se desee crear una aplicación web que interaccione con Documentum utilizando el framework Atlas CONOCIMIENTOS PREVIOS Para un completo entendimiento del documento, el lector deberá tener conocimientos previos sobre las siguientes tecnologías: 4 de 14

5 - Java - Eclipse - Maven - Spring Framework. - Hibernate - JSF - Documentum Además, es necesario haber leído y seguido los pasos del ATLAS_MUS_Preparacion_Entorno_Desarrollo, así como el manual ATLAS_MUS_Arquetipo_Web ya que el arquetipo de Documentum es una réplica de este con las modificaciones necesarias para la integración con Documentum. 2. REQUISITOS PREVIOS Para integrar una aplicación web con Documentum pueden utilizarse varias implementaciones distintas del interfaz. Dependiendo de la implementación elegida nos encontraremos con los siguientes requisitos previos de configuración para poder conectar con Documentum: - A través de un servicio web (atlasfrm-gdoc-api-wsclient-lib). Esta implementación es la recomendada, y la que viene habilitada por defecto al generar un arquetipo. Para poder utilizarla es necesario tener instalado correctamente el servicio web de acceso a Documentum proporcionado por ICM. - Implementación de pruebas (atlasfrm-gdoc-api-demo-impl-lib): Implementación para pruebas que simula un servidor existente, no requiere conexión con ningún servidor de Documentum externo. Esta es una implementación de prueba para comprobar la integración de los componentes de Documentum pero que no permite el desarrollo de una lógica de negocio completa. - A través del API de Documentum (atlasfrm-gdoc-api-spring-documentum-impl-lib): Esta implementación viene desactivada por defecto en arquetipo, pero puede activarse descomentando una dependencia incluida en el fichero pom.xml. Para poderla utilizar es necesario disponer de los datos de conexión a un servidor de Documentum para poder conectar con él. 5 de 14

6 3. INFORMACIÓN SOBRE EL ARQUETIPO 3.1. Creación de una aplicación partiendo del arquetipo NOTA IMPORTANTE Antes de generar un arquetipo es IMPRESCINDIBLE haber generado un arquetipo para albergar el proyecto (consultar el documento ATLAS_MUS_Preparacion_Entorno_Desarrollo para ver cómo crear un arquetipo de proyecto). Cualquier arquetipo posterior será incluido como un módulo de éste. Crear un proyecto Web con Documentum a partir de un arquetipo es similar a la creación de un proyecto Web normal, sólo es necesario cambiar el nombre del arquetipo a utilizar. Para crear un proyecto a partir de un arquetipo Maven puede consultar la guía paso a paso que se indica en el documento ATLAS_MUS_Preparacion_Entorno_Desarrollo, según se indica en el apartado Creación de una aplicación Web desde cero, sustituyendo atlasfrm-arquetipos-generador-web por atlasfrm-arquetipos-generadordocumentumweb. Desde Eclipse seleccionamos el arquetipo correspondiente, y seguimos con los pasos según se muestranen el manual indicado. 6 de 14

7 3.2. Estructura del arquetipo La estructura del arquetipo generado es similar a la de un arquetipo Web, por lo que en este apartado sólo se muestran las diferencias entre el arquetipo de Documentum y el Web normal Estructura de directorios y archivos Una vez creado el proyecto nos generara una serie de directorios a estilo Maven, donde ubicaremos los fuentes y recursos de las partes de test y aplicación web. En los siguientes apartados se muestran las diferencias principales de este arquetipo con el arquetipo Web en cada uno de sus módulos Módulo web Existen las siguientes diferencias en la estructura de directorios y ficheros: En este directorio se han añadido las siguientes clases al arquetipo web Entidad de dominio que representa un Documento. No se corresponde físicamente con una tabla de base de datos porque los datos de los documentos se obtienen de Documentum. Clases de utilidad de uso general utilizadas para la implementación de Documentum. Servicio de Documentum y su implementación Backing Bean de la página del listado de documentos. 7 de 14

8 Servicio utilizado para importar y modificar documentos Ficheros xhtml de las páginas de Documentum (listado de documentos, detalle de documento y nuevo documento). Documento de configuración de beans de jsf para las páginas de Documentum Módulo test Existen las siguientes diferencias en la estructura de directorios y ficheros: Documento de configuración de beans de jsf para los tests de las páginas de Documentum Configuración de la aplicación para acceso a Documentum Para configurar la conexión con Documentum será necesario modificar unos u otros archivos de configuración, dependiendo de la implementación elegida: 1. Implementación a través de servicios web (atlasfrm-gdoc-api-wsclient-lib): La ruta de acceso al servicio se configurará en el fichero src/main/resources/environment.properties, en la variable gdoc.url.ws: # Configuración de los servicios web de Documentum gdocconsulta.endpoint= gdocgestioncarpetas.endpoint= gdocgestiongrupos.endpoint= gdocgestiontablas.endpoint= gdocgestiondoc.endpoint= 2. Implementación simulación de gestor documental (atlasfrm-gdoc-api-demo-impl-lib): No es necesaria ninguna configuración. 8 de 14

9 3. Implementación a través del API de Documentum (atlasfrm-gdoc-api-spring-documentum-impl-lib): Es necesario editar el fichero src/main/resources/dfc.properties para configurar la conexión con el servidor. Un ejemplo de fichero de configuración es el siguiente: dfc.data.dir=c:/documentum (modificar según la instalación) dfc.globalregistry.password=************************* (solicitar a ICM). dfc.globalregistry.repository=desadocu (confirmar con ICM) dfc.globalregistry.username=dm_bof_registry dfc.registry.mode=windows dfc.search.ecis.enable=false dfc.search.ecis.host= dfc.search.ecis.port= dfc.session.secure_connect_default=try_native_first dfc.tokenstorage.dir=c:/documentum/apptoken (modificar según la instalación) dfc.tokenstorage.enable=false dfc.docbroker.host[0]=icmcs03 (confirmar con ICM) dfc.docbroker.port[0]= Despliegue y Ejecución de la aplicación El arquetipo web genera un proyecto multimodular, esto significa que cuando lo generamos estamos generando un proyecto con al menos dos módulos (test y web). Para construir el proyecto debe ejecutarse el siguiente comando desde el POM padre del proyecto generado: mvn clean install También puede ejecutarse Maven desde Eclipse. En ese caso, es importante que la casilla Resolve Workspace artifacts no esté activada, si lo está es posible que Maven produzca un error de ejecución del estilo: Could not explode webapp. Por defecto, al ejecutar Maven con los parámetros clean install se genera el war correspondiente a la aplicación. Para desplegar el war en nuestro servidor de aplicaciones podemos coger el fichero de la carpeta en la que se ha generado (web/target/nombrefichero.war), o podemos utilizar un servidor Jetty local que viene preconfigurado en el arquetipo. Para ejecutar directamente un servidor jetty con nuestro proyecto desplegado, debemos ejecutar la siguiente línea de comandos desde el directorio web de nuestro proyecto la siguiente línea de comandos: mvn jetty:run 9 de 14

10 Esto arranca un servidor jetty en el puerto 9080 de nuestra máquina, en el que se encuentra desplegado el war de nuestra aplicación. Si en lugar de un servidor jetty queremos construir y desplegar en un servidor WebLogic definido por el usuario, consultar el manual del arquetipo web Visualización de la Aplicación Desplegada, y comprobación de la conectividad con Documentum. Si hemos utilizado el servidor jetty que viene preconfigurado con el arquetipo, podemos acceder a nuestra aplicación utilizando un browser, accediendo a la URL: En caso de que todo haya funcionado correctamente, aparecerá una pantalla de login: 10 de 14

11 Por defecto debido a la política de seguridad de pruebas que viene configurada en el arquetipo, se puede acceder con el usuario y contraseña usuario_ok/usuario_ok. Al autenticarnos con este usuario, aparecerá la pantalla principal de ejemplo del arquetipo de Documentum: Desde esta pantalla, podemos pulsar sobre la opción de menú Documentos, para comprobar que la aplicación se conecta correctamente a Documentum. Si todo es correcto, aparecerá la pantalla con el listado de documentos: 11 de 14

12 Pulsando sobre cualquiera de los documentos del listado podemos acceder a la pantalla de detalle del documento: 12 de 14

13 4. PREGUNTAS MÁS FRECUENTES La lista de preguntas frecuentes se encuentra en el portal de arquitectura. 13 de 14

14 5. ENLACES RELACIONADOS Producto Apache Maven Ajax4JSF Facelets Hibernate Hibernate Annotations JSF JSFUnit MyFaces Core RichFaces Spring Spring Security URL de 14