Software Architecture Document Software Design Document

Transcripción

1 Herramienta para la administración de requerimientos de los proyectos de las asignaturas de Ingeniería de Software y Arquitectura de Software de la Pontificia Universidad Javeriana vae Software Architecture Document Software Design Document SAD/SDD VANESA CAROLI LOAIZA CARVAJAL LAURA CATALI ZORRO JIMÉNEZ 2010 P O N T I F I C I A U N I V E R S I D A D J A V E R I A N A

2 HISTORIAL DE CAMBIOS FECHA VERSIÓN DESCRIPCIÓN RESPONSABLE Organización del documento. Vanesa Carolina Loaiza, Laura Catalina Zorro Sección 1.1., 1.5, 8 Vanesa Carolina Loaiza, Laura Catalina Zorro Modificación de la vista de datos y Sección Secciones 1.2, 1.5, 2,3 Vanesa Carolina Loaiza, Laura Catalina Zorro Vanesa Carolina Loaiza, Laura Catalina Zorro Secciones 4,5 Vanesa Carolina Loaiza, Laura Catalina Zorro Secciones 6,7 Vanesa Carolina Loaiza, Laura Catalina Zorro Sección 9 Vanesa Carolina Loaiza, Laura Catalina Zorro 1.7 Correcciones de los diagramas y sus respectivas documentación Vanesa Carolina Loaiza, Laura Catalina Zorro 1.8 Cambio de diagramas según cambios en los requerimientos y en la fase de implementación Tabla 1: Historial de cambios Vanesa Carolina Loaiza, Laura Catalina Zorro 2

3 TABLA DE CONTENIDO HISTORIAL DE CAMBIOS... 2 TABLA DE CONTENIDO... 3 ÍNDICE DE TABLAS INTRODUCCIÓN Alcance Definiciones, acrónimos y abreviaciones Referencias Apreciación global REPRESENTACIÓN ARQUITECTÓNICA RESTRICCIONES Y OBJETIVOS ARQUITECTÓNICOS Restricciones de la Arquitectura Objetivos de la Arquitectura VISTA DE CASOS DE USO VISTA LÓGICA Apreciación Global Diseño Arquitectónico de Paquetes Paquete Modelo Paquete Vista Paquete Controlador Paquete Datos VISTA DE DESPLIEGUE ERMT VISTA DE IMPLEMENTACIÓN Componente Vista Gestor de Vistas Vista Requerimiento Vista Proyecto Vista Reporte Vista Atributos Vista Archivo Vista y Verificación Componente Controlador Gestor de Eventos... Error! Marcador no definido. 7.3 Componente Modelo Consultas... Error! Marcador no definido Lógica Conexión_datos Componente Datos

4 7.4.1 Conexión... Error! Marcador no definido Acceso_Tablas... Error! Marcador no definido Acceso_Vista... Error! Marcador no definido Acceso_Rutinas... Error! Marcador no definido. 8 VISTA DE DATOS DISEÑO DE INTERFACES DE USUARIO Interfaces Gráficas Interfaz Inicio Interfaz Crear Proyecto Interfaz Menú Principal Interfaz Consultar información del proyecto Interfaz Consultar Información de un requerimiento Interfaz Seleccionar tipo de Reporte Interfaz Formato Informe ANEXOS Anexo 1: Documento de Casos de Uso Anexo 2: SRS Anexo 3: Documentación del diagrama de clases

5 ÍNDICE DE TABLAS TABLA 1: HISTORIAL DE CAMBIOS... 2 TABLA 2: DEFINICIONES, ACRÓNIMOS Y ABREVIACIONES... 7 TABLA 3: DOCUMENTACIÓN DE VISTA DE DATOS TABLA 4. COMPONENTE NUEVO PROYECTO TABLA 5. COMPONENTE ABRIR PROYECTO TABLA 6. COMPONENTE ELIMIR PROYECTO TABLA 7. COMPONENTE BOTÓN ACEPTAR TABLA 8. MODELO DOCUMENTACIÓN DE INTERFACES TABLA 9. COMPONENTE IDENTIFICADOR PROYECTO TABLA 10. COMPONENTE NOMBRE PROYECTO TABLA 11. COMPONENTE FECHA DE CREACIÓN TABLA 12. COMPONENTE AUTOR TABLA 13. COMPONENTE CONSULTAR INFORMACIÓN DEL PROYECTO TABLA 14. COMPONENTE CONSULTAR INFORMACIÓN DE UN REQUERIMIENTO TABLA 15. COMPONENTE CREAR UN NUEVO REQUERIMIENTO TABLA 16. COMPONENTE ELIMIR UN REQUERIMIENTO TABLA 17. COMPONENTE GENERAR REPORTE TABLA 18. COMPONENTE GENERAR GRAFO TABLA 19. COMPONENTE IDENTIFICADOR ÚNICO MOSTRAR INFORMACIÓN TABLA 20. COMPONENTE NOMBRE PROYECTO MOSTRAR INFORMACIÓN TABLA 21. COMPONENTE AUTOR MOSTRAR INFORMACIÓN TABLA 22. COMPONENTE FECHA DE CREACIÓN MOSTRAR INFORMACIÓN TABLA 23. COMPONENTE FECHA MODIFICACIÓN MOSTRAR INFORMACIÓN TABLA 24. COMPONENTE AVANCE MOSTRAR INFORMACIÓN TABLA 25. COMPONENTE NUMERO DE REPORTES MOSTRAR INFORMACIÓN TABLA 26. COMPONENTE REGRESAR MOSTRAR INFORMACIÓN TABLA 27. COMPONENTE MODIFICAR MOSTRAR INFORMACIÓN TABLA 28. COMPONENTE IDENTIFICADOR ÚNICO DEL REQUERIMIENTO TABLA 29. COMPONENTE ATRIBUTOS QUE DESCRIBEN EL REQUERIMIENTO TABLA 30. COMPONENTE REGRESAR TABLA 31. COMPONENTE GENERAL TABLA 32. COMPONENTE REQUERIMIENTO TABLA 33. COMPONENTE ESTADO TABLA 34. COMPONENTE TRAZABILIDAD TABLA 35. COMPONENTE PRIORIZACIÓN TABLA 36. COMPONENTE REQUERIMIENTOS RECHAZADOS TABLA 37. COMPONENTE VALIDACIÓN Y VERIFICACIÓN TABLA 38. COMPONENTE HISTORIAL DE CAMBIOS TABLA 40. COMPONENTE MICROSOFT OFFICE WORD TABLA 40. COMPONENTE MICROSOFT OFFICE EXCEL TABLA 41. COMPONENTE NOMBRE - REPORTE TABLA 42. COMPONENTE FECHA - REPORTE TABLA 43. COMPONENTE AUTOR - REPORTE

6 TABLA 44. COMPONENTE GENERAR - REPORTE TABLA 45. COMPONENTE CANCELAR - REPORTE

7 1 INTRODUCCIÓN 1.1. El objetivo de este documento es describir la arquitectura y el diseño detallado del sistema ERMT. Por medio de este documento, se muestran las diferentes características, elementos y relaciones existentes, hasta el punto de aislar esas particularidades, las cuales se deben resaltar con el fin de realizar una especificación detallada de cada una de ellas. Para realizar este aislamiento se utilizan varios diagramas que nos muestran diferentes perspectivas del sistema, donde se toma en cuenta los Stakeholder que intervienen dentro del proyecto [1] Alcance El presente documento proporciona la definición y descripción arquitectónica, así como los atributos de calidad que de la herramienta para la administración de Requerimientos en las asignaturas de Ingeniería de Software y Arquitectura de Software de la Pontificia universidad Javeriana - ERMT, debe cumplir Definiciones, acrónimos y abreviaciones CONCEPTO DESCRIPCIÓN AS IS ERMT N/A Arquitectura de Software Ingenierías de Software Hace referencia a las iniciales del Nombre designado para la herramienta, el cual es: Easy Requirement Management Tool. No Aplica Tabla 2: Definiciones, acrónimos y abreviaciones 7

8 1.4. Referencias [1]. K Kruchten Philippe. Architectural Blueprints - The View Model of Software Architecture, Rational Software Corporation. [Articulo en Internet]. Disponible en: [Ultima consulta: Noviembre 01 de 2010]. [2]. Jaramillo C, Riveros J, Villalobos V, Zorro L. SAD, Diseño de la Arquitectura del Sistema suvisa. Septiembre 29 de [3]. Oracle. JInt Demo: Implementing MVC Architecture using Struts. [Homepage en Internet]. Disponible en: [Última Fecha de Consulta: Noviembre 05 de 2010]. [4]. About.com. Stand Alone Software, Definition. [Homepage en Internet]. Disponible en: [Última Fecha de consulta: Octubre 4 de 2010]. [5]. González A, Jaramillo C, Narváez M, Oquendo T, Villalobos V, Zorro L. Demented Movie Game. SDD: Demented Movie Game. Versión Apreciación global El documento se encuentra organizado de acuerdo a los diferentes diagramas que se desarrollan para la descripción arquitectura y diseño del sistema. Se encuentran distribuidos de la siguiente forma: Vista de Casos de Uso (Escenarios): Sección 4 Vista Lógica: Sección 5 Vista de Despliegue: Sección 6 Vista Implementación: Sección 7 Vista de Procesos: Sección 8 Vista de Datos: Sección 9 Diseño de interfaces: Sección 10 8

9 Para mayor información acerca del contenido de cada diagrama, ver Sección 2 Representación Arquitectónica. 9

10 2 REPRESENTACIÓN ARQUITECTÓNICA Para realizar la descripción de la arquitectura de la herramienta ERMT, es necesario utilizar un gran nivel de detalle, por lo tanto se empleará la descripción dada por Philipe Krutchen en su artículo Architectural Blueprints - The View Model of Software Architecture [1], el cual hace referencia a cinco vistas que muestran una perspectiva diferente del sistema. Adicionalmente se encontrará la vista de datos. A continuación se muestra una lista de cuáles son estas cinco vistas, con una breve descripción de cada una de estas. Vista de Casos de Uso: esta vista describe de manera abstracta los requerimientos más importantes. Tiene como objetivos principales, descubrir los elementos arquitectónicos del sistema, y es un método de validación del diseño de la arquitectura [1]. Vista Lógica: Esta vista se encarga de soportar los requerimientos funcionales (los cuales se encuentran especificados en el documento Anexo 2 SRS.docx). En esta vista el sistema es descompuesto en abstracciones del dominio del problema [1]. Vista de Despliegue: se encarga de los requerimientos no funcionales de desempeño, disponibilidad, escalabilidad y confiabilidad [1]. Vista de Implementación: la cual se encarga de hacer la descripción del sistema desde la perspectiva de los desarrolladores [2] ya que este es dividido en subsistemas, los cuales son organizados en capas de jerarquía [1]. Vista de Procesos: esta vista, según la definición de Krutchen, considera requerimientos no funcionales como el desempeño y la disponibilidad, además muestra cuales son los hilos de control que ejecutan operaciones de las clases definidas en la vista lógica [1]. Vista de Datos: Esta vista se encarga de representar las entidades que se encargaran de la persistencia de los datos dentro de la herramienta ERMT. 10

11 3 RESTRICCIONES Y OBJETIVOS ARQUITECTÓNICOS 3.1 Restricciones de la Arquitectura Las restricciones que se han considerado para el desarrollo de la arquitectura del sistema ERMT son: - La única base de datos con la que interactuará ERMT es MySql. - ERMT debe ser desarrollado en el lenguaje de programación JAVA. - Los equipos en los que ERMT funcionará, deben cumplir con las restricciones descritas en la sección Requerimientos de Adaptación del Sitio, del documento SRS.docx 3.2 Objetivos de la Arquitectura - La arquitectura debe permitir que la herramienta, cumpla con cada uno de los requerimientos no funcionales descritos en el documento SRS.docx. - ERMT debe interactuar con las herramientas Microsoft Office Excel y Graphviz, para la generación de reportes. - La arquitectura debe asegurar la mantenibilidad de la herramienta ERMT de tal forma que, cuando se realice una actualización de uno o más componentes, no se altere el funcionamiento de los demás. 11

12 4 VISTA DE CASOS DE USO Para más información Ver Anexo 10.1 Documento de casos de uso. 12

13 5 VISTA LÓGICA Esta sección describe la vista Lógica del sistema ERMT, en donde describe de manera general la arquitectura que este tendrá. 5.1 Apreciación Global En la Ilustración 1. Vista Lógica, se muestra de manera general la arquitectura que ha sido seleccionada para el sistema ERMT. Esta es la Arquitectura Modelo Vista Controlador (MVC), la cual permite separar la lógica del negocio y los datos del sistema, de la presentación que se hace para el cliente [3]. Ilustración 1. Vista Lógica 13

14 5.2 Diseño Arquitectónico de Paquetes El sistema ERMT está dividido en tres grandes paquetes, los cuales se encuentran detallados a continuación Paquete Modelo Es el encargado de administrar toda la lógica de la aplicación como la creación de un proyecto, creación de requerimientos, generación de reportes y todas las funcionalidades descritas en la sección 3.2 Características del Producto de Software, del Anexo Los componentes del paquete modelo se encuentran detallados en la Ilustración 2. Diagrama de Clases Paquete Modelo. Para mayor información acerca de este paquete, ver documento Anexo 10.3 Documentación del diagrama de clasesv1.0.docx Ilustración 2. Diagrama de Clases Paquete Modelo 14

15 5.2.2 Paquete Vista Este paquete tiene como función presentar la información a los usuarios de manera adecuada, de tal manera que el sistema puede cumplir con los requerimientos de Usabilidad especificados en el documento Anexo 10.2 SRS.docx. La Ilustración 3. Paquete Vista, muestra los componentes del paquete, el cual cuenta con: - Gestor de Vistas, ver Sección Vista Requerimiento, ver Sección Vista Proyecto, ver Sección Vista Reporte, ver Sección Vista Atributos, ver Sección Vista Archivo, ver Sección Vista y Verificación, ver Sección Para mayor información acerca de los componentes ver Sección 7. Diagrama de Despliegue Paquete Controlador Ilustración 3. Paquete Vista El paquete controlador se relaciona de manera directa con el paquete modelo con el fin de utilizar el componente Lógica (ver sección Paquete Modelo) que se encuentra en este. Además se relaciona con la vista ya que es el encargado de gestionar todos los eventos tanto de entrada como de salida de la presentación (ver Sección Paquete Vista). Para cumplir con sus funciones cuenta con un componente llamado Gestor de eventos. 15

16 5.2.4 Paquete Datos El paquete Datos se relaciona de manera directa con el paquete modelo, de esta forma puede proporcionarle los datos solicitados por el usuario ó para realizar alguna operación. Este paquete contiene las clases que le permite realizar la conexión a la base de datos, acceso a las tablas, vistas y procedimientos almacenados, cada una de forma independiente. En la Ilustración 4 se encuentran establecidas las clases dentro del paquete Datos y en el documento Anexo 10.3 Documentación del diagrama de clasesv1.0.docx encontrará la especificación de cada una de ellas.. Ilustración 4: Paquete Datos 16

17 6 VISTA DE DESPLIEGUE En esta sección se describen los diferentes nodos físicos necesarios para realizar el despliegue requerido del sistema ERMT. Como el sistema se ha definido como una aplicación repositorio, el sistema debe interactuar con un manejador de bases de datos, para, por lo tanto en la Ilustración 5. Vista de Despliegue, se encuentra definido un nodo, el cual representa al sistema, con los componentes definidos en la vista lógica (ver Sección 5. Vista Lógica), el cual se comunica con la base de datos, en este caso, solo se muestra un equipo, pero pueden existir mas de un equipo interactuando con la base de datos. Ilustración 5. Vista de Despliegue 6.1 ERMT En este nodo se encuentran definidos los componentes Modelo, Vista y Controlador, que se encargaran del correcto funcionamiento del sistema. Para mayor información acerca de los componentes ver Sección 5. Vista Lógica. 17

18 Para el correcto funcionamiento del sistema, es necesario que el nodo, cumpla con las especificaciones técnicas descritas en la sección Requerimientos de Adaptación del Sitio del documento Anexo 10.2 SRS.docx Además, se encuentra aparte el servidor de base de datos, permitiendo así el acceso concurrente a la información. El componte que tiene comunicación con la Base de datos en el modelo, el cual tiene un paquete encargado solo para su acceso, denominado Datos. (ver Paquete Datos) 18

19 7 VISTA DE IMPLEMENTACIÓN Esta sección describe la descomposición arquitectónica del sistema ERMT, el cual hace uso de una arquitectura MVC la cual permite separar los componentes de visualización de la lógica del sistema [3]. La vista de implementación se muestra en la Ilustración 6. Vista De Implementación. Así mismo se provee una descripción general los elementos de diseño del sistema que corresponden a la descripción de la vista lógica (ver Sección 5. Vista Lógica). Ilustración 6. Vista De Implementación. 19

20 7.1 Componente Vista Este componente es el responsable de la presentación de la información y del modelo de una manera adecuada para la interacción, ya que genera las diferentes interfaces de usuario por medio de las cuales el usuario interactúa con el sistema. En la Ilustración 7. Implementación - Componente Vista, se pueden observar los componentes de la Vista. - Servicios Prestados: Genera y despliega las diferentes vistas que el usuario requiere. - Servicios Requeridos: servicios prestados por el controlador Gestor de Vistas Ilustración 7. Implementación - Componente Vista - Servicios Prestados: Se encarga de gestionar las diferentes interfaces o vistas que son desplegadas al usuario, dependiendo de la funcionalidad (ver Sección 3.2 Características del Producto de Software del documento Anexo 10.2 SRS.docx) deseada por el usuario. 20

21 - Servicios Requeridos: Requiere de los servicios del gestor de eventos en el componente del controlador Vista Requerimiento - Servicios Prestados: Se encarga de presentar la información relacionada con las consultas realizadas sobre un requerimiento y recibe la información necesaria para la creación, modificación o eliminación de un requerimiento. - Servicios Requeridos: Requiere de los servicios prestados por el gestor de vistas Vista Proyecto - Servicios Prestados: Se encarga de capturar la información correspondiente para la creación, modificación o eliminación de un proyecto. También tiene como función mostrar la información pertinente a un proyecto. - Servicios Requeridos: Requiere de los servicios prestados por el gestor de vistas Vista Reporte - Servicios Prestados: Muestra las diferentes opciones para la generación de los diferentes reportes. - Servicios Requeridos: Requiere de los servicios prestados por el gestor de vistas Vista Atributos - Servicios Prestados: Muestra y recibe la información relacionada con los atributos de un requerimiento. - Servicios Requeridos: Requiere de los servicios prestados por el gestor de vistas Vista requerimiento - Servicios Prestados: muestra y recibe la información de los tipos de requerimientos que se manejan en la base de datos.. - Servicios Requeridos: Requiere de los servicios prestados por el gestor de vistas. 21

22 7.1.7 Vista y Verificación - Servicios Prestados: muestra y recibe la información relacionada con las listas de validación y verificación disponibles en el sistema - Servicios Requeridos: Requiere de los servicios prestados por el gestor de vistas. 7.2 Componente Controlador Se encarga de responder y procesar los eventos generados por el usuario del sistema. Además debe invocar a los cambios que se generen en el modelo y la vista. La Ilustración 8. Implementación - Controlador, muestra el único componente del controlador. Ilustración 8. Implementación - Controlador - Servicios Prestados: Gestiona eventos de entrada y salida del sistema. - Servicios Requeridos: requiere de los servicios del modelo y la vista. 22

23 7.2.1 Modelo Tabla - Servicios Prestados: Escucha las peticiones generadas por los usuarios del sistema, para esto, se utiliza la clase Modelo Vista, descrita en el documento Anexo 10.3 Documentación del diagrama de clasesv1.0.docx. - Servicios Requeridos: Requiere de los servicios del Controlador Reporte - Servicios Prestados: Escucha las peticiones generadas por para la generación del reporte - Servicios Requeridos: Requiere de los servicios del Controlador para que pueda consultar la información necesaria. 7.3 Componente Modelo Contiene la lógica del sistema ERMT, y las consultas que pueden ser realizadas sobre los datos de este. La Ilustración 9. Implementación Modelo muestra los componentes del Modelo. Ilustración 9. Implementación Modelo - Servicios Prestados: Contiene la funcionalidad y los datos relevantes para el usuario, los cuales son necesarios para la presentación de las vistas. 23

24 - Servicios Requeridos: requiere de los servicios prestados por el controlador Lógica - Servicios Prestados: Contiene los procedimientos necesarios para cumplir con los requerimientos funcionales descritos en la sección 3.2 Características del Producto de Software del documento Anexo 10.2 SRS.docx. - Servicios Requeridos: Requiere de los servicios prestados por el Controlador Conexión_datos - Servicios Prestados: permite, por medio de la clase Conexión, descrita en el Documento Anexo 10.3 Documentación del diagrama de clasesv1.0.docx, que el Componente Modelo, tenga acceso a la información almacenada en la base de datos. - Servicios Requeridos: Requiere de los servicios prestados por la clase Conexión, del Componente Datos, (ver Sección 7.4.1) 7.4 Componente Datos Este componente es el encargado de permitir la comunicación entre la lógica y la base de datos del sistema. La Ilustración 10. Implementación - Datos muestra los componentes que hacen parte de Datos. Ilustración 10. Implementación - Datos 24

25 7.4.1 Acceso de la base de datos - Servicios Prestados: Gestiona la comunicación entre el Componente Datos y el Componente Modelo (ver Sección 7.3 Componente Modelo). - Servicios Requeridos: requiere de los servicios del prestados por el componente Lógica (ver Sección Lógica) del Modelo. 25

26 8 VISTA DE DATOS Ilustración 11: Vista de Datos

27 TABLA DESCRIPCION Atributos Descripción de Atributos Requerimiento Almacena toda la información relacionada con los requerimientos de cada proyecto. Id_requerimiento (Integer) Numero de identificación del requerimiento, debe ser único dentro del proyecto. Atributo Tiene la información de cada atributo definido en el sistema, para que el usuario pueda hacer uso de éste en cada Proyecto. Id_atributo (Integer) Numero de identificación del atributo, debe ser único dentro del sistema. Nombre (Varchar2) Nombre del atributo definido en el sistema. Descripción (Varchar2) Breve descripción del atributo. Seleccionado (Boolean) Indica si ha sido seleccionado para incluirse dentro del proyecto y así hacer parte de la especificación del requerimiento. _Dato (Varchar2) Indica el tipo de dato que puede ser el atributo. Trazabilidad Almacena la información relacionada con la trazabilidad de cada uno de los Origen (Varchar2) Indica el origen de cada requerimiento del proyecto.

28 requerimientos que se manejan por Proyecto. CU (Varchar2) Indica los casos de uso asociados a cada requerimiento. SRS (Varchar2) Indica la sección del SRS donde se encuentra el requerimiento. SDD (Varchar2) Indica la sección dentro del documento SDD, donde se encuentra cada requerimiento. Componente (Varchar2) Indica el componente donde se encuentra el requerimiento. Pruebas (Varchar2) Indica la sección dentro del documento de pruebas donde se encuentra el requerimiento. Archivo Guarda la información relevante de los diferentes documentos de un proyecto. Id_Archivo (Integer) Identificador del archivo registrado, deber único dentro del proyecto. Nombre_archivo (Varchar2) Nombre del archivo que se ha registrado en la base de datos. Link (Varchar2) Ruta para ubicar el archivo 28

29 Formato (Varchar2) Formato del archivo que se ha regisrtado. Historial_Cambio Registra los cambios realizados en cada uno de los requerimientos que existen por Proyecto. Id_cambio (Integer) Numero de identificación realizado, debe ser único dentro del Proyecto. Responsable (Varchar2) Indica el nombre del responsable de la modificación. Fecha_modificación (Date) Fecha en la que ocurrió la modificación. Justificación (Varchar2) breve párrafo que indique el porqué fue modificado el requerimiento. RequerimientoxVerVal Almacena los valores correspondientes a las diferentes listas de chequeo de cada requerimiento. Check (Boolean) Indica si el requerimiento cumple o no con un criterio de la lista de V&V. Verificacion_Validacion Tiene las listas de chequeo definidas en el sistema. Id_VV (Integer) Identificador del criterio de la lista de V&V, debe ser único dentro del sistema. Descripción (Varchar2) Breve explicación sobre el 29

30 criterio de la lista a evaluar. _Requerimiento Almacena la información correspondiente a los diferentes tipos de requerimientos que puede definir el usuario por cada proyecto. Id_tipo (Integer) Numero de identificación del tipo de requerimiento, debe ser único dentro del proyecto. Nombre (Varchar2) Nombre del tipo de requerimiento, creado por el usuario Descripción (Varchar2) Descripción breve del tipo de requerimiento. Proyecto Tiene la información relacionada con el proyecto. Id_proyecto (Integer) Numero de identificación del proyecto, debe ser único dentro del sistema. Nombre (Varchar2) Nombre del rpoyecto creado dentro del sistema. _requerimiento_requerimiento Almacena los tipos de relación que existe entre los requerimientos. _relación (Varchar2) Indica el tipo de relación que existe entre los requerimientos (dependencia, igualdad). Registro_Reportes Tiene el registro de los reportes generados en el sistema por cada proyecto. Id_Reporte (Integer) Numero de identificación del reporte, este debe ser único dentro del proyecto. 30

31 _reporte Fecha_reporte (Varchar2) indica el tipo de reporte que se ha de realizar. (Date) Fecha en la que se ha generado un reporte. Formato_reporte (Varchar2) Formato del reporte (.docx,.xlsx) Priorización Contiene la información relacionada a los métodos de priorización que se manejan dentro del sistema. Método_priorización (Varchar2) Método de priorización definido en el sistema, este debe ser único dentro de la aplicación. Descripción (Varchar2) Breve explicación acerca del método de priorización. Criterio Tiene la información relacionada al criterio de priorización que se quiere evaluar en el procesos de priorización Id_criterio Nombre (Integer) Identificador del criterio, debe ser único dentro del sistema. (Varchar2) nombre del criterio de priorización Descripción (Varchar2) breve descripción sobre el criterio a evaluar, dentro del contexto del método de priorización. 31

32 _criterio_requerimiento Almacena los valores correspondientes a cada criterio según el requerimiento evaluado, para así poder obtener la priorización total. Valor (Number) Valor del requerimiento con respecto al criterio de priorización que se está evaluando. _atributo_requerimiento Almacena los valores correspondientes a cada atributo según el requerimiento que se esté especificando. Valor (Varchar2) Valor del requerimiento, con respecto al atributo a especificar. _proyecto_atributo Contiene seleccionados los atributos escogidos por el usuario para utilizar dentro de un proyecto Seleccionado Tabla 3: Especificación de Tablas - Vista de datos (Int) Valor entre 1 y 0 que indica si fue seleccionado o no. Vista DESCRIPCION Tablas involucradas Requerimientos_Dependientes Muestra una tabla con los requerimientos relacionados de forma dependiente _requerimiento_requerimiento requerimiento Requerimiento_NoDependientes Muestra una tabla con los requerimientos relacionados de forma dependiente _requerimiento_requerimiento requerimiento Historial_cambios_fecha Muestra una tabla con los cambios realizados en los requerimientos, desde una requerimiento 32

33 fecha definida por el usuario. historial_cambio Historial_cambios_requerimiento Muestra una tabla con los cambios realizados en un requerimiento definido por el usuario. requerimiento historial_cambio vv_requerimiento Muestra la lista de chequeo de un grupo de requerimientos determinado por el usuario requerimiento _vv_requerimiento Verificación_validacion Especificación_requerimiento Muestra la especificación completa de un requerimientos (según los atributos determinados por el usuario) Requerimiento Atributo _atributo_requerimiento trazabilidad historial_cambios tipo_requerimiento Tabla 4: Especificación de Vistas - Vista de datos Procedimiento Almacenado DESCRIPCION Tablas involucradas Atributos_seleccionados Realiza el update sobre los atributos seleccionados por el usuario atributo _proyecto_atributo 33

34 Establecer_Estado_inicial Establece el estado propuesto tan pronto se crea un requerimiento. requerimiento atributo _atributo_requerimiento Calculo_priorizacion_wiegers Realiza el cálculo de priorización de Wiegers para un requerimiento criterio _criterio_requerimiento requerimiento _atributo_requerimiento Calculo_priorizacion_parejas Realiza el cálculo de priorización de parejas para un requerimiento criterio _criterio_requerimiento requerimiento _atributo_requerimiento Insertar_valor_criterio Limita el valor de inserción de un requerimiento. criterio _criterio_requerimiento Calcular_estado_general Realiza el calculo del estado general del proyecto, por medio de los estados de los requerimientos dentro de un proyecto requerimiento _atributo_requerimiento Tabla 5: Especificación de Procedimientos Almacenados - Vista de datos 34

35 9 DISEÑO DE INTERFACES DE USUARIO La interfaz gráfica de ERMT tiene como objetivo principal, que el usuario haga un uso adecuado y eficiente del sistema. Para esto, se encuentran descritas en la sección 9.1 Interfaces Gráficas, las diferentes interfaces que existirán, la cuales se encuentran organizadas dependiendo de la funcionalidad que ofrecen. Para realizar la correcta documentación de las interfaces, se utilizará la siguiente tabla: ID Componente Nombre Longitud mínima Longitud máxima Rango Ilustración 12. Modelo Documentación de Interfaces. Adaptado de [5]. En donde cada uno de los campos corresponde a:

36 Id Componente. Nombre.... Longitud Minima. Longitud Maxima... Hace referencia al identificador único del componente. Representa el nombre con el cual se denominará el componente. Indica cual es el objetivo del componente. Indica de que tipo es el componente. (Ejemplo jlabel, jtext). Es el tipo de dato o acción que recibe el componente. Valor minimo del dato ingresado. Valor Maximo del dato ingresado. Representa el valor definido por defecto. Representa como se validará este componente dentro del sistema. Ilustración 13. Descripción Documentación Interfaces 9.1 Interfaces Gráficas Interfaz Inicio Esta interfaz, que se muestra en la Ilustración 14. Interfaz de Inicio, tiene como objetivo iniciar la interacción entre el usuario y el sistema ERMT ya que por medio de está el usuario puede crear, abrir o eliminar un proyecto. 36

37 Ilustración 14. Interfaz de Inicio ID Componente C01 Nombre Crear Proyecto Indicar si la acción que desea realizar dentro del sistema es crear un nuevo proyecto. JRadioButton Clic del mouse 37

38 Longitud mínima Longitud máxima El componente es seleccionado. Tabla 6. Componente Nuevo Proyecto ID Componente C02 Nombre Abrir Proyecto Indicar si la acción que desea realizar dentro del sistema es abrir un proyecto. JRadioButton Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado. Tabla 7. Componente Abrir Proyecto ID Componente C03 Nombre Eliminar Proyecto Indicar si la acción que desea realizar dentro del sistema es eliminar un proyecto. 38

39 JRadioButton Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado. Tabla 8. Componente Eliminar Proyecto ID Componente C04 Nombre Aceptar Permite realizar la opción seleccionada. JButton Clic del mouse Longitud mínima Longitud máxima Se ha seleccionado un campo y se muestra la interfaz de la opción que se ha seleccionado. Tabla 9. Componente Botón Aceptar. 39

40 ID Componente C05 Nombre Salir Permite que el usuario salga del sistema, de manera correcta. jbutton Clic del mouse Longitud mínima Longitud máxima Ninguna Interfaz Crear Proyecto Tabla 10. Modelo Documentación de Interfaces. Una vez seleccionada la opción Crear Proyecto en la interfaz Inicio, descrita en la sección 9.1.1, se muestra la interfaz que de la Ilustración 15. Crear Proyecto, la cual ha sido creada con el fin de que el usuario ingrese los datos necesarios para crear un proyecto nuevo. 40

41 Ilustración 15. Crear Proyecto ID Componente C06 Nombre Identificador del Proyecto Conocer cuál es el identificador único que el sistema le asignará al nuevo proyecto. jtextfield 41

42 Int Longitud mínima 1 Longitud máxima 10 Ninguno El identificador a ser asignado es cargado dentro del campo de texto. Tabla 11. Componente Identificador Proyecto. ID Componente C07 Nombre Nombre Proyecto El usuario le asigna un nombre al proyecto que va a ser creado jtextfield String Longitud mínima 1 Longitud máxima 50 Ninguno El nombre del proyecto no sobrepasa la longitud máxima permitida. Tabla 12. Componente Nombre Proyecto ID Componente C08 Nombre Fecha de Creación 42

43 Tiene como fin conocer y asignarle al proyecto la fecha en la cual es creado. jtextfield Date Longitud mínima 8 Longitud máxima 30 Ninguno La información ingresada, corresponde a una fecha valida. Tabla 13. Componente Fecha de Creación ID Componente C09 Nombre Autor Asignarle al proyecto, el nombre del autor. jtextfield String Longitud mínima 5 Longitud máxima 50 Ninguno El nombre del autor no sobrepasa la longitud máxima permitida. Tabla 14. Componente Autor 43

44 ID Componente C43 Nombre Aceptar Crear el proyecto con los datos ingresados por el usuario jbutton Clic del mouse Longitud mínima Longitud máxima Ninguno El proyecto es creado, y el usuario recibe un mensaje de confirmación, en donde se le indica cual es el identificador único del proyecto. Tabla 15. Componente Crear Proyecto - Aceptar ID Componente C44 Nombre Cancelar Permite que el usuario regrese a la pantalla de inicio sin crear un nuevo proyecto jbutton Clic del mouse Longitud mínima Longitud máxima 44

45 Ninguno El usuario vuelve a la interfaz Inicio (ver Sección Interfaz Inicio), sin crear un proyecto Interfaz Menú Principal Tabla 16. Componente Crear Proyecto - Cancelar Una vez seleccionada la opción de Abrir Proyecto en la interfaz Inicio, descrita en la sección 9.1.1, Se muestra la interfaz de la Ilustración 16. Interfaz Menú Principal la cual ha sido creada con el fin de que el usuario seleccione la opción que representa la funcionalidad que desea realizar en el sistema. Ilustración 16. Interfaz Menú Principal 45

46 ID Componente C10 Nombre Consultar Información del Proyecto Indicar si la acción que desea realizar dentro del sistema es mostrar la información relacionada con un proyecto. jradiobutton. Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado. Tabla 17. Componente Consultar Información del Proyecto. ID Componente C11 Nombre Consultar información de un requerimiento Indicar si la acción que desea realizar dentro del sistema es mostrar la información relacionada con un requerimiento. jradiobutton. Clic del mouse Longitud mínima Longitud máxima 46

47 El componente es seleccionado. Tabla 18. Componente Consultar información de un requerimiento. ID Componente C12 Nombre Crear un nuevo requerimiento Indicar si la acción que desea realizar dentro del sistema es crear un nuevo requerimiento. jradiobutton. Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado. Tabla 19. Componente Crear un nuevo requerimiento. ID Componente C13 Nombre Eliminar un requerimiento Indicar si la acción que desea realizar dentro del sistema es eliminar un requerimiento existente. 47

48 jradiobutton. Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado. Tabla 20. Componente Eliminar un requerimiento. ID Componente C14 Nombre Generar Reporte Indicar si la acción que desea realizar dentro del sistema es Generar un reporte jradiobutton. Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado. Tabla 21. Componente Generar Reporte 48

49 ID Componente C15 Nombre Generar Grafo Indicar si la acción que desea realizar dentro del sistema es Generar el grafo de dependencias de los requerimientos. jradiobutton. Clic del mouse Longitud mínima Longitud máxima El componente es seleccionado Tabla 22. Componente Generar Grafo. ID Componente C45 Nombre Campo de Texto Permitirle al usuario indicar el requerimiento que desea consultar, siempre y cuando la opción seleccionada sea Consultar información de un requerimiento, (ver Componente C11). Este componente por defecto, esta desactivado. jtextfield. Int Longitud mínima 1 Longitud máxima 10 49

50 Ninguno. El componente se activa, y permite que el usuario ingrese un valor de tipo numérico. Tabla 23. Componente Campo de Texto. ID Componente C46 Nombre Aceptar Permitirle al usuario indicar el requerimiento que desea consultar, siempre y cuando la opción seleccionada sea Consultar información de un requerimiento, (ver Componente C11). Este componente por defecto, esta desactivado. jbutton Clic del mouse Longitud mínima Longitud máxima El componente permite que el usuario vaya a la interfaz de la opción seleccionada. Tabla 24. Componente Aceptar - Menú principal. ID Componente C47 Nombre Salir Permite que el usuario abandone la aplicación. 50

51 jbutton Clic del mouse Longitud mínima Longitud máxima La aplicación se cierra, sin alterar el estado de la base de datos. Tabla 25. Componente Cancelar - Menú principal Interfaz Consultar información del proyecto Al seleccionar la opción Consultar Información del proyecto, en la interfaz Menú Principal, descrita en la sección 9.1.3, se muestra la interfaz de la Ilustración 17. Consultar Información del Proyecto., la cual ha sido creada con el fin de mostrar la información relacionada con el proyecto. 51

52 Ilustración 17. Consultar Información del Proyecto. ID Componente C16 Nombre Identificador Único Muestra cuál es el identificador único del proyecto. jtextfield Int Longitud mínima 1 Longitud máxima 10 52

53 Ninguno El identificador del proyecto es mostrado dentro del campo. Tabla 26. Componente Identificador Único Mostrar Información. ID Componente C17 Nombre Nombre Muestra el nombre con el que fue creado el proyecto jtextfield String Longitud mínima 1 Longitud máxima 50 Ninguno El nombre del proyecto se muestra dentro del componente. Tabla 27. Componente Nombre Proyecto Mostrar Información. ID Componente C18 Nombre Autor Muestra el nombre del autor que creó el proyecto jtextfield 53

54 String Longitud mínima 5 Longitud máxima 50 Ninguno El nombre del autor se muestra dentro del componente. Tabla 28. Componente Autor Mostrar Información. ID Componente C19 Nombre Fecha de Creación Muestra la fecha en la cual ha sido creado el proyecto jtextfield Date Longitud mínima 8 Longitud máxima 30 Ninguno La fecha de creación se muestra dentro del componente. Tabla 29. Componente Fecha de Creación Mostrar Información. ID Componente C20 Nombre Fecha Modificación 54

55 Muestra la última fecha de modificación del proyecto jtextfield Date Longitud mínima 8 Longitud máxima 30 Ninguno La fecha de Modificación se muestra dentro del componente. Tabla 30. Componente Fecha Modificación Mostrar Información. ID Componente C21 Nombre Avance Muestra el porcentaje de implementación del proyecto. jtextfield Float Longitud mínima 1 Longitud máxima 5 0 El porcentaje de implementación del proyecto, se muestra dentro del componente. Tabla 31. Componente Avance Mostrar Información. 55

56 ID Componente C22 Nombre Numero de Reportes Muestra el número de reportes del proyecto, que se han generado jtextfield Int Longitud mínima 1 Longitud máxima 5 0 Se muestra dentro del componente el número de reportes que se han generado. Tabla 32. Componente Numero de reportes Mostrar Información. ID Componente C23 Nombre Regresar Permite que el usuario regrese a la interfaz del Menú principal. (ver Sección Interfaz Menú Principal) jbutton Clic del Mouse Longitud mínima Longitud máxima 56

57 El usuario vuelve a la interfaz Menú principal, (ver Sección Interfaz Menú Principal). Tabla 33. Componente Regresar Mostrar Información. ID Componente C24 Nombre Modificar Habilita los campos de texto que el usuario puede modificar, como lo son el componente de nombre y autor. jbutton Clic del Mouse Longitud mínima Longitud máxima Los campos de texto nombre (ver componente C17) y autor (ver componente C18) se activan para ser modificados. Tabla 34. Componente Modificar Mostrar Información Interfaz Consultar Información de un requerimiento Al seleccionar la opción Consultar Información de un requerimiento, en la interfaz Menú Principal, descrita en la sección 9.1.3, se muestra la interfaz de la Ilustración 18. Componente Consultar Información de un Requerimiento., la cual ha sido creada con el fin de mostrar la información relacionada con un requerimiento. 57

58 Ilustración 18. Componente Consultar Información de un Requerimiento. ID Componente C25 Nombre Identificador único del requerimiento. Mostrar el identificador único del requerimiento que se está consultando. jtextfield Int 58

59 Longitud mínima 1 Longitud máxima 10 Ninguno El identificador se muestra en el componente. Tabla 35. Componente Identificador único del requerimiento. ID Componente C26 Nombre Atributos que Describen el Requerimiento Mostrar todos y cada uno de los atributos que describen el requerimiento que se está consultando. jtable String Longitud mínima 2x2 Longitud máxima 22x22 Ninguno Los atributos se listan dentro de la tabla. Tabla 36. Componente Atributos que Describen el Requerimiento. ID Componente C27 Nombre Regresar Permite que el usuario vuelva a la interfaz Menú Principal 59

60 jbutton Clic del mouse. Longitud mínima Longitud máxima Ninguno Tabla 37. Componente Regresar Información Requerimiento ID Componente C48 Nombre Modificar Permite que el usuario realice cambios sobre los atributos que describen el requerimiento. jbutton Clic del mouse. Longitud mínima Longitud máxima Ninguno Tabla 38. Componente Modificar Información Requerimiento 60

61 ID Componente C49 Nombre Cancelar Permite que el usuario vuelva a la interfaz Menú principal, (ver Sección Interfaz Menú Principal) jbutton Clic del mouse. Longitud mínima Longitud máxima El usuario vuelve a la interfaz Menú principal, (ver Sección Interfaz Menú Principal). Tabla 39. Componente Cancelar Información Requerimiento Interfaz Seleccionar tipo de Reporte Al seleccionar la opción Generar un Reporte, en la interfaz Menú Principal, descrita en la sección 9.1.3, se muestra la interfaz de la Ilustración 19. Seleccionar de Reporte, la cual ha sido creada con el fin de que el usuario seleccione el tipo de reporte que desea generar. 61

62 Ilustración 19. Seleccionar de Reporte ID Componente C28 Nombre General Indicar si el reporte que el usuario desea generar es el reporte general jradiobutton 62

63 Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 40. Componente General. ID Componente C29 Nombre Requerimiento Indicar si el reporte que el usuario desea generar es el reporte de un requerimiento jradiobutton Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 41. Componente Requerimiento. ID Componente C30 Nombre Estado Indicar si el reporte que el usuario desea generar es el reporte de estado 63

64 o implementación jradiobutton Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 42. Componente Estado ID Componente C31 Nombre Trazabilidad Indicar si el reporte que el usuario desea generar es el reporte de trazabilidad. jradiobutton Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 43. Componente Trazabilidad. 64

65 ID Componente C32 Nombre Priorización Indicar si el reporte que el usuario desea generar es el reporte de priorización de requerimientos. jradiobutton Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 44. Componente Priorización. ID Componente C33 Nombre Requerimientos Rechazados Indicar si el reporte que el usuario desea generar es el reporte de requerimientos que tienen como estado Rechazado jradiobutton Longitud mínima Longitud máxima 65

66 El componente se encuentra seleccionado. Tabla 45. Componente Requerimientos Rechazados ID Componente C34 Nombre y Verificación Indicar si el reporte que el usuario desea generar es el reporte de validación y verificación del proyecto jradiobutton Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 46. Componente y Verificación. ID Componente C35 Nombre Historial de Cambios Indicar si el reporte que el usuario desea generar es el reporte del historial de cambios jradiobutton 66

67 Longitud mínima Longitud máxima El componente se encuentra seleccionado. Tabla 47. Componente Historial de cambios. ID Componente C50 Nombre Regresar Permite que el usuario vuelva a la interfaz Menú Principal, (ver Sección Interfaz Menú Principal) jbutton Longitud mínima Longitud máxima El usuario vuelve a la interfaz Menú principal, (ver Sección Interfaz Menú Principal). Tabla 48. Componente Regresar Seleccionar de Reporte. ID Componente C51 Nombre Aceptar 67

68 Permite que el sistema ERMT despliegue la Interfaz Formato Informe (ver sección Interfaz Formato Informe) jbutton Longitud mínima Longitud máxima Se despliega la interfaz Formato informe (ver sección Interfaz Formato Informe). Tabla 49. Componente Aceptar Seleccionar de Reporte Interfaz Formato Informe Al seleccionar el tipo de reporte, en la interfaz Generar reporte, descrita en la sección 9.1.6, se muestra la interfaz de la Ilustración 20. Generar Reportes, la cual ha sido creada con el fin de que el usuario seleccione el formato y los datos necesarios para generar el informe. 68

69 Ilustración 20. Generar Reportes ID Componente C36 Nombre Microsoft Office Word Indicar si el reporte que el usuario seleccionó en la interfaz descrita en la sección va a ser generado en el formato.docx jradiobutton Clic del Mouse 69

70 Longitud mínima Longitud máxima El componente esta seleccionado. Tabla 50. Componente Microsoft Office Word ID Componente C37 Nombre Microsoft Office Excel Indicar si el reporte que el usuario seleccionó en la interfaz descrita en la sección va a ser generado en el formato.xlsx jradiobutton Clic del Mouse Longitud mínima Longitud máxima El componente esta seleccionado. Tabla 51. Componente Microsoft Office Excel ID Componente C38 Nombre Nombre Le permite al usuario ingresar el nombre con el cual se generará el archivo. 70

71 jtextfield String Longitud mínima 7 Longitud máxima 50 Reporte El nombre del archivo es de tipo String Tabla 52. Componente Nombre - Reporte ID Componente C39 Nombre Fecha Le permite al usuario ingresar la fecha en la cual se generará el archivo. jtextfield Date Longitud mínima 8 Longitud máxima 50 Ninguno La fecha digitada es de formato date. Tabla 53. Componente Fecha - Reporte ID Componente C40 Nombre Autor 71

72 Le permite al usuario ingresar el nombre de la persona que genera el reporte jtextfield String Longitud mínima 2 Longitud máxima 50 Ninguno El usuario digita una cadena de texto Tabla 54. Componente Autor - Reporte ID Componente C41 Nombre Generar Le permite al usuario generar el reporte seleccionado. jbutton Clic del mouse Longitud mínima Na Longitud máxima Na Ninguno El reporte es generado, y es el que el cliente solicitó Tabla 55. Componente Generar - Reporte 72

73 ID Componente C42 Nombre Cancelar Le permite al usuario regresar al menú principal, sin generar ningún reporte jbutton Clic del mouse Longitud mínima Longitud máxima Ninguno El usuario regresa al menú principal Tabla 56. Componente Cancelar - Reporte 73

74 10 ANEXOS 10.1 Anexo 1: Documento de Casos de Uso VER DOCUMENTO DE WORD ANEXO Documento de CU.docx 10.2 Anexo 2: SRS VER DOCUMENTO DE WORD ANEXO SRS.docx 10.3 Anexo 3: Documentación del diagrama de clases VER DOCUMENTO DE WORD ANEXO documentación del diagrama de clases.docx 74