UNIVERSIDAD DE OVIEDO

Transcripción

1 UNIVERSIDAD DE OVIEDO ESCUELA POLITÉCNICA DE INGENIERÍA DE GIJÓN PROYECTO FIN DE CARRERA "KONEKTI, LA PLATAFORMA PARA SOLUCIONES EMPRESARIALES" DIRECTOR: José Antonio Cancelas Caso AUTOR: Carlos Ignacio Salinas Gancedo Septiembre 2014

2 2 MEMORIA PRESENTADA POR D. Carlos Ignacio Salinas Gancedo PARA OPTAR AL TÍTULO DE INGENIERO TÉCNICO en Informática de Gestión

3 3 Índice Memoria Identificación del documento Visión general del proyecto Visión general del documento Documentos referenciados Documentos del proyecto Documentación de las herramientas de desarrollo Descripción del sistema Justificación de la realización del proyecto Realización del proyecto Descripción del producto Requisitos hardware Requisitos software Utilización de recursos Requisitos de memoria Requisitos de disco Documentos presentados Volumen I Volumen II... 9 Plan de desarrollo y presupuesto Identificación del documento Visión general del proyecto Visión general del documento Documentos referenciados Estimación de recursos necesarios Recursos hardware Recursos software Recursos humanos Planificación temporal Estudios previos Análisis Diseño Construcción Integración Documentación Presupuesto Presupuesto personal Presupuesto hardware y software Presupuesto total Especificación de requerimientos Identificación de documento Identificación del proyecto Visión general de la aplicación... 17

4 4 1.3 Visión general del documento Documentos referenciados Documentos del proyecto Documentos externos Especificación de requisitos del sistema Descripción del sistema actual Problemas y necesidades Catálogo del requisitos del sistema Requisitos funcionales Requisitos no funcionales Descripción de alternativas Especificación funcional del sistema Diagramas de casos de uso Modelo de dominio del sistema Modelo de la gestión de la organización Modelo de instalación de nuevos módulos Modelo de la gestión de direcciones Modelo de gestión de calendarios Modelo de gestión de datos de sensores Modelo de gestión de alarmas Modelo de gestión de informes Modelo de gestión de empleados Modelo de gestión de proveedores Modelo de gestión de clientes Diagrama de componentes Diagrama de componentes de la capa vista Diagrama de componentes de la capa negocio Diagrama de componentes de la capa de acceso a datos Diagramas de secuencia Diagramas de despliegue Interfaces de usuario Principal Administración de usuarios Administración de roles Instalación de módulos Gestión de la organización Gestión de direcciones Gestión de proveedores Gestión de empleados Gestión de clientes Gestión de calendarios Sensorización Gestión de alarmas Gestión de informes Manual de instalación Identificación del documento Visión general del proyecto Visión general del documento Documentos referenciados Documentos del proyecto... 46

5 5 2.2 Documentos externos Requisitos Requisitos hardware Requisitos software Recursos humanos Instalación Configuración Arrancar el sistema Mantenimiento Manual de usuario Identificación del documento Visión general del proyecto Visión general del documento Documentos referenciados Documentos de proyectos Documentos externos Manual de usuario Estructural general Los maestros Gestión de la organización Gestión de empleados Gestión de Clientes Gestión de Proveedores Gestión de productos Gestión de Stock Administración de la plataforma Instalación de módulos Gestión de calendarios Gestión de alarmas Gestión de informes Manual de programador Identificación del documento Visión general del proyecto Visión general del documento Documentos referenciados Documentos del proyecto Documentos externos Manual del programador Arquitectura Comunicación entre módulos Recursos necesarios Operaciones de modificación de software... 85

6 6 Memoria 1 Identificación del documento Este documento desarrolla la memoria del proyecto titulado Konekti, la plataforma para soluciones empresariales; de la Escuela Politécnica de Ingeniería de Gijón. 1.1 Visión general del proyecto Este proyecto tiene la finalidad de realizar una plataforma generalista por desarrolladores para desarrolladores, que permita acortar el ciclo de construcción de aplicaciones de gestión. Ofreciendo un conjunto de herramientas debidamente integradas, que cubren desde la presentación hasta la persistencia. También ofrece per se una serie de funcionalidades transversales a toda solución de gestión; como seguridad, administración de usuarios, impresión de informes, etc. 1.2 Visión general del documento En este documento se describen las características principales del proyecto y de la plataforma. Es decir, la descripción del sistema, capítulo 3, que incluye la justificación de su realización y la descripción detallada del Proyecto, la especificación de las necesidades de hardware y software y los recursos utilizados, capítulo 4, y por último, todos los documentos que se presentan en este Proyecto, capítulo 5. 2 Documentos referenciados 2.1 Documentos del proyecto En este documento no se hace referencia a ningún otro que pertenezca a este proyecto, aunque en su último capítulo se enumeran todos los documentos que forman el proyecto. 2.2 Documentación de las herramientas de desarrollo Pro Spring Dynamic Modules for OSGi Service Platforms. ASIN: B001WAJM4M Enterprise OSGi in Action: With examples using Apache Aries. ISBN- 10: OSGi in Action: Creating Modular Applications in Java. ISBN- 10: OSGi in Depth. ISBN- 10: X Learning Vaadin. ASIN: B005ZE0A8I Documentación de Eclipse Virgo

7 7 Especificaciones de la OSGi Alliance Documentación oficial de Vaadin 3 Descripción del sistema 3.1 Justificación de la realización del proyecto Dada mi experiencia en la ingeniería del software de gestión, entendí que los costes y el tiempo de desarrollo podían descender evitando dedicar tiempo a tareas como elegir e integrar las herramientas a utilizar o implementar funcionalidades que se repiten cada vez construimos un aplicativo software. Es por ello sería ventajoso para los programadores disponer de una plataforma que les proporcione todo el conjunto de herramientas tecnológicas, con las funcionalidades necesarias, tales como la seguridad, administración de usuarios, gestión de productos, y un largo etcétera. Además disponer de funcionalidades reutilizables, permitiría acortar, por tanto abaratar, la elaboración de soluciones empresariales y facilitar el acceso a técnicos más noveles. La plataforma Konekti ofrece al técnico una plataforma estructurada en varias capas, a saber: Capa de presentación Capa de inteligencia de negocio Capa de servicio Capa de Persistencia Esta estructura le proporciona a la plataforma una buena arquitectura para una solución de software empresarial. La integración entre ellas es posible por la integración de herramientas o frameworks, referencias en el sector. Es por tanto que programador, utilizando la plataforma, debe únicamente centrar sus esfuerzos en desarrollar aquella parte específica basada en Konekti, para alcanzar los requerimientos demandados por el proyecto o definidos por el mismo. 3.2 Realización del proyecto El objetivo del proyecto supone el estudio, análisis, diseño e implementación de una plataforma modular de código abierto basada en OSGi (Open Services Gateway Initiative) que permita la construcción, o también denominado verticalización, de sistemas de información con servicios empresariales. Para ello estará basado en las últimas tecnologías open source y siguiendo los estándares del mercado, otorgando a las soluciones resultantes las siguientes características: Interfaz web: siguiendo los estándares marcados por la W3C (World Wide Web Consortium), el sistema será accesible desde cualquier dispositivo, además de ser una

8 8 RIA (Rich Internet Applications) creando una experiencia de usuario propia de entornos de escritorio, pero en la web; aumentado así la productividad del usuario. Sistema modular: Apoyándose en el paradigma de la contribución, la plataforma será extensible y parametrizable, mediante el desarrollo de nuevos módulos que podrán ser instalados, agregando nuevas funcionalidades, todo ello sin tener que modificar partes de la plataforma y reiniciarla. Por este motivo la arquitectura está basada en la especificación para sistemas modulares en java, descrita por la OSGi Alliance. Servicios empresariales: Proporcionará los servicios más comúnmente demandados por el software empresarial. 4 Descripción del producto 4.1 Requisitos hardware Como en toda solución software de gestión orientada a la web debemos diferenciar entre un entorno de desarrollo y uno de producción. La diferencia entre ambos es que en el segundo se deben de cubrir unos requisitos de seguridad más exigentes y unos requisitos hardware mayores para soportar una mayor carga de trabajo debido al mayor tráfico de usuarios. Es por este motivo que, para un entorno de producción, se recomienda instalar un servidor web que redirija las peticiones del puerto 80 al servidor de aplicaciones. Minimizando la cantidad de puertos abiertos en servidor se aumenta así la seguridad. Si nos encontramos en un entorno de desarrollo el servidor debe tener acceso desde el exterior mediante TCP/IP, teniendo abierto un puerto para poder acceder a la interfaz de Konekti. Se suelen configurar el puerto La plataforma puede estar instalada en el mismo servidor donde este encuentra el gestor de bases de datos o en otra maquina distinta. El gestor instalado o DBMS pueden ser cualquier de los soportados por el framework de persistencia usado por la plataforma, Eclipselink. 4.2 Requisitos software En el servidor que ejecuta el plataforma sólo necesita estar instalado la Java Runtime Environment o JRE en su versión El sistema operativo instalador en el servidor es indiferente, pues el sistema al estar desarrollado en Java es lo que se denomina Cross Platform En cuanto a las máquinas clientes que quieran consumir Konekti deberán tener instalado un navegador web: Android 2.3 en adelante Google Chrome 13 en adelante Internet Explorer 6 en adelante ios 4 en adelante

9 9 Mozilla Firefox 3 en adelante Safari 4 en adelante Opera 10 en adelante 5 Utilización de recursos 5.1 Requisitos de memoria El consumo de memoria desde el lado del servidor está marcado por el volumen de sesiones abiertas, es decir, por el número concurrente de usuarios interactuando con el servidor. Del lado cliente está determinado por el navegador que el usuario utiliza para acceder al sistema. Para una número de entre 1 a 10 sesiones abiertas se estima un servidor de 4 Gigabytes de memoria. Para un número mayor se debería duplicar la memoria. 5.2 Requisitos de disco En el servidor la instalación de la plataforma, junto al servidor de aplicaciones EclipseRT Virgo y todas las librerías necesarias, está en los 300 megabytes aproximadamente. En el lado cliente no se considera el uso del disco local para la ejecución del programa, pues no requiere de ninguna instalación 6 Documentos presentados El proyecto está formado por los siguientes documentos: 6.1 Volumen I Memoria Plan de desarrollo Especificación de requerimientos Documento de diseño 6.2 Volumen II Manual de instalación Manual de responsable de sistemas Manual de soporte Manual de usuario Anexo I. Código fuente de la plataforma

10 10 Plan de desarrollo y presupuesto 1 Identificación del documento Este documento desarrolla el plan de desarrollo y presupuesto del proyecto titulado ; de la Escuela Politécnica de Ingeniería de Gijón. 1.1 Visión general del proyecto Este proyecto tiene la finalidad de realizar una plataforma generalista por desarrolladores para desarrolladores, que permita acortar el ciclo de construcción de aplicaciones de gestión. Ofreciendo un conjunto de herramientas debidamente integradas, que cubren desde la presentación hasta la persistencia. También ofrece per se una serie de funcionalidades transversales a toda solución de gestión; como seguridad, administrar usuarios, impresión de informes, etc. 1.2 Visión general del documento En este documento se describen la planificación temporal para la ejecución del proyecto y su coste. También se estiman los recursos humanos y hardware para su realización. 2 Documentos referenciados Ninguno 3 Estimación de recursos necesarios 3.1 Recursos hardware Unidad de cálculo basada en arquitectura x86 Mínimo 4 Gigas de RAM Mínimo 150 Megas de disco duro 3.2 Recursos software Java 6 SE Gestor de proyectos Maven Control de versiones Git Servidor de aplicaciones Eclipse RT Virgo Eclipse IDE for J2EE Developers en versión Kepler

11 11 Las extensiones o plugins de Eclipse IDE: M2E (Inegración con Maven), EGit (Integración con Git), Virgo Tooling y Vaadin Editor 3.3 Recursos humanos La plataforma Konekti puede albergar dos perfiles de desarrollador distintos. El que contribuye a Konekti expandiéndola con nuevas funcionalidades y el desarrollador de módulos nuevos basados en la plataforma. Ambos perfiles han de tener conocimientos en el lenguaje de programación java, y familiarizados con las herramientas usadas: Maven, Git, Vaadin y Eclipselink. Pero el primero necesita tener experiencia en OSGi, la arquitectura modular de la plataforma, mientras que el segundo le es abstraído de su complejidad. 4 Planificación temporal Comienza el día el 8 de enero de 2014 y terminando el 2 de junio de El calendario de trabajo diseñado, aparte de tener en cuenta los días de vacaciones incluidos en este intervalo, utiliza la jornada laboral normal, es decir, 40 horas semanales divididas de lunes a viernes, ambos inclusive.

12 12

13 13

14 Estudios previos Fase dedicada a realizar un estudio de viabilidad del proyecto, haciendo un estudio del mercado para buscar herramientas que cubriesen aquellas características que queríamos implementar: Modular, presentación Web usando lenguaje Java, arquitectura 3 Capas y Rich Internet Application. Encontrando como máximo competidor a Eclipse RAP, aunque este no facilita el desarrollo de la interfaz usando un único lenguaje, sino usando tecnologías web (HTML, Javascript y CSS). Obligando a los desarrolladores tener mas conocimientos previos, además de no ofrecer las funcionalidades básicas de la solución de gestión; como persistencia, administración de usuarios y seguridad. También en esta fase se elabora el diseño del presupuesto para su realización y la duración estimada. Finalmente la duración de esta fase es de 5 días laborales. 4.2 Análisis En esta fase basándose en el Análisis de requisitos del sistema, se elabora la Especificación funcional del sistema, en el que reúne todo lo que debe de implementar la plataforma en el ámbito funcional. La duración de esa fase es de 13 días, comenzando el 15 de enero al 31 de enero del Además determiné los subsistemas que componen la plataforma, definiendo las capas que conforman el sistema: Capa Dominio Capa Kernel Capa Vista Capa Servicio Capa DAL 4.3 Diseño En esta fase se diseña las APIs o Application Programming Interfaces para la correcta colaboración entre capas y la definición de las entidades que definen el dominio del sistema Esta fase dura 26 días, comenzando el 8 de febrero al 10 de marzo del Construcción La implementación de la plataforma se realiza en cascada, es decir, primero se implementa el dominio. Una vez que tenemos todas las entidades con sus propiedades definidas, implemento la capa encargada de controlar el ciclo de arranque de los distintos módulos del sistema, más adelante se implementa las interfaces que a través de las cuales los usuarios interactúan con las entidades. Luego mediante la capa de vista detectamos las necesidades a nivel de lógica que necesita aportar la capa de servicio. Más tarde se

15 15 dividirá la lógica en operaciones de persistencia que ha de implementar la capa DAL o capa acceso a datos. Esta fase del proyecto conlleva una carga de 22 días, comenzando el 11 de marzo al 9 de abril del Integración Fase final en la construcción. Se integran todos los módulos generados de manera independiente y se realiza el montaje final de todo el sistema para su puesta en funcionamiento. Esta fase dura 24 días, comenzando el 16 de abril y terminando el 19 de mayo del Documentación Aunque se genera distinta documentación a lo largo del proyecto, la realización de la documentación final para entregar al cliente se realiza una vez que el sistema está probado, ya que las pruebas pueden suponer la modificación de algunos aspectos de la aplicación. La fase dura 10 días, del 20 de mayo al 2 de junio. 5 Presupuesto 5.1 Presupuesto personal Tarea Duración (Horas) Euros/hora Coste (Horas) Estudios previos Análisis Diseño Construcción Pruebas Integración Documentación Total 35760

16 Presupuesto hardware y software Material Coste (Horas) Vida útil estimada Valor residual Amortizado Equipo MacBook Apple años Material didáctico formación y 200 Total Presupuesto total El presupuesto total calculado a partir de las partidas anteriormente especificadas es el siguiente: Presupuesto Presupuesto de Persona Presupuesto Hardware y Software Coste (Horas) Gastos Generales (13%) Beneficio industrial (6%) Impuestos (21%) Total

17 17 Especificación de requerimientos 1 Identificación de documento 1.1 Identificación del proyecto Este documento desarrolla la especificación de Requisitos de la aplicación titulada Konekti, La Plataforma para Soluciones Empresariales; de la Escuela Politécnica de Ingeniería de Gijón. 1.2 Visión general de la aplicación Este proyecto tiene la finalidad de realizar una plataforma generalista por desarrolladores para desarrolladores, que permita acortar el ciclo de construcción de aplicaciones de gestión. Ofreciendo un conjunto de herramientas debidamente integradas, que cubren desde la presentación hasta la persistencia. También ofrece per se una serie de funcionalidades transversales a toda solución de gestión; como seguridad, administrar usuarios, impresión de informes, etc. 1.3 Visión general del documento Este documento describe la especificación de requisitos empleando UML para hacer una descripción y las relaciones entre módulos componentes. En este documento se incluyen una serie de modelos basado en UML para establecer el comportamiento del sistema. El documento de Análisis de Requisitos del Sistema tiene como objetivo analizar y documentar las necesidades funcionales o de servicio que deberán ser soportadas por el sistema propuesto. Para ello se identificarán los requisitos que ha de satisfacer el nuevo sistema, mediante entrevistas y el estudio de los problemas y necesidades actuales. La Especificación Funcional del Sistema tiene como objetivo básico construir una especificación detallada del nuevo sistema, de forma que: Satisfaga las necesidades de información de los usuarios y los objetivos de la Unidad. Sirva de base para la construcción del sistema, adaptándose a las directrices técnicas y de gestión de la Unidad. Para conseguir este objetivo, se tomará como punto de partida el Catálogo de Requisitos del Sistema, elaborado en el módulo ARS, mediante mi experiencia previa y un estudio comparativo del mercado actual. Estos requisitos se incorporarán a la alternativa de solución seleccionada en ese módulo y se especificarán en detalle el nuevo sistema así definido. Se construirán modelo lógicos de procesos, datos y eventos; y se describirán los componentes de estos modelos.

18 18 2 Documentos referenciados 2.1 Documentos del proyecto Documento - Manual de usuario 2.2 Documentos externos Documentación de UML en la página oficial uml.org. 3 Especificación de requisitos del sistema 3.1 Descripción del sistema actual En la actualidad no existe en el mercado una plataforma que reúna la mismas características que queremos que tenga Konekti. 3.2 Problemas y necesidades Un inconveniente en el desarrollo de soluciones de gestión empresarial bajo el lenguaje Java es la necesidad de otras tecnologías para poder realizar la interfaz de usuario. Para hacer esta interfaz Web habitualmente se emplea html, javascript y css. Además son soluciones monolíticas, es decir, que para poder instalar la aplicación en un servidor se han de empaquetar todos sus recursos en un único fichero. Por tanto abordar proyectos dónde la construcción involucra a equipos grandes de personas lo hace menos productivo. Por lo tanto el desarrollo de una nueva plataforma siguiendo el estándar modular de Java, OSGi, aportará una gran ventaja productiva a equipos técnicos que quieran desarrollar nuevas soluciones de gestión. Luego, el uso de java como único lenguaje de construcción, haría el desarrollo y mantenimiento mucho más sencillo, permitiendo a cualquier miembro del equipo hacer cualquier tarea en la aplicación. Desde el desarrollo de interfaces al acceso a datos. 3.3 Catálogo del requisitos del sistema Basándose en los aspectos generales que debe cumplir el proyecto y en la experiencia del responsable del proyecto usando herramientas alternativas para desarrollar proyectos software de similares características, los requisitos detallados del proyecto son los siguientes: Requisitos funcionales La plataforma ha de implementar por defecto toda aquella funcionalidad que se considera transversal a cualquier solución de gestión empresarial, a saber: Estructura multi organización Administración de usuarios Administración de módulos Gestión de inventario y almacén Gestión de clientes

19 19 Gestión de proveedores Gestión de trabajadores Gestión de productos Requisitos no funcionales Modular siguiendo el estándar ASI. Seguridad: Autenticación y autorización mediante permisos y roles. Integrado con Spring Security Framework. Transaccionalidad gestionada por el contenedor de Spring Framework Desarrollo de la interfaz de usuario mediante Java, usando Vaadin Framewok Elaboración de informes mediante Jasper Reports 3.4 Descripción de alternativas Realizando un estudio comparativo me baso en cuatro características fundamentales que se resume en la siguiente tabla: Plataforma Konekti Force.com Eclipse RAP Modular - OSGi Sí No Sí RIA Sí Sí Sí Funcional Sí Sí No Sensorial Sí No No Código libre Sí No Sí

20 Especificación funcional del sistema Diagramas de casos de uso En el siguiente diagrama representamos los distintos grupos funcionales que definen a Konekti

21 21 Administración de usuarios Descripción Funcionalidad para dar de alta o baja una cuenta en el sistema, así como otorgar/denegar permisos para definir el grado de operativa de los usuarios. Precondición El actor que administre los usuarios deberá tener privilegios de administrador, es decir, el role correspondiente. Para poder administrar las cuentas de usuarios. Flujo normal Dar de alta/baja o editar los privilegios de los usuarios Flujo alternativo Postcondición Ninguno Dar/Denegar acceso al sistema de un usuario. Caso de uso Instalación de módulos Descripción Funcionalidad para instalar nuevos módulos en el sistema que permitan aumentar la plataforma en funcionalidad. También definir la localización para su acceso en el menú. Precondición El actor que instale nuevos módulos deberá tener privilegios de administrador, es decir, el role correspondiente. Flujo normal Instalar/Desinstalar nuevo módulo. Deberá de reiniciar sesión para que los cambios en el menú se vean reflejados. Flujo alternativo Postcondición Ninguno Menú actualizado con el acceso aquellos módulos que están correctamente instalados

22 22 Caso de uso Gestión de la organización Descripción Funcionalidad que permite representar el organigrama de la organización en el sistema. Estructurándola en organización, localización y área. Precondición El actor que instale nuevos módulos deberá tener privilegios de administrador, es decir, el role correspondiente. Flujo normal Diseñar mediante un gráfico las diferentes localizaciones y áreas de la organización activa. Flujo alternativo Ninguno Postcondición Organigrama resultante Caso de uso Descripción Gestión de direcciones Funcionalidad que permite gestionar las distintas direcciones usadas en el sistema por la organización, clientes y proveedores. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, editar o borrar. Flujo normal Añadir, editar o borrar direcciones Flujo alternativo Ninguno Postcondición Lista de direcciones de la organización activa

23 23 Caso de uso Gestión de proveedores Descripción Funcionalidad que permite dar de alta/baja proveedores del sistema. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, editar o borrar Flujo normal Añadir, editar o borrar proveedores Flujo alternativo Ninguno Postcondición Lista de proveedores de la organización activa Caso de uso Gestión de empleados Descripción Funcionalidad que permite dar de alta/baja empleados del sistema. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, editar o borrar. Flujo normal Añadir, editar o borrar empleados Flujo alternativo Ninguno Postcondición Lista de empleados de la organización activa

24 24 Caso de uso Gestión de clientes Descripción Funcionalidad que permite dar de alta/baja proveedores del sistema. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, editar o borrar. Flujo normal Añadir, editar o borrar clientes Flujo alternativo Ninguno Postcondición Lista de clientes de la organización activa Caso de uso Gestión de calendarios Descripción Funcionalidad que permite dar de alta/baja calendarios del sistema. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, editar o borrar. Flujo normal Añadir, editar o borrar calendarios Flujo alternativo Poder copiar un calendario a partir de uno existente Postcondición Lista de calendarios de la organización activa

25 25 Caso de uso Sonorización Descripción Funcionalidad que permite monitorizar las señales generadas por los sensores integrados en la plataforma. Precondición Flujo normal Tener el permiso de visualización Listar las señales almacenadas Flujo alternativo Ninguno Postcondición Lista de las señales de la organización activa Caso de uso Gestión de alarmas Descripción Funcionalidad que permite configurar alarmas que el sistema dispare según las condiciones establecidas. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, configurar o borrar. Flujo normal Poder crear, configurar o borrar alarmas existentes. Flujo alternativo Ninguno Postcondición Lista de las alarmas de la organización activa

26 26 Caso de uso Gestión de informes Descripción Funcionalidad que permite dar de alta/baja plantillas de informes del sistema. Precondición El usuario deberá tener el privilegio correspondiente para poder ejecutar la acciones deseada. Es decir, añadir, editar o borrar Flujo normal Flujo alternativo Adjuntar nuevas plantillas de informes, cambiarlas o darlas de baja Ninguno Postcondición Lista de plantillas de informes disponibles en la organización activa

27 Modelo de dominio del sistema En los siguientes modelos de clases se muestra las relaciones existentes en las distintas entidades del sistema. Para mayor claridad se han separado las entidades según la división lógica de los casos de uso documentos en el apartado anterior Modelo de la gestión de la organización

28 Modelo de instalación de nuevos módulos Modelo de la gestión de direcciones

29 Modelo de gestión de calendarios

30 Modelo de gestión de datos de sensores

31 Modelo de gestión de alarmas Modelo de gestión de informes

32 Modelo de gestión de empleados

33 Modelo de gestión de proveedores

34 Modelo de gestión de clientes

35 Diagrama de componentes En los siguientes diagramas veremos la relación existente entre los bundes de OSGi que conforman las distintas capas del sistema. Es así que distinguen tres diagramas que forman las tres capas distintas, a saber: vista, servicio y acceso a datos Diagrama de componentes de la capa vista Diagrama de componentes de la capa negocio

36 Diagrama de componentes de la capa de acceso a datos Diagramas de secuencia En los siguientes diagramas veremos la relación existente entre los bundles de OSGi que conforman las distintas capas del sistema. Es así que distinguen tres diagramas que forman las tres capas distintas, a saber, vista, servicio y acceso a datos.

37 37

38 Diagramas de despliegue

39 Interfaces de usuario Principal Administración de usuarios

40 Administración de roles Instalación de módulos

41 Gestión de la organización Gestión de direcciones

42 Gestión de proveedores Gestión de empleados

43 Gestión de clientes Gestión de calendarios

44 Sensorización Gestión de alarmas

45 Gestión de informes

46 46 Manual de instalación 1 Identificación del documento Este documento desarrolla el manual de usuario de la aplicación titulada Konekti, la plataforma para soluciones empresariales; de la Escuela Politécnica de Ingeniería de Gijón. 1.1 Visión general del proyecto Este proyecto tiene la finalidad de realizar una plataforma generalista por desarrolladores para desarrolladores, que permita acortar el ciclo de construcción de aplicaciones de gestión. Ofreciendo un conjunto de herramientas debidamente integradas, que cubren desde la presentación hasta la persistencia. También ofrece per se una serie de funcionalidades transversales a toda solución de gestión; como seguridad, administrar usuarios, impresión de informes, etc. 1.2 Visión general del documento La primera parte del documento describe cuáles son los requisitos de hardware y software para poder desplegar la aplicación. A continuación se pasa a describir los pasos para realizar la instalación del software en el servidor de aplicaciones EclipseRT Virgo. Explicando su ubicación dentro del mismo como el orden de despliegue. Por último se describen los parámetros iniciales de por defecto al arrancar la aplicación por primera vez así como posibles configuraciones y se define un protocolo para el posterior mantenimiento. 2 Documentos referenciados 2.1 Documentos del proyecto Manual de usuario 2.2 Documentos externos Manual de Eclipse RT Virgo 3 Requisitos 3.1 Requisitos hardware La máquina servidora puede ser cualquier arquitectura que sea soportada por la Java Runtime Execution y poder ejecutar procesos implementados en Java. Normalmente entornos Unix basados en una arquitectura x86. La mayoría de las pruebas se han realizado en un servidor dedicado arquitectura x64 con Ubuntu Linux, con conexión a red, 4 gigas de RAM de memoria y 10 gigabytes de memoria física. También se debe permitir acceso desde el exterior al puerto 8080 o usar un servidor web como pasarela.

47 Requisitos software Para el almacén de datos se necesita un Gestor de Base de datos MySQL en su versión 3.5.x, aunque el sistema soporta otros gestores que el usuario deberá configurar. La JRE (Java Runtime Execution) en su versión El servidor EclipseRT Virgo instalado. 3.3 Recursos humanos La plataforma Konekti puede albergar dos perfiles de desarrollador distintos. El que contribuye a Konekti expandiéndola con nuevas funcionalidades y el desarrollador módulos nuevos basados en la plataforma. Ambos perfiles han de tener conocimientos en el lenguaje de programación java, y familiarizados con las herramientas usadas: Maven, Git, Vaadin y Eclipselink. Pero el primero necesita tener experiencia en OSGi, la arquitectura modular de la plataforma, mientras que el segundo le es abstraído de su complejidad. 4 Instalación Se deben desplegar, es decir, copiar todos los módulos en la carpeta /repository/usr tal como se explica en el manual de EclipseRt Virgo para el despliegue de aplicaciones en un entorno de producción. Siendo los siguientes los módulos de la plataforma Konekti: datasource-properties.properties com.thingtrack.konekti.datasource snapshot.jar com.thingtrack.konekti.domain snapshot.jar com.thingtrack.konekti.dao.api snapshot.jar com.thingtrack.konekti.dao.impl snapshot.jar com.thingtrack.konekti.dao.sensor.api snapshot.jar com.thingtrack.konekti.dao.sensor.impl snapshot.jar com.thingtrack.konekti.service.api snapshot.jar com.thingtrack.konekti.service.impl snapshot.jar com.thingtrack.konekti.service.security snapshot.jar com.thingtrack.konekti.service.sensor.api snapshot.jar com.thingtrack.konekti.service.sensor.impl snapshot.jar com.thingtrack.konekti.knowledge snapshot.jar com.thingtrack.konekti.knowledge.service.api snapshot.jar com.thingtrack.konekti.knowledge.service.impl snapshot.jar com.thingtrack.konekti.schedule snapshot.jar com.thingtrack.konekti.report snapshot.jar com.thingtrack.konekti.message snapshot.jar com.thingtrack.konekti.view.security snapshot.jar com.thingtrack.konekti.view.kernel snapshot.jar com.thingtrack.konekti.view.addon snapshot.jar com.thingtrack.konekti.view.layout.header snapshot.jar com.thingtrack.konekti.view.layout.menu snapshot.jar com.thingtrack.konekti.view.layout.toolbar snapshot.jar com.thingtrack.konekti.view.layout.workbench snapshot.jar com.thingtrack.konekti.view.layout.footer snapshot.jar com.thingtrack.konekti.view.layout snapshot.jar com.thingtrack.konekti.view.web.form snapshot.jar com.thingtrack.konekti.view.web.workbench snapshot.jar

48 48 5 Configuración Para la configuración se debe editar el archivo que se encuentra dentro de la carpeta /configuration con el nombre org.eclipse.virgo.kernel.userregion.properties editando la última parte de archivo para que todos bundles necesarios, de la plataforma o dependencias indirectas, se desplieguen secuencialmente al arrancar el servidor. Se muestra tal y como quedaría dicha sección después de añadir todos los módulos necesarios.... # the next line must not be broken with back-slashes initialartifacts=repository:plan/org.eclipse.virgo.kernel.userregion.s pringdm,\ repository:plan/org.eclipse.virgo.web.tomcat,\ repository:bundle/org.eclipse.gemini.dbaccess.mysql/0.0.1.snapshot,\ repository:bundle/org.eclipse.gemini.jpa/1.1.0.release,\ repository:bundle/org.eclipse.gemini.naming.framework/1.0,\ repository:bundle/com.vaadin/6.8.5,\ repository:bundle/com.springsource.javassist/ ga,\ repository:bundle/com.springsource.org.apache.commons.collections/3.2. 1,\ rrepository:bundle/com.springsource.com.fasterxml.classmate/0.5.4, \R repository:bundle/com.springsource.org.apache.tools.ant/1.8.1,\ repository:bundle/com.springsource.org.jboss.jandex/1.0.3.final,\ repository:bundle/com.springsource.org.dom4j/1.6.1,\ repository:bundle/com.springsource.antlr/2.7.7,\ repository:bundle/com.thingtrack.google-collections/1.0,\ repository:bundle/ehcache-spring-annotations/1.1.0,\ repository:bundle/com.springsource.org.apache.log4j/1.2.15,\ repository:bundle/com.thingtrack.com.google.gwt.servlet/2.3.0,\ repository:bundle/com.springsource.org.jvnet.staxex/1.0.0,\ repository:bundle/com.springsource.com.sun.xml.fastinfoset/1.2.2,\ repository:bundle/com.springsource.org.xmlpull/1.1.4.c,\ repository:bundle/com.springsource.com.thoughtworks.xstream/1.3.1,\ repository:bundle/com.springsource.javax.xml.bind/2.1.7,\ repository:bundle/com.springsource.org.apache.xml.resolver/1.2.0,\ repository:bundle/com.springsource.org.relaxng.datatype/1.0.0,\ repository:bundle/com.springsource.org.apache.xmlcommons/1.3.4,\ repository:bundle/com.springsource.com.sun.msv.datatype/ ,\ repository:bundle/com.springsource.com.sun.xml.bind.jaxb1/2.1.7,\ repository:bundle/com.springsource.com.sun.xml.messaging.saaj/1.3.2,\ repository:bundle/com.springsource.com.sun.tools.xjc/2.1.7,\ repository:bundle/com.springsource.org.antlr.runtime/3.1.3,\ repository:bundle/org.mvel2/2.1.0.drools4,\ repository:bundle/org.drools.api/5.3.0.final,\ repository:bundle/org.drools.core/5.3.0.final,\ repository:bundle/org.drools.compiler/5.3.0.final,\ repository:bundle/org.jbpm.flow.core/5.1.0.final,\ repository:bundle/org.jbpm.flow.builder/5.1.0.final,\ repository:bundle/org.jbpm.bpmn2/5.1.0.final,\ repository:bundle/org.apache.servicemix.bundles.avalonframework/ ,\ repository:bundle/com.springsource.org.apache.commons.cli/1.2.0,\ repository:bundle/com.springsource.org.apache.xml.serializer/2.7.1,\

49 49 repository:bundle/com.springsource.org.apache.xalan/2.7.1,\ repository:bundle/com.thingtrack.org.krysalis.addons.barcode4j/2.1.0,\ repository:bundle/com.thingtrack.com.jhlabs.addons.filters/ ,\ repository:bundle/org.eclipse.core.jobs/3.5.0.v ,\ repository:bundle/org.eclipse.equinox.registry/3.5.0.v ,\ repository:bundle/org.eclipse.equinox.preferences/3.5.0.v ,\ repository:bundle/org.eclipse.core.contenttype/ v ,\ repository:bundle/org.eclipse.equinox.app/1.3.1.r36x_v ,\ repository:bundle/org.eclipse.core.runtime/3.7.0.v ,\ repository:bundle/org.eclipse.core.expressions/ v ,\ repository:bundle/org.eclipse.core.filesystem/1.3.1.r36x_v ,\ repository:bundle/org.eclipse.core.resources/ v ,\ repository:bundle/org.eclipse.core.commands/3.5.0.i ,\ repository:bundle/com.ibm.icu/4.2.1.v ,\ repository:bundle/org.eclipse.text/3.5.0.v ,\ repository:bundle/org.eclipse.jdt.core/3.1.0,\ repository:bundle/com.springsource.org.apache.commons.logging/1.1.1,\ repository:bundle/org.apache.commons.beanutils/1.8.0,\ repository:bundle/org.apache.poi/3.5.0,\ repository:bundle/com.springsource.jxl/2.6.6,\ repository:bundle/org.apache.commons.digester/2.0,\ repository:bundle/org.anproca.itext-mpl-lgpl.core/2.1.7,\ repository:bundle/net.sf.jasperreports.engine/4.1.1,\ repository:bundle/com.springsource.org.junit/4.7.0,\ repository:bundle/org.apache.servicemix.bundles.ognl/ ,\ repository:bundle/org.testng/6.8.0,\ repository:bundle/com.springsource.org.objectweb.asm.tree/3.2.0,\ repository:bundle/com.springsource.org.objectweb.asm.commons/3.2.0,\ repository:bundle/com.springsource.com.uwyn.rife.continuations/0.0.1,\ repository:bundle/com.springsource.org.mozilla.javascript/1.7.0.r2,\ repository:bundle/com.springsource.org.python/2.2.1,\ repository:bundle/com.thingtrack.net.sourceforge.freemarker/2.3.4,\ repository:bundle/com.springsource.org.apache.commons.lang/2.5.0,\ repository:bundle/com.springsource.javax.portlet/1.0.0,\ repository:bundle/com.springsource.com.opensymphony.util/2.2.5,\ repository:bundle/com.springsource.com.opensymphony.xwork/1.2.3,\ repository:bundle/com.springsource.com.opensymphony.webwork/2.2.6,\ repository:bundle/com.thingtrack.net.sourceforge.barbecue/1.1.0,\ repository:bundle/com.springsource.org.jfree/1.0.12,\ repository:bundle/com.springsource.org.jfree.chart/1.0.9,\ repository:bundle/com.thingtrack.ar.com.fdvs.dynamicjasper/4.0.0,\ repository:bundle/org.apache.servicemix.bundles.quartz/ ,\ repository:bundle/org.osgi.service.obr/1,\ repository:bundle/org.apache.felix.bundlerepository/1.6.6,\ repository:bundle/org.apache.activemq.kahadb/5.7.0,\ repository:bundle/org.apache.activemq.activemq-core/5.7.0,\ repository:bundle/org.apache.activemq.activemq-spring/5.7.0,\ repository:bundle/org.apache.camel.camel-core/2.10.1,\ repository:bundle/org.apache.activemq.activemq-camel/5.7.0,\ repository:bundle/org.apache.camel.camel-spring/2.10.1,\ repository:bundle/org.apache.camel.camel-jms/2.10.1,\ repository:bundle/org.apache.camel.camel-bindy/2.10.1,\ repository:bundle/javax.ws.rs.jsr311-api/1.1.1,\ repository:bundle/com.sun.jersey.json/1.16.0,\ repository:bundle/com.sun.jersey.contribs.jersey-spring/1.16.0,\ repository:bundle/jackson-xc/1.9.2,\ repository:bundle/org.springframework.security.web/3.1.6.release,\ repository:bundle/org.springframework.security.config/3.1.6.release,\

50 50 repository:configuration/datasource-properties,\ repository:bundle/com.thingtrack.konekti.datasource/0.0.1.snapshot,\ repository:bundle/com.thingtrack.workshoptrack.domain/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.dao.template/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.dao.api/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.dao.impl/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.dao.sensor.api/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.dao.sensor.impl/0.0.1.snapsho T,\ repository:bundle/com.thingtrack.konekti.service.api/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.service.impl/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.service.sensor.api/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.service.sensor.impl/0.0.1.sna PSHOT,\ repository:bundle/com.thingtrack.konekti.knowledge.service.api/0.0.1.s NAPSHOT,\ repository:bundle/com.thingtrack.konekti.knowledge.service.impl/ SNAPSHOT,\ repository:bundle/com.thingtrack.konekti.schedule/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.report/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.message/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.service.security/0.0.1.snapsh OT,\ repository:bundle/com.thingtrack.konekti.view.kernel/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.view.addon/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.view.security/0.0.1.snapshot, \ repository:bundle/com.thingtrack.konekti.view.web.form/0.0.1.snapshot, \ repository:bundle/com.thingtrack.konekti.view.layout.header/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.view.layout.menu/0.0.1.snapsh OT,\ repository:bundle/com.thingtrack.konekti.view.layout.toolbar/0.0.1.sna PSHOT,\ repository:bundle/com.thingtrack.konekti.view.layout.workbench/0.0.1.s NAPSHOT,\ repository:bundle/com.thingtrack.konekti.view.layout.footer/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.view.layout/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.view.web.workbench/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.view.module.organization/ SNAPSHOT,\ repository:bundle/com.thingtrack.konekti.view.module.bundle/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.view.module.modulemanager/0.0.1.snapshot,\ repository:bundle/com.thingtrack.konekti.view.module.alarm/0.0.1.snaps HOT,\ repository:bundle/com.thingtrack.konekti.view.module.address/0.0.1.sna PSHOT,\ repository:bundle/com.thingtrack.konekti.view.module.employee/0.0.1.sn APSHOT,\ repository:bundle/com.thingtrack.konekti.view.module.client/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.view.module.supplier/0.0.1.sn APSHOT,\ repository:bundle/com.thingtrack.konekti.view.module.configuration/0.0

51 51.1.SNAPSHOT,\ repository:bundle/com.thingtrack.konekti.view.module.report/0.0.1.snap SHOT,\ repository:bundle/com.thingtrack.konekti.view.module.knowledge/0.0.1.s NAPSHOT 6 Arrancar el sistema Para arrancar el servidor de aplicaciones debemos de ejecutar el script que está en el archivo startup.bat o startup.sh según desde que sistema operativo ejecutamos el servidor (*.bat Widows y *.sh Unix). Éste archivo se encuentra ubicado en dentro del directorio /bin. 7 Mantenimiento Para realizar el mantenimiento del sistema el servidor de Aplicaciones Eclipse RT Virgo ofrece una herramienta web que nos permite visualizar el estado de los bundles desplegados, tanto aquellos propios de la plataforma Konekti como dependencias externas. Para poder acceder a dicha herramientas se necesita nombre y clave de acceso.

52 52 En la segunda imagen se aprecia que en la parte izquierda se listan todos los bundles desplegados y en derecha las dependencias y los servicios consumidos y publicados por el bundle seleccionado. Para poder realizar un diagnóstico del error cuando el sistema encuentre un fallo se puede recurrir a los ficheros de log, que son aquellos ficheros que dejan traza de toda anomalía en la ejecución de un bundle. Se encuentran dentro del servidor en la carpeta serviceability.

53 53 Manual de usuario 1 Identificación del documento Este documento desarrolla el manual de usuario de la aplicación titulada Konekti, la plataforma para soluciones empresariales; de la Escuela Politécnica de Ingeniería de Gijón. 1.1 Visión general del proyecto Este proyecto tiene la finalidad de realizar una plataforma generalista por desarrolladores para desarrolladores, que permita acortar el ciclo de construcción de aplicaciones de gestión. Ofreciendo un conjunto de herramientas debidamente integradas, que cubren desde la presentación hasta la persistencia. También ofrece per se una serie de funcionalidades transversales a toda solución de gestión; como seguridad, administrar usuarios, impresión de informes, etc. 1.2 Visión general del documento Este documento va dirigido a los usuarios de la aplicación. Explicación del funcionamiento de cada una de las opciones de la plataforma que trae de serie, mediante una descripción de los distintos elementos que forman el interface de usuario, y la explicación del funcionamiento de distintos aspectos que son comunes en casi todas las aplicaciones de gestión web. 2 Documentos referenciados 2.1 Documentos de proyectos Ninguno 2.2 Documentos externos Ninguno 3 Manual de usuario 3.1 Estructural general Para poder acceder al sistema el usuario necesita tener una cuenta activa en el mismo. Pues la primera pantalla que aparece es la de acceso, que como se podrá ver en la foto se solicita un nombre de usuario y la clave además del logotipo si existe de la empresa o vertical sobre Konekti que se haya hecho.

54 54 Una vez obtenido el acceso al sistema, la pantalla que se nos presenta es la siguiente: La pantalla se divide en tres áreas, de arriba a abajo. El Menú contiene el acceso a todos los módulos instalados en la plataforma. La barra de herramientas contiene aquellas acciones disponibles para la vista activa y el área principal que contiene todos aquellos módulos abiertos y que son mostrados al usuario en forma de vistas o pestañas. Como podemos ver en la siguiente imagen dentro del área ampliada, se encuentra la vista, en modo pestaña, que se encuentra activa en ese momento. La barra de herramientas siempre se adapta a las acciones que se pueden ejecutar dentro de la vista activa.

55 55 En la imagen posterior se aprecia como los botones que representan las distintas acciones en la barra de herramientas se agrupan según el tipo de acción a ejecutar. Otro área importante de la plataforma a resaltar se encuentra un una zona que vamos a explicar de izquierda a derecha: Cerrar sesión: Una vez terminado nuestro trabajo sobre la plataforma, nos salimos de la misma a través de esta acción.

56 56 Mensajes: Esta opción de menú nos permite consultar mensajes internos, tanto recibidos de otros usuarios como producidos por la plataforma, mediante alarmas. Ayuda: A través de ella podemos acceder a la ayuda en línea del sistema. Usuario autenticado: El nombre de esta sección viene representado por el nombre de usuario que tiene iniciado la sección. En ella se podrá configurar para preferencias a nivel de usuario. Como el área en la que trabajar dentro de la organización dónde pertenezca el usuario o el idioma mostrado en la plataforma. 3.2 Los maestros En el menú se encuentra como primera sección los maestros, que son aquellas entidades más comunes en toda solución de gestión.

57 57 Se muestran en forma de tabla o grid dónde dependiendo de los privilegios del usuario autenticado podrá crear, editar o borrar a través de la barra de herramientas. 3.3 Gestión de la organización Para la gestión de la organización el sistema se basa en la ISA 95, que sirve como estándar en el ámbito industrial para desarrollar la estructura adecuada de una empresa. Dónde puede tener diferentes delegaciones y en éstas diferentes áreas de trabajo. Este en el caso de la figura que representa la empresa Autos Samoa, S.A. que tiene una única ubicación y en ella un área de oficina. Pero podría haber más ubicaciones geográficas dónde la empresa tenga presencia y áreas dentro de las mismas.

58 58 En la barra de herramientas del módulo de organizaciones se puede crear tantas organizaciones como el usuario quiera, pues la plataforma Konekti es un sistema multi organizacional, es decir, puede gestionarse tantas organizaciones como se quiera, siendo ésta la entidad de mayor nivel de la cual el resto de entidades del sistema dependen. 3.4 Gestión de empleados El maestro de empleados es el primer maestro cuyas entidades son consideradas como agentes, es decir, permite el sistema crear una cuenta de usuario para que éstos tengan acceso al mismo. La barras de herramientas asociada al módulo ofrece las funcionales estándares de los maestros, es decir: Crear un nuevo empleado Editar un empleado seleccionado Borrar un empleado seleccionado Desplazarse por la tabla de empleados mediante las flechas Filtrar para una búsqueda más rápida Adjuntar un documento a un empleado ya creado Imprimir en un informe la tabla de empleados Importar en formato Excel empleados