Story Transcript
MANUAL DE MANTENIMIENTO
Por: Julián Camilo Ortega Muñoz PONTIFICIA UNIVERSIDAD JAVERIANA 2013
MANUAL DE MANTENIMIENTO INTRODUCCIÓN Este manual de mantenimiento tiene propósito explicar el desarrollo del sistema CLUBMAT, todos sus componentes y su interacción entre ellos. Esto con el propósito de entender el funcionamiento del sistema y para que a futuro se puedan realizar actualizaciones del sistema. Espero cumpla con los objetivos propuestos.
MANUAL DE MANTENIMIENTO TABLA DE CONTENIDO INTRODUCCIÓN ....................................................................................................................................................... 2 TABLA DE CONTENIDO ............................................................................................................................................ 3 INSTALACION DE PROGRAMAS ............................................................................................................................. 4 NEATBEANS 7.3.1 + JDK 7u25 .............................................................................................................................. 4 PostGreSQL 9.2.4 .................................................................................................................................................. 5 CONFIGURACION PARA WINDOWS 7 ............................................................................................................... 6 JAVAFX SCENE BUILDER 1.1 ................................................................................................................................ 6 LIBRERÍA PARA DIALOGOS FLOTANTES EN JAVAFX 2 ....................................................................................... 7 LIBRERÍA PARA CALENDARIO.............................................................................................................................. 7 ACOMPLAMIENTO JAVAFX SCENE BUILDER Y NETBEANS ................................................................................ 8 CREACIÓN DE BASE DE DATOS .............................................................................................................................. 9 POSTGRESQL ........................................................................................................................................................ 9 NETBEANS ............................................................................................................................................................ 10 ARCHIVOS SISTEMA CLUBMAT.............................................................................................................................. 11 ClubmatCliente (Aplicación Cliente JavaFX2) ............................................................................................. 12 COMPONENTES APLICACIÓN EMPRESARIAL (Clubmat) .................................................................................. 12 Entidades ............................................................................................................................................................ 13 Servicios REST ...................................................................................................................................................... 13 COMPONENTES APLICACIÓN CLIENTE JavaFX2 ................................................................................................ 14 Cliente Rest ........................................................................................................................................................ 14 Controladores .................................................................................................................................................... 14 Interfaces de Usuario (Pantallas) ..................................................................................................................... 15 Entidades ............................................................................................................................................................ 15 Inicio .................................................................................................................................................................... 16 Imágenes............................................................................................................................................................ 16 Utilidades ............................................................................................................................................................ 16 Pruebas ............................................................................................................................................................... 16 EJECUTAR EL SISTEMA CLUBMAT .......................................................................................................................... 17
MANUAL DE MANTENIMIENTO INSTALACION DE PROGRAMAS NEATBEANS 7.3.1 + JDK 7u25 Primero se necesita la instalación del IDE (Netbeans) para realizar el programa y el JDK (Java Development Kit) que provee las herramientas de desarrollo para la creación de programas Java. Ingresar a la siguiente dirección para descargar las dos herramientas. http://www.oracle.com/technetwork/java/javase/downloads/index.html
MANUAL DE MANTENIMIENTO Descargar el kit para el tipo de sistema operativo en el que se este trabajando (Windows, Mac OS, Linux). La versión del JDK es la 7u25 y el NetBeans es 7.3.1. NetBeans incluye: • • •
Driver actualizado para PostgreSQL 9. Servidor de aplicaciones Glassfish 4. Soporte para trabajar con JavaFX 2.
Luego de estos pasos instalar los programas con los instaladores que se descargaron siguiendo los pasos.
PostGreSQL 9.2.4 PostGreSql es el manejador de base de datos que se utilizara para manejar los datos del programa. Para descargarlo ir a la siguiente dirección web. http://www.enterprisedb.com/products-services-training/pgdownload
escargar la versión 9.2.4 del sistema operativo que se este utilizando actualmente (Windows, Mac OS, Linux). Ejecute el instalador y siga los pasos del Wizard para completar la instalación. Recuerde proporcionar una contraseña para el superusuario de Postgres. Recomendación: “postgres”.
MANUAL DE MANTENIMIENTO Al finalizar el asistente le pregunta si desea lanzar “Stack Builder”, diga que no y haga Click en terminar.
CONFIGURACION PARA WINDOWS 7 1. Verifique que su sistema operativo tiene activo el servicio “Inicio de sesión secundario”. Para esto vaya a Inicio >> Panel de control >> Herramientas administrativas >> Servicios >> Inicio de sesión secundario. 2. En el campo “Tipo de inicio” elija “Automático”. Haga Click en aceptar. 3. Verifique que el estado de este servicio se encuentre en “Iniciado”. Si no es así́, haga Click derecho sobre “Inicio de sesión secundario” >> Iniciar. El servicio debe mostrarse de la siguiente manera:
JAVAFX SCENE BUILDER 1.1 Este programa funciona para editar manualmente los componentes gráficos de usuario para JavaFX 2. Es muy importante para editar las pantallas de usuario con facilidad. Para descargar este programa dirigirse a la siguiente dirección: http://www.oracle.com/technetwork/java/javafx/downloads/index.html
MANUAL DE MANTENIMIENTO
Descargar el programa para el sistema operativo con el cual se este trabajando (Windows, Mac OS, Linux).
LIBRERÍA PARA DIALOGOS FLOTANTES EN JAVAFX 2 Esta librería sirve para soportar las ventanas instantáneas que se quieran implementar en el programa. Descargue la librería javafx-dialogs-0.0.3.jar. La puede descargar de la URL: https://github.com/marcojakob/javafx-ui-sandbox/tree/master/javafx-dialogs/dist
LIBRERÍA PARA CALENDARIO •
Descargar la librería que contiene la información del calendario y la hoja de estilos del calendario para que tenga la siguiente apariencia.
MANUAL DE MANTENIMIENTO Sitio Descarga: http://edu.makery.ch/blog/2013/01/07/javafx-date-picker/ Archivos: • schudt-javafx-datepicker-0.0.2.jar • DatePicker.css
ACOMPLAMIENTO JAVAFX SCENE BUILDER Y NETBEANS Es importante que estos programas estén acoplados para poder utilizarlos simultáneamente. En el momento de la instalación esto se realiza automáticamente. Para asegurarse que NetBeans conoce la herramienta JavaFX Scene Builder es necesario que se tenga instalado el Plugin de la herramienta. Para saber esto se realiza lo siguiente: 1. Se abre NetBeans una vez instalado y se va a la pestaña Tools (Herramientas) y se escoge la opción plugins.
MANUAL DE MANTENIMIENTO
Luego se verifica si esta instalado el plugin de la herramienta JavaFX Scene Builder, si no se encuentra instalado revisar en los plugins disponibles (Available Plugins), buscarlo e instalarlo.
CREACIÓN DE BASE DE DATOS Es importante crear las base de datos del proyecto antes de correr los programas para que se reconozca la existencia de una base de datos.
POSTGRESQL • • •
Abrir el manejador de base de datos POSTGRESQL instalado previamente. Conectarse a la base de datos con la contraseña proporcionada previamente. Hacer click derecho en el servidor y seleccionar la opción crear base de datos
MANUAL DE MANTENIMIENTO • •
Darle como nombre ClubmatDB que es el nombre de la base de datos actual de CLUBMAT. Darle al usuario todos los privilegios para manipular la base de datos como se ve en la siguiente imagen.
De esta forma en nuestro manejador de base de datos ya se encontrara creada la base de datos.
NETBEANS Para el uso del proyecto debe estar referenciada la base de datos creada previamente en nuestro editor NETBEANS. Para esto realizar lo siguiente: • • • • •
Dirigirse a la pestaña services al costado izquierdo de nuestro editor. Abrir Databases Abrir la carpeta Drivers Click derecho en la opción PostgreSQL Seleccionar la opción Connect Using …
MANUAL DE MANTENIMIENTO •
En la siguiente ventana ingresar los datos de la base de datos como muestra la imagen.
• •
Seleccionar el Schema Public en la siguiente pagina. Dar finish.
De esta forma se crea la referencia a la base de datos creada previamente en Postgresql en nuestro editor.
ARCHIVOS SISTEMA CLUBMAT El sistema CLUBMAT esta dividido por 2 grupos de grandes archivos que deben abrirse con NETBEANS que se explico su instalación previamente. Los archivos son los siguientes:
Clubmat (Aplicación Empresarial JavaEE6) Este archivo contiene toda la información de la lógica de negocio enmarcada en la arquitectura JavaEE6, tiene la información de las entidades, persistencia, EJB, servicios web basados en REST y otra serie de clases complementarias que conforman la lógica de negocio del sistema CLUBMAT.
Este archivo .ear tiene la propiedad de agrupar proyectos en un solo tipo de archivo empresarial. Este contiene un archivo web que es donde se edita toda la lógica de negocio y es agrupada en esta archivo empresarial (Clubmat-war.war).
MANUAL DE MANTENIMIENTO
Para editar este modulo Web hay que buscarlo en la ruta que muestra la imagen y hacer doble Click. Luego de esto el modulo se abrirá independiente del archivo .ear.
ClubmatCliente (Aplicación Cliente JavaFX2) Esta aplicación contiene toda la información y componentes del cliente de CLUBMAT. Estos componentes son pantallas, controladores, clientes de los servicios web del servidor, librerías, etc. El detalle de estos componentes se encuentra en la sección (Componentes Aplicación Cliente JavaFX2). Esta aplicación esta realizada en JavaFX2 y es la que posteriormente se acopla con la aplicación empresarial.
A continuación veremos en detalle cada archivo y el contenido de estos.
COMPONENTES APLICACIÓN EMPRESARIAL (Clubmat) Como se dijo anteriormente, esta aplicación contiene los componentes de la lógica de negocio de la aplicación CLUBMAT. Los archivos importantes están resaltados en la siguiente imagen y se explicara su funcionamiento.
MANUAL DE MANTENIMIENTO Entidades En la carpeta co.edu.javeriana.clubmat.entidades se encuentran las entidades de la lógica de negocio. Estas contienen la información de cada entidad que participa en el sistema CLUBMAT y es la encargada de la mano del generador de persistencia (persistence.xml) de crear las tablas en al base de datos.
Servicios REST En esta arquitectura los EJB que son encargados de la lógica de negocio son los mismos servicios web REST que presta servicios al cliente. En la carpeta co.edu.javeriana.clubmat.rest se encuentran los EJB que son los mismos servicios REST de la aplicación CLUBMAT. Estos se exponen en el servidor Glashfish para que puedan ser utilizados por el cliente.
MANUAL DE MANTENIMIENTO • • • •
Las clases java terminados en FacadeREST son las generadas automáticamente a partir de las entidades y que contienen métodos propios de cada entidad. Estas clases heredan de una clase superior AbstractFacade que se encarga de realizar las peticiones solicitadas por el cliente Las clases java terminadas en Resource son aquellas clases donde se desarrollaron métodos de negocio para suplir necesidades del cliente. La clase ApplicationConfig.java es una clase que genera el editor automáticamente y es para configurar las clases que son servicios REST, es importante no editarla.
Estos son los componentes que integran la aplicación empresarial de CLUBMAT.
COMPONENTES APLICACIÓN CLIENTE JavaFX2 Cliente Rest En la carpeta co.edu.javeriana.clubmat.rest en el lado del cliente contiene las referencias a los servicios REST que están ubicados en el servidor. Estas clases contienen la información de la ubicación de los servicios REST y de los servicios que estos prestan.
Controladores En la carpeta de co.edu.javeriana.clubmat.controladores se encuentran los controladores de las pantallas, estos manejan la información de cada pantalla o interfaz de usuario. Aca se hacen las peticiones a los servicios REST de acuerdo a las peticiones del cliente. Asi mismo, tienen la configuración y la declaración de los componentes de cada pantalla. Su nombre indica que pantalla configuran.
MANUAL DE MANTENIMIENTO
Interfaces de Usuario (Pantallas) En la carpeta co.edu.javeriana.clubmat.pantallas se encuentran los archivos de las interfaces de usuario, estos archivos son formato .FXML y para editarlos se utiliza el editor JavaFX Scene Builder instalado previamente. Estas pantallas están asociadas a los controladores mencionados anteriormente y cada pantalla tiene su único controlador.
•
En esta carpeta de encuentran dos archivos de gran importancia que se encargan de la navegación entre pantallas en la aplicación. El archivo ControlledScreen.java y ScreensController.java. Para mas información de las funciones de estos archivos y como manejan la navegación revisar el tutorial anexo (Tutorial JavaFX2 y JavaEE6 con servicios web basados en REST) o dirigirse a la siguiente dirección web. https://blogs.oracle.com/acaicedo/entry/manejando_multiples_pantallas_en_javafx
Entidades La carpeta co.edu.javeriana.clubmat.entidades por parte del cliente tiene las clases de las entidades de negocio, a diferencia de la carpeta que se encuentra en el servidor, estos son los objetos con los cuales se interactúa en memoria y se envía la información al servidor.
MANUAL DE MANTENIMIENTO Inicio La carpeta co.edu.javeriana.clubmat.inicio contiene una sola clase que es la del inicio del programa, Esta clase contiene el método START que es la encargada en este contexto de JavaFX2 de iniciar el STAGE del programa, ya que el paradigma de este framework habla de stage y scene donde cada pantalla son escenas que se publican en un STAGE. Esta clase es de vital importancia ya que es donde empieza a correr la aplicación.
Imágenes La carpeta co.edu.javeriana.clubmat.imagenes como su nombre lo indica contiene las imágenes que se utilizan permanentemente en la aplicación, como logos, iconos, etc.
Utilidades La carpeta co.edu.javeriana.clubmat.utils contiene clases de utilidad para la aplicación CLUBMAT como hojas de estilos para los fondos.
Pruebas Estas pruebas fueron realizadas a los servicios REST creados para el proyecto y validar su funcionamiento. Para probar los servicios web y su correcto funcionamiento se realiza lo siguiente: • En modulo web del proyecto buscar el folder RESTful Web Services y hacer Click derecho en el. Luego hacer Click en Test RESTful Web Services, tal como muestra la imagen. •
En la configuración de la prueba elegir que sea local y luego dar ok.
•
Luego la aplicación va a abrir un browser para realizar las pruebas del Servicio Web.
MANUAL DE MANTENIMIENTO •
Elegir el servicio web elegido y probar los métodos http mencionados anteriormente en el formato elegido (XML, JSON) para probar que efectivamente funciona con la base de datos.
•
En la siguiente ventana se muestra un ejemplo de la prueba al Servicio Web
EJECUTAR EL SISTEMA CLUBMAT Para ejecutar el programa hay que seguir los siguientes pasos. • •
Se debe haber creado la base de datos en PostgreSQL y en el editor Netbeans su referencia. Configurar el archivo Persistance.xml para crear las tablas en la base de datos a partir de las entidades.
• • •
Hacer Click derecho en la aplicación empresarial y seleccionar CLEAN AND BUILD Hacer Click derecho en la aplicación empresarial y seleccionar DEPLOY Despues de esto la aplicación se va a desplegar en el servidor Glashfish utilizado para este sistema y se crearan las tablas en la base de datos a partir de las entidades.
MANUAL DE MANTENIMIENTO NOTA: Si las tablas no se generan, eliminar el archivo de persistencia y volverlo a crear (Ver tutorial JavaFX2 y JavaEE6 con servicios web basados en REST, Sección GENERACION DEL DESCRIPTOR DE PERSISTENCIA EN NETBEANS) Si se desplego la aplicación con éxito en el servidor y se crearon las tablas realizar los siguientes pasos: • •
Abrir PostgresSQL y dirigirse a la base de datos de ClubmatDB Ejecutar los Scripts del sistema CLUBMAT adjuntos.
•
Es importante la ejecución de los Scripts para tener la información y no generar errores en la ejecución del programa. Verificar los datos en las tablas de la base de datos.
•
Al finalizar el ingreso de la información de la base de datos realizar los siguientes pasos: • • •
Hacer Click Derecho en la aplicación empresarial de CLUBMAT y seleccionar la opción CLEAN AND BUILD Hacer Click Derecho en la aplicación empresarial de CLUBMAT y seleccionar la opción DEPLOY Hacer Click Derecho en la aplicación empresarial de CLUBMAT y seleccionar la opción RUN
Si el proceso se realizó con éxito se ejecutara el programa en el browser de preferencia. NOTA: Es importante utilizar Google Chrome o Mozilla Firefox para la ejecución del programa ya que estos contienen los complementos de Java para la ejecución de Applets. Esta aplicación siendo un Applet necesita permisos para su aplicación por seguridad, Aceptar las advertencias del browser para permitir el acceso al programa)
MANUAL DE MANTENIMIENTO
Para continuar complementando el sistema es importante basarse en el tutorial anexo (Tutorial JavaFX2 y JavaEE6 con servicios web basados en REST) para la creación y edición del sistema.