Proyecto de refaccionaria RAHL - Manual Técnico

MANUAL TÉ CNICO Incluye la documentación de los diagramas generados en el análisis de

requerimientos y se especifican los requisitos de hardware y software para que funcione adecuadamente el sistema y el ambiente de desarrollo.

Introducción

El sistema utiliza MySQL como gestor de base de datos incluido en MySQL Workbench que es un entorno grafico para la manipulación de la base de datos, el sistema funciona desde el lenguaje de programación JAVA en el entorno de desarrollo Netbeans, requiere de un paquete para desarrolladores de JAVA (JDK). Los diagramas UML fueron creados en el software StarUML, específico para este tipo de diagramas.

El manual técnico es un documento que facilita la comprensión del sistema por que incluye de manera detallada la información de la estructura del sistema y los requerimientos necesarios para continuar con el desarrollo o modificar el sistema a partir del código fuente.

Al tener esta información a la mano es más fácil para alguien ajeno al equipo de desarrollo del sistema realice modificaciones o corrija los errores que sean detectados después de la implementación del sistema.

El objetivo del manual técnico es dar una visión clara del sistema al personal que se asigne para corregir errores, mejorar el rendimiento, corregir la lógica de negocios, agregar características, cambiar el aspecto de la interfaz, migrar el sistema, cambiar el gestor de base de datos y demás cambios que se presenten en el futuro.

Incluye los diversos diagramas estandarizados por UML, el diagrama Entidad-Relación, y los requisitos de software y hardware necesarios para continuar con el desarrollo del sistema.

Los siguientes requerimientos de hardware y software son necesarios para el correcto funcionamiento del sistema:

Requerimientos de hardware:

• Sistema Operativo: Windows 7,Windows 8 • Espacio en disco: MB • RAM: MB • Procesador:

Requerimientos de software:

• Netbeans 7.2.1 • JDK (Java Development Kit) • StarUML • MySQL Workbench 5.x • Conector Java a MySQL • Microsoft Word u Otro procesador de textos

Apartado I

Instalación de software

Contenido del Apartado I

Netbeans

Fig. 1 Asistente de Netbeans ...................................................................................................... 5 Fig. 2 Acuerdo de licencia de Netbeans ...................................................................................... 6 Fig. 3 Resumen de instalación de Netbeans ............................................................................... 6 Fig. 4 Proceso de instalación ...................................................................................................... 7 Fig. 5 Instalación completada ..................................................................................................... 7 Fig. 6 Entorno de Netbeans ........................................................................................................

8 JDK

Fig. 7 Asistente de instalación de JDK ......................................................................................... 9 Fig. 8 Acuerdo de licencia de JDK ............................................................................................... 9 Fig. 9 Selección de características de JDK ................................................................................. 10 Fig. 10 Proceso de instalación del JDK ...................................................................................... 10 Fig. 11 Instalación completada del JDK .................................................................................... 11 Fig. 12 Invitación para registrar el JDK ..................................................................................... 11

StarUML

Fig. 13 Asistente de instalación de StarUML ............................................................................ 12 Fig. 14 Acuerdo de licencia de StarUML ................................................................................... 13 Fig. 15 Ruta de instalación de StarUML .................................................................................... 13 Fig. 16 Selección de carpeta de StarUML en Todos los Programas ........................................ 14 Fig. 17 Crear icono en el escritorio de StarUML ....................................................................... 14 Fig. 18 Listo para instalar StarUML ........................................................................................... 15 Fig. 19 Proceso de instalación de StarUML .............................................................................. 15 Fig. 20 Instalación finalizada de StarUML ................................................................................. 16 Fig. 21 Entorno de StarUML...................................................................................................... 16

Microsoft Word

Fig. 22 Preparación de Microsoft Office para instalación ........................................................ 17 Fig. 23 Elegir tipo de instalación de Microsoft Office ............................................................... 18 Fig. 24 Proceso de instalación de Microsoft Office .................................................................. 18 Fig. 25 Instalación finalizada de Microsoft Office ..................................................................... 19 Fig. 26 Activación de Microsoft Office ...................................................................................... 19 Fig. 27 Ingresar clave del producto........................................................................................... 20 Fig. 28 Auto reconfiguración de Microsoft Office .................................................................... 20 Conector Java->MySQL

Fig. 29 Conector de Java a MySQL ............................................................................................ 21 Fig. 30 Ubicación del conector de Java a MySQL ...................................................................... 22

Fig. 31 Detección del conector en Netbeans ............................................................................ 22

MySQL Workbench

Fig. 32 Preparación de la instalación de MySQL Workbench ................................................... 23 Fig. 33 Elegir tipo de instalación de MySQL .............................................................................. 23 Fig. 34 Revisión de aplicaciones afines a MySQL ...................................................................... 24 Fig. 35 Configuración de MySQL ............................................................................................... 24 Fig. 36 Configuración del servidor I – Parámetros de operación ............................................. 25 Fig. 37 Configuración del servidor II – Cuentas de usuario ...................................................... 25 Fig. 38 Configuración del servidor III– Servicio de Windows .................................................... 26 Fig. 39 Continua el proceso de configuración de MySQL ......................................................... 26 Fig. 40 Revisar bases de datos existentes ................................................................................. 27 Fig. 41 Inicio de sesión en MySQL............................................................................................. 27 Fig. 42 Instalación de ejemplos ................................................................................................ 28 Fig. 43 Instalación completada de MySQL ................................................................................ 28

Fig. 44 Entorno de MySQL Workbench ..................................................................................... 29

Netbeans 7.2.1

Requerimientos mínimos:

• Sistema Operativo: Multiplataforma • Espacio en disco: 750 MB • RAM: 512 MB • Procesador: Intel Pentium III o equivalente • Instalación de Netbeans

Pasos para instalar Netbeans:

*Se debe instalar el JDK antes de instalar Netbeans (Ver instalación de JDK)

1.- Iniciar el asistente de instalación dando doble clic sobre el archivo ejecutable de Netbeans y se mostrará esta ventana y presionamos siguiente.

Fig. 1 Asistente de Netbeans

2.- Aceptar el acuerdo de licencia, dando clic en el recuadro cerca de la leyenda “I accept the terms in the license agreement” . Si no hacemos esto no aceptamos los términos de la licencia no nos permitirá continuar con la instalación. Presionamos siguiente.

Fig. 2 Acuerdo de licencia de Netbeans

3.- Dar clic en Instalar para que inicia el proceso y el programa esté disponible en nuestra computadora. Nos muestra la ruta de la instalación y cuanto espacio en el disco duro utilizará para instalarse.

Fig. 3 Resumen de instalación de Netbeans

4.-Esperar a que termine la instalación del programa, el tiempo varía dependiendo de la velocidad del procesador y las aplicaciones que se estén ejecutando en ese momento. Podemos cancelar el proceso en cualquier momento.

Fig. 4 Proceso de instalación

5.- Dar clic en Finalizar para cerrar la ventana que solo nos avisa que la instalación terminó correctamente.

Fig. 5 Instalación completada

6.- Al abrir Netbeans se mostrará una ventana como la siguiente. Netbeans esta listo para comenzar a trabajar.

Fig. 6 Entorno de Netbeans

JDK 1.7


• Sistema Operativo: Windows XP -> Windows 8 • Espacio en disco: 124 MB • RAM: 128 MB

Pasos para instalar Java Development Kit (JDK)

1.- Abrimos el instalador de la aplicación dando doble cli sobre el y a continuación se muestra esta ventana, la cual se ocultará automáticamente y se mostrará una nueva.

Fig. 7 Asistente de instalación de JDK

2.- Para continuar con la instalación debemos aceptar el acuerdo de licencia, si es así damos clic en Aceptar.

Fig. 8 Acuerdo de licencia de JDK

3.- Decidimos si queremos instalar algunas características extras que por defecto están seleccionadas y también podemos cambiar la ruta de instalación, se recomienda continuar con la instalación del JDK con estos valores predeterminados. Damos clic en siguiente.

Fig. 9 Selección de características de JDK

4.- Esperamos un momento mientras termina la instalación del JDK.

Fig. 10 Proceso de instalación del JDK

5.- Al terminar el proceso de instalación aparece una ventana que nos indica que el JDK fue correctamente instalado. Damos clic en finalizar para cerrarla.

Fig. 11 Instalación completada del JDK

6.- Después de terminar la instalación se abrirá una página en el navegador que nos invita a registrar el JDK, páralo cual se require conexión a Internet.

Fig. 12 Invitación para registrar el JDK

StarUML


• Sistema Operativo: Windows XP -> Windows 8 • Espacio en disco: 110MB

• RAM: 128 MB • Procesador: Pentium a 233MHz

Pasos para instalar StarUML

1.- Abrir el instalador de StarUML dando doble clic sobre el icono del archivo ejecutable y nos mostrará la siguiente ventana. Damos clic en siguiente.

Fig. 13 Asistente de instalación de StarUML

2.- Debemos aceptar los términos de la licencia para continuar con la instalación de la aplicación, activamos la casilla correspondiente y damos clic en siguiente.

Fig. 14 Acuerdo de licencia de StarUML

3.- Esta ventana nos permite elegir la ruta de instalación, por ejemplo si deseamos instalarla en otra unidad. Damos clic en siguiente.

Fig. 15 Ruta de instalación de StarUML

4.- Aparece el nombre de la carpeta que contendrá los iconos en el menú inicio. Damos clic en siguiente.

Fig. 16 Selección de carpeta de StarUML en Todos los Programas

5.-Decidimos si queremos crear un icono del programa en el escritorio, si queremos que aparezca la dejamos activada, en caso contrario la desactivamos. Damos clic en siguiente.

Fig. 17 Crear icono en el escritorio de StarUML

6.- Cuando terminemos de configurar las diferentes opciones aparece la ventana para comenzar con la instalación, damos clic en Instalar.

Fig. 18 Listo para instalar StarUML

7.- Esperamos un momento a que termine el proceso de instalación de StarUML. Podemos cancelar el proceso en cualquier momento.

Fig. 19 Proceso de instalación de StarUML

8.- Al terminar el proceso de instalación de StarUML aparecerá una ventana que indica el final la instalación del programa y nos permite elegir si queremos abrir el programa justo después de terminar la instalación, activamos la casilla para abrir el programa después de terminar o en caso contrario la desactivamos.

Fig. 20 Instalación finalizada de StarUML

9.- Así es el entorno de StarUML. Desde donde podemos crear cualquier diagrama del estándar de UML.

Fig. 21 Entorno de StarUML

Microsoft Word 2010


Sistema operativo: Windows XP- Windows 8

Espacio en disco: 3GB

RAM: 256MB (512 Recomendado)

Procesador: 500MHz

El procesador de textos Microsoft Word es utilizado para crear la documentación del sistema, aunque puede ser utilizado cualquier otro capaz de leer los archivos .docx o convirtiendo los archivos a otro formato como PDF u OpenDocument .odt. Microsft Word está incluido dentro de la paquetería de Microsoft Office, por lo tanto se indicara como se instala Microsoft Office completo.

Pasos para instalar Microsoft Word

1.-Abrir el archivo de instalación, regularmente es Setup.exe, en caso de que este comprimido o en otro formato se debe descomprimir, montar una imagen virtual de CD o en su caso al insertar un CD/DVD con el programa se iniciara el instalador automáticamente.

Fig. 22 Preparación de Microsoft Office para instalación

2.- Segundos después se muestra la ventana donde elegimos como instalar Office, en personalizar nos permite elegir los productos a elegir, ubicación, usuario, entre otros; mientras que la opción de Instalar ahora indicara que deseamos instalar todo incluido Microsoft Word, damos clic en esta opción.

Fig. 23 Elegir tipo de instalación de Microsoft Office

3.- El proceso de instalación comenzará inmediatamente y tendremos que esperar varios minutos a que termine

.

Fig. 24 Proceso de instalación de Microsoft Office

4.-Al terminar de instalar los archivos del programa en el disco local aparecerá esta ventana que indica que el procese de instalación terminó correctamente. Damos clic en cerrar.

Fig. 25 Instalación finalizada de Microsoft Office

5.- Al abrir Microsoft Word u otro producto de Microsoft Office, se mostrará una ventana que indica que el programa requiere activación. Estas ventanas corresponden a la instalación Microsoft Office Enterprise Edition, por eso permite instalar sin clave de licencia. Pero si poseemos la clave de licencia dar clic en “Cambiar clave de producto” para insertar la licencia que poseemos.

Fig. 26 Activación de Microsoft Office

6.- En esta ventana escribimos la clave de licencia de Microsoft Office que poseemos. Damos clic en “Continuar”.

Fig. 27 Ingresar clave del producto

7.- Aparecerá la ventana de configuración de la instalación para elegir que tipo de instalación queremos y damos en Instalar ahora de nuevo. Dependiendo de la clave que insertemos el programa quitara funciones para versiones inferiores de Microsoft Office.

Fig. 28 Auto reconfiguración de Microsoft Office

Conector de Java a MySQL

Después de descargar el conector para Java desde la página de MySQL, podremos ver que es un archivo .jar y por lo tanto no es un ejecutable. Este archivo lo debemos mover a una carpeta en específico y estará disponible para que las aplicaciones lo utilicen, Netbeans lo detectará cuando este en la carpeta apropiada.

Pasos para instalar conector Java ->MySQL

1.-Descargar el archivo desde la pagina de MySQL.

2.-Descomprimir en caso de ser necesario hasta tener en una carpeta el conector.

Fig. 29 Conector de Java a MySQL

3.- Copiar a la carpeta apropiada el conector

C:\Program Files\Java\jdk1.7.0_10\jre\lib\ext

Fig. 30 Ubicación del conector de Java a MySQL

4.- Netbeans detecta la existencia del conector y podemos hacer uso de el. (Resaltado en azul)

Fig. 31 Detección del conector en Netbeans

MySQL Workbench


• Sistema Operativo: Windows XP -> Windows 8 Espacio en disco: 500 MB? • RAM: 1GB

• Procesador: CPU a 1.5GHz

Pasos para instalar MySQL Workbench

1.- Iniciamos el instalador de la aplicación dando clic sobre el icono del ejecutable.

Fig. 32 Preparación de la instalación de MySQL Workbench

2.- En algunos segundos se muestra la ventana que nos permite elegir el tipo de instalación. Elegimos la opción de Agregar/Modificar Productos y Características. Estas opciones aparecen cuando tenemos versiones anteriores del programa, en caso de nueva instalación de debe elegir la primer opción y los pasos serán similares.

Fig. 33 Elegir tipo de instalación de MySQL

3.- Iniciará el proceso de instalación que verificará que programas se van a instalar o actualizar en caso de ser necesario. El proceso tomará un momento y ya que todos hayan sido revisados se activara el botón de siguiente, damos clic sobre el.

Fig. 34 Revisión de aplicaciones afines a MySQL

4.- Se mostrará la siguiente ventana y nos permitirá modificar o revisar la configuración del gestor de base de datos.

Fig. 35 Configuración de MySQL

5.- Aparecerá una pantalla en la que podremos cambiar varios parámetros del servidor como el tipo de servidor o el puerto en caso de ser necesario.

Fig. 36 Configuración del servidor I – Parámetros de operación

6.- En esta ventana continuamos con la configuración del servidor añadiendo usuarios y la contraseña del usuario root.

Fig. 37 Configuración del servidor II – Cuentas de usuario

7.- En esta parte elegimos el nombre del servicio en Windows, si deseamos que inicie cuando inicie windows y como deseamos que se ejecute el servicio. Damos clic en siguiente.

Fig. 38 Configuración del servidor III– Servicio de Windows

8.- El proceso de configuración tomará otros segundos y comenzara la configuración por primer uso.

Fig. 39 Continua el proceso de configuración de MySQL

9.- Esta pantalla solo aparece cuando se instala como actualización y queremos que las bases de datos aparezcan en el nuevo MySQL Wokbench, tenemos que utilizar la contraseña de Administrador “root”.

Fig. 40 Revisar bases de datos existentes

10.-Para iniciar el programa siempre debemos indicar un usuario y una contraseña. Siempre debemos hacer uso de un usuario con privilegios de altos o utilizando el usuario root para hacer movimientos en las bases de datos o configurara nuevas opciones.

Fig. 41 Inicio de sesión en MySQL

11.- Esperamos un momento a que se instalen los ejemplos.

Fig. 42 Instalación de ejemplos

12.- La instalación y configuración ha finalizado correctamente si esta pantalla se nos muestra al final.

Fig. 43 Instalación completada de MySQL

13.- Entorno de trabajo que muestra MySQL Wokbench y que al poseer una interfaz grafica permite aumentar la productividad.

Fig. 44 Entorno de MySQL Workbench

Apartado II

Diagramas UML / Diccionario de datos

Diagramas UML........................................................................................................................................

Fig. 2 Diagrama de casos de uso...............................................................................................................

Fig. 3 Diagrama de clases..........................................................................................................................

Diagrama de secuencia.............................................................................................................................

Fig. 4 Búsqueda de usuarios.....................................................................................................................

Fig. 5 Alta de usuarios...............................................................................................................................

Fig. 6 Baja de usuarios..............................................................................................................................

Fig. 7 Actualización...................................................................................................................................

Fig. 8 Realizar pedido................................................................................................................................

Fig. 9 Consultar mercancía.......................................................................................................................

Fig. 10 Recibir mercancía y dar de alta.....................................................................................................

Fig. 11 Alta de ofertas...............................................................................................................................

Fig. 12 Realizar venta................................................................................................................................

Fig. 13 Devolver mercancía......................................................................................................................

Diagrama de colaboración........................................................................................................................

Fig. 14 Búsqueda de usuarios...................................................................................................................

Fig. 15 Alta de usuarios.............................................................................................................................

Fig. 16 Baja de usuarios............................................................................................................................

Fig. 17 Actualización.................................................................................................................................

Fig. 18 Realizar pedido..............................................................................................................................

Fig. 19 Consultar mercancía.....................................................................................................................

Fig. 20 Recibir mercancía y dar de alta.....................................................................................................

Fig. 21 Altas de ofertas.............................................................................................................................

Fig. 22 Realizar venta................................................................................................................................

Fig. 23 Devolver mercancía......................................................................................................................

Fig. 24 Diagrama de estados.....................................................................................................................

Fig. 25 Diagrama de actividades...............................................................................................................

Fig. 26 Diagrama de componentes...........................................................................................................

Fig. 27 Diagrama de despliegue................................................................................................................

Diccionario de datos.................................................................................................................................

Fig. 1 Diagrama Entidad-Relación

Diagramas UML

Fig. 2 Diagrama de casos de uso

Fig. 3 Diagrama de clases

Diagrama de secuencia

Fig. 4 Búsqueda de usuarios

Fig. 5 Alta de usuarios

Fig. 6 Baja de usuarios

Fig. 7 Actualización

Fig. 8 Realizar pedido

Fig. 9 Consultar mercancía

Fig. 10 Recibir mercancía y dar de alta

Fig. 11 Alta de ofertas

Fig. 12 Realizar venta

Fig. 13 Devolver mercancía

Diagrama de colaboración

Fig. 14 Búsqueda de usuarios

Fig. 15 Alta de usuarios

Fig. 16 Baja de usuarios

Fig. 17 Actualización

Fig. 18 Realizar pedido

Fig. 19 Consultar mercancía

Fig. 20 Recibir mercancía y dar de alta

Fig. 21 Altas de ofertas

Fig. 22 Realizar venta

Fig. 23 Devolver mercancía

Fig. 24 Diagrama de estados

Fig. 25 Diagrama de actividades

Fig. 26 Diagrama de componentes

Fig. 27 Diagrama de despliegue

Diccionario de datos

Proyecto de refaccionaria RAHL - Manual Técnico

Documents

Transcript of Proyecto de refaccionaria RAHL - Manual Técnico