Documento Arquitectura De Software Rup h6z61

PU – Desarrollo de Programas 1

Sistema Antiplagium Documento de Arquitectura de SW Versión 3.0

Pág. 1 de 22

Sistema Antiplagium

Versión 2.0

Documento de Arquitectura de SW

Fecha

Versión

30/03/1 1.0 0 08/04/1 2.0 0

Pág. 2 de 22

Historia de Revisión Descripción Versión inicial Versión corregida

Autor Kim Alvarado / Patricia Natividad Kim Alvarado

Tabla de Contenido 1.

Introducción 1.1. Propósito 1.2. Alcance 1.3. Definiciones, acrónimos y abreviaturas 1.3.1. Definiciones 1.3.2. Acrónimos 1.4. Referencias 1.5. Visión General del documento 2. Representación de la arquitectura 3. Metas y Restricciones de la arquitectura 3.1. Metas 3.2. Restricciones del Sistema 4. Vista y Realizaciones de Casos de Uso 5. Vista Lógica 5.1 Descripción 5.2 Diseño en Capas 5.2.1 Capa Interfaz de 5.2.2 Capa Lógica del Negocio 5.2.3 Capa Persistencia 6. Vista de Proceso 6.1 Diagrama de clases 7. Vista de Despliegue 7.1 Servidor 7.2 PC Cliente 8. Vista de Implementación 8.1 Descripción 8.2 Niveles o Capas 8.2.1 Capa GUI 8.2.2 Capa Lógica del Negocio 8.2.3 Capa Base de Datos 9. Diagramas de Secuencia 9.1 Paquete de istración 9.1.1 Registrar 9.2 Buscar 9.2.1 Eliminar 9.2.2 Reporte de Acciones 9.2.3 Registrar Cuenta 9.3 Paquete de Gestión de Pagos 9.3.1 Registrar Documento de Pago 9.3.2 Anular Documento de Pago 9.3.3 Emitir Documentos de Pago en Lote 9.3.4 Buscar Documento de Pago 9.3.5 Registrar Pago 9.3.6 Registrar Descuento 9.3.7 Generar Reporte de Historial de Pago de Cliente 9.3.8 Generar Reporte de Historial de Pago por Periodo 9.5 Paquete de Cliente 9.5.1 Registrar Cliente 9.5.2 Modificar Cliente 9.5.3 Buscar Cliente 9.5.4 Registrar Contrato 9.5.5 Modificar Contrato 9.5.6 Buscar Contrato 10. Tamaño y performance 11. Calidad 11.1 Usabilidad

Pág. 3 de 22

5 5 5 5 5 5 6 6 7 7 7 7 8 13 13 15 16 16 16 16 16 18 19 19 20 20 20 20 20 20 21 21 21 21 22 22 23 24 24 24 25 25 26 26 27 27 31 31 31 32 32 33 33 36 37 37

11.2 11.3 11.4 11.5 11.6

Eficiencia Seguridad Confiabilidad Mantenimiento Estándares:

Pág. 4 de 22

37 37 37 37 37

Documento de Arquitectura de Software 1. Introducción Uno de los desarrollos más importantes dentro de la construcción del software es el desarrollo de la arquitectura de software, que permite representar la estructura del sistema, sirviendo de comunicación entre las personas involucradas en el desarrollo, además de ayudar a realizar el análisis para la toma de decisiones. Este documento provee al especializado una vista de la arquitectura del Sistema Antiplagium. La plantilla de este documento se basó en las especificaciones de RUP (Rational Unified Process) para el documento de arquitectura de software. 1.1.

Propósito

Este documento proporciona una descripción de la arquitectura del sistema, haciendo uso de diversas visiones arquitectónicas para representar diversos aspectos del sistema. Se realiza con el fin de documentar las decisiones de arquitectura significativas que se han tomado en el sistema. 1.2.

Alcance

Este documento presenta la arquitectura en la cual estará basado el Sistema para detección de plago Antiplagium, definiendo de manera detallada la distribución de los paquetes del sistema en las diversas capas que éste presenta, así como una descripción de las capas a utilizar. 1.3.

Definiciones, acrónimos y abreviaturas

Se brindan definiciones y acrónimos de términos usados en el presente documento que necesiten de alguna explicación para su correcta interpretación. 1.3.1.Definiciones Paquetes Actor Caso de Uso Star UML

Agrupaciones de casos de uso y actores por funcionalidad que proveen. Alguien o algo externo al sistema que interactúa con él. Secuencia de acciones que el sistema realiza, la cual proporciona un resultado de valor observable. Se refiere a las herramientas que permiten realizar el modelado de los diagramas presentados en este documento.

1.3.2.Acrónimos ERS RUP UML

Pág. 5 de 22

Especificación de Requisitos de Software Rational Unified Process Unified Modeling Language

1.4.

Referencias

Las referencias aplicables son: 1. Documento de Especificación de Requisitos del Sistema Antiplagium. 2. Documento de Visión del Sistema Antiplagium. 3. Plan de Proyecto del Sistema Antiplagium. 1.5.

Visión General del documento

En las diez secciones de este documento se detalla la arquitectura del software a desarrollar. Para ello se presenta de manera clara el caso de uso que mas representa la arquitectura del sistema, empleando un lenguaje sencillo y directo, así como gráficos y vistas de acuerdo a la metodología utilizada.

Pág. 6 de 22

2. Representación de la arquitectura La Arquitectura a utilizar será Cliente-Servidor. Se desarrollará una sola aplicación integrada, en la que solo se permitirá el a los s registrados en el sistema y a las tareas a las cuales tengan autorizado. Se empleará un solo servidor centralizado. La arquitectura se muestra como una serie de vistas, utilizando la aplicación Star UML. La arquitectura se basará en el modelo ‘4+1’, que contendrá las vistas de Lógica, Implementación, Procesos e Implantación, con la vista central de caso de uso.

3. Metas y Restricciones de la arquitectura La meta principal de la arquitectura del sistema es mostrar los aspectos principales que influirán en la etapa de desarrollo. Se tomarán en cuenta las siguientes metas y restricciones para el diseño de la arquitectura del sistema: 3.1.

Metas

1. El Sistema Antiplagium permitirá a los s acceder al sistema desde cualquier Terminal. 2. Para poder acceder al Sistema Antiplagium, se requiere de un código de válido así como de una contraseña. Además, dependiendo del perfil del se deshabilitarán opciones de manejo del Sistema para proteger información confidencial. 3. Los requerimientos estipulados en el Documento de Visión, deben de ser considerados como parte de la arquitectura del sistema a implementar. 4. El uso del sistema para los trabajadores de la Institución Educativa se limita a dentro de la organización. Fuera de ella no se podrá acceder al sistema. 3.2.

Restricciones del Sistema

1. El sistema usará PostgreSql como motor de Base de Datos necesariamente. Debe considerarse obligatorio la elaboración de una copia de rescate de las tablas para no afectar la información almacenada antes de poner en total funcionamiento al sistema. 2. Las características técnicas de las computadoras que serán utilizadas no deberán presentar potencias menores a las brindadas por una Pentium 4, con al menos 1 GB de RAM y 500 MB de espacio libre en el disco, con Sistema Operativo Linux. 3. Las computadoras que utilicen el sistema deberán de tener instalado el JRE 1.6 o superior ya que el mismo será desarrollado en java.

Pág. 7 de 22

4. Vista y Realizaciones de Casos de Uso El diagrama de casos de uso representa la forma de cómo el interactúa con el sistema a desarrollar, así podremos obtener el conjunto de escenarios que contendrá cada iteración. Cada caso de uso tiene una descripción que especifica la funcionalidad que se incorporará al sistema propuesto. En este apartado se mostraran los casos de uso del Sistema. 4.1

Paquete de s

Diagrama 1. Paquete de s CU_PU001.

4.2

Paquete de Documentos

Paquete Documentos Profesor Buscar Documentos

Gestionar Documentos Principal <<extend>> Buscar categoría de documentos



Gestionar categorías de documentos

Diagrama 2. Paquete de Documentos CU_PDOC001 Buscar Documentos Este caso de uso sirve para consultar por los documentos ingresados en la base de datos. CU_PDOC002 Gestionar Documentos Este caso de uso permite subir y eliminar documentos de la base de datos.

Pág. 8 de 22

CU_PDOC003 Buscar categoría de Documentos Este caso de uso permite consultar las categorías existentes para clasificar los documentos. CU_PDOC004 Gestionar categorías de documentos Este caso de uso permite registrar, modificar y eliminar categorías de clasificación de documentos.

4.3

Paquete de Detección

Paquete Deteccion

Profesor Comparar documentos

Mostrar resultados de comparación Principal

Diagrama 3. Paquete de Detección CU_PDET001 Comparar Documentos

Este caso de uso permite realizar la comparación para detección de plagio entre documentos (esto implica la implementación de un algoritmo adecuado). CU_PDET002 Mostrar resultados de comparación

Este caso de uso permite mostrar los resultados de comparaciones pasadas que se hayan realizado entre archivos y en un determinado rango de fechas.

Pág. 9 de 22

5. Vista Lógica 5.1

Descripción

La vista lógica del sistema Antiplagium está compuesta de cuatro paquetes principales: Interfaz de (GUI), servicios del Lógica (Logic), objetos de procesamiento (Entity) y los objetos de persistencia (Data Access Objects). El primer paquete, Interfaz de , contiene las clases visuales de la aplicación, las cuales crean las ventanas que utiliza el para comunicarse con el sistema para una adecuada y fácil utilización de los paquetes que se encuentran en las siguientes capas.

Interfaz de

El paquete Lógica contiene las clases que permiten llevar a cabo los servicios de procesamiento, como son: Controlar el mantenimiento de s, Mostrar resultados de comparaciones, etc.

Lógica del negocio (BL)

El paquete Entidades contiene las clases que utilizará el sistema Antiplagium, entre las principales clases se tiene: , Documento, Detector, Provilegio, etc.

Entidades del negocio (BE)

El paquete de Objetos de de Datos contiene las clases que el sistema utiliza para manejar la persistencia de los objetos con la Base de Datos.

a Datos (DA)

Pág. 10 de 22

5.2

Diseño en Capas

En la siguiente figura podemos observar la distribución de los paquetes en cada una de las capas del sistema. Interfaz de

Interfaz de

Lógica del negocio

Lògica del negocio

Entidades del negocio

Persistencia

a Datos

Base de Datos

Base de Datos

Figura .5.1: Diagrama de Distribución de Capas del Sistema

Pág. 11 de 22

5.2.1 Capa Interfaz de Esta capa contiene el paquete Interfaz de , el cual almacena todas las clases con las cuales el puede interactuar como lo son las ventanas. 5.2.2 Capa Lógica del Negocio Esta capa contiene los paquetes de Servicios de Negocio y Entidades de Negocio. Contiene la lógica para el manejo de las operaciones del negocio. 5.2.3 Capa Persistencia Esta capa contiene el paquete de Objetos de de Datos, que brinda una interfaz transparente para la interacción con la Base de Datos.

6. Vista de Proceso 6.1

Diagrama de clases

Es el diagrama principal para el análisis y diseño. En este diagrama se presentan las clases del sistema con sus relaciones estructurales y de herencia. Para establecer las clases, objetos atributos y operaciones entre clases se tomó como base a los diagramas de casos de uso. Figura 6.1: Vista del Diagrama de Clases

Detector

Operacion +idOperacion +nombre +descripcion

1

tiene

ResultadoComparacion

0..*

+idResultadoComparacion +fecha +porcentaje 0..* RegistroOperacion

1

0..* +RegistrarResultadoComparacion() +BuscarResultadoComparacion()

+idRegistroOperacion +fecha

registra

0..* 0..* 2do doc. comparado

0..*

realiza

tiene

1er doc. com 1parado

1 Rol +idRol +nombre

1

0..* pertenece

+RegistraRol() +EliminarRol() +ModificarRol() +BuscarRol() PrivilegioXRol

Privilegio +idPrivilegio +nombre +RegistrarPrivilegio() +BuscarPrivilegio() +EliminarPrivilegio()

Pág. 12 de 22

Documento

+id +nombres +apellidoPaterno +apellidoMaterno +alias + +fechaRegistro +estado

1

1 0..*

1 registra

+idDocumento +nombre +estado

0..*pertenece

+RegistrarDocumento() +BuscarDocumento() +EliminarDocumento()

1

+Registrar() +Modificar() +Eliminar() +Buscar()

Categoria +idArea +nombre +descripcion XCategoria

+RegistraCategoria() +BuscarCategoria() +EliminarCategoria()

7. Vista de Despliegue El presente Diagrama de Despliegue muestra de manera gráfica los nodos que conforman el sistema, además los describe indicando la localización de las tareas en los nodos físicos. Cada nodo representa un recurso de ejecución como una computadora o servidor y se encuentra conectado con otros mediante un enlace de comunicación. En este caso, la red será de tipo LAN. PC Cliente

Servidor

Red LAN Aplicación Antiplagium

Figura 7.1: Diagrama de Despliegue del Sistema. Servidor (Base de Datos) y Cliente (Computadora ).

Interfaz de

Lógica del Negocio

Entidades del Negocio

a Datos

Figura 7.2: Diagrama Componentes del Sistema.

Pág. 13 de 22

7.1

Servidor

El servidor principal donde se encuentra la Base de Datos. Los diferentes s tendrán al servidor vía LAN. 7.2

PC Cliente

Son las computadoras que son utilizadas por cada uno de los s de la empresa para acceder al sistema. Están conectadas directamente al servidor principal vía LAN.

Pág. 14 de 22

8. Vista de Implementación 8.1

Descripción

La vista de implementación seguirá el patrón de diseño MVC (Model View Controller). Este patrón plantea la separación del problema en tres capas: la capa model, la capa controller y la capa view. 8.2

Niveles o Capas

8.2.1 Capa GUI El componente GUI maneja las clases que permiten la interacción del con el sistema. 8.2.2 Capa Lógica Este componente permite manejar la lógica del negocio de todas las áreas involucradas.     

istración del Sistema s Privilegios Comparaciones Registro de documentos

8.2.3 Capa Base de Datos Este componente contiene toda la información que maneja el Sistema.

Aplicación Antiplagium

Sistema



Documento

Figura 8.1: Diagrama de Implementación del Sistema.

Pág. 15 de 22

9. Diagramas de Secuencia 9.1

Paquete de s

//Meter diagramas 9.2

Paquete de Documentos

Gestionar Categoría

Pág. 16 de 22

FrmCategoria

CategoriaBL

CategoriaDA

ConectionDA

: 1 : IngresarCategoriaDocumento() 2 : < >() GestorCategoria 3 : < >() 4 : Conectar() 5 : insertarCategoria(CategoriaBE)()

< > 6 7 : populate() 8 <<destroy>>

FrmCategoria

ConectionDA

CategoriaBL

9 : BuscarCategoria(codigo,nombre)() < > 10 < > 11

12 : Conectar()

13 : BuscarCategoria(codigo,nombre)()

14 : ObtenerCategoria()

15 : listaCategorias

16 : CategoriaBE()

17 : cargarCategoria() <<destroy>> 18

<<destroy>> 19

ConectionDA

CategoriaBL

FrmCategoria

20 : Categoria=SeleccionarCategoria()

21 : EliminarCategoria(Categoria)() < > 22 < > 23 24 : Conectar() 25 : EliminarCategoria(Categoria)()

Pág. 17 de 22

26 : EliminarCategoria(Categoria)()

Gestionar Documentos

FrmDocumento

DocumentoBE

CategoriaBL

ConectionDA

: Profesor 1 : IngresarDocumento() < > 2 3 : BuscarCategoria()

4 : BuscarCategoria() 5 : Conectar() 6 : ObtenerCategorias()

7 : listaCategorias 8 : CategoriasBE 9 : CargarCategorias() <<destroy>> 10 <<destroy>> 11 12 : validarCampos()

ConectionDA

DocumentoBL < > 13

< > 14

15 : Conectar()

16 : registrar(DocumentoBE)()

17 : insertar(documentoBE)()

<<destroy>> 18 <<destroy>> 19

<<destroy>> 20 21 : buscarDocumento(nombre,categoria,fecha)() DocumentoBL ConectionDA

22 : validarDatos() < > 23 < > 24

25 : conectar()

26 : buscarDocumento(nombre,categoria,fecha()

27 : obtenerDocumentos(nombre,categoria,fecha()

28 : listaDocumentos()

29 : DocumentoBE 30 : cargarDocumentos() <<destroy>> 31 <<destroy>> 32

DocumentoBL

33 : seleccionarDocumento()

ConectionDA

34 : eliminarDocumento() < > 35 < > 36

9.3

37 : conectar() 38 : eliminarDocumento(documentoBE)()

39 : eliminarDocumento(DocumentoBE)() <<destroy>> 40

Pág. 18 de 22

<<destroy>> 41

Paquete de Detección

Comparar Documentos

FrmDeteccion

DeteccionBL

DeteccionDA

ConectionDA

: Profesor

1 : MostrarResultadosComparacion() 2 : MostrarResultadosComparacion()

3 : ObtenerComparacion()

GestorResultados

4 : Conectar() < > 5 6 : populate() 7 : Desconectar()

8 : ObtenerDocumentos() GestorDocumentos

9 : Conectar() < > 10

Documento

11 : populate() 12 : Desconectar()

loop ObtencionResultados 13 : ObtenerCoincidencia()

14 : ObtenerOracion()

15 : ObtenerOracion()

Mostrar resultados comparación

Pág. 19 de 22

FrmDeteccion

DeteccionBL

DocumentoDA

ConectionDA

: Profesor 1 : IngresarDocumentoComparar()

loop IngresoDocumentos

2 : IngresarDocumentosSistema()

3 : ObtenerDocumentos()

4 : ObtenerDocumentos() 5 : Conectar() GestorDocumentos < > 6

7 : populate() 8 : Desconectar() Detector 9 < > loop ComparacionDocumentos 10 < > 11 : CompararDocumentos()

12 <<destroy>>

Pág. 20 de 22

10.

Tamaño y performance

La arquitectura de software elegida apoya los requisitos dominantes de capacidad en disco y latencia, según lo estipulado en el Documento de Especificación de Requisitos de Software de Antiplagium y el Documento de Visión del Proyecto del Sistema Antiplagium. 1. Tiempo de respuesta en el a la Base de Datos El sistema proveerá s a la base de datos con un tiempo de respuesta no mayor a los 5 segundos. 2. Tiempo de respuesta de transacciones El programa no demorará más de 15 minutos en generar reporte de comparación de documentos haciendo uso del algoritmo elegido y guardándolo en base de datos. 3. Espacio en disco para el cliente El espacio en disco necesario para la parte del cliente deberá tener como mínimo 500 MB de espacio libre para su correcto funcionamiento, esto incluye tanto el tamaño del software como el JRE 1.6. 4. Espacio en disco para el servidor de Base de datos El espacio en disco necesario para la parte del Servidor de Base de datos deberá tener como mínimo 1 GB libres en disco para su correcto funcionamiento. La arquitectura seleccionada apoya los requisitos de latencia y capacidad en disco en la puesta en práctica de una arquitectura cliente servidor. La porción del cliente solo se pone en ejecución en las PC locales de los distintos ambientes dentro de la empresa. Los componentes se han diseñado para asegurarse de obtener requisitos mínimos de disco y memoria en el lado de las PC del cliente.

Pág. 21 de 22

11.

Calidad

Para un mejor aprovechamiento de la arquitectura de software se dan los siguientes requerimientos de calidad: 11.1 Usabilidad El sistema permitirá un manejo intuitivo por parte de los s. 11.2 Eficiencia El programa no demorará más de 15 minutos en generar un reporte de comparación de documentos. 11.3 Seguridad El sistema permitirá el a funcionalidades dependiendo del perfil del que ingresa al sistema, validando su ingreso a través de una clave. 11.4 Confiabilidad El sistema tendrá en cuenta que la información ingresada en él sea válida, para lo cual mostrará mensajes que expliquen al acerca de los errores que éste pudiera cometer y de aquellos que pueda cometer el mismo sistema. 11.5 Mantenimiento El sistema será flexible, facilitando su mantenimiento futuro. 11.6 Estándares: Se usará un estándar para todas las ventanas e interfaces con el que tenga el Sistema Antiplagium, así como los nombres, códigos, etc.

Pág. 22 de 22