Plantilla para realizar el manual de sistema o del analista

UNIVERSIDAD DEL ZULIA FACULTAD EXPERIMENTAL DE CIENCIAS

SERVICIO COMUNITARIO DE LA FEC

Manual del Analista Del Sistema Web de

Servicio Comunitario de la FEC

Autor: Neira Betancourt

Maracaibo, Marzo 2011

Índice General

Pág.

MINUTAS ......................................................................................................................... 7

MAPA DE NAVEGACIÓN ................................................................................................ 9

CASOS DE USOS .......................................................................................................... 11

TABLA DE DATOS ......................................................................................................... 19

DESCRIPCIÓN DE LOS MÓDULOS Y RELACIONES CON FUENTES Y TABLAS DE LA BASE DE DATOS ..................................................................................................... 23

REQUISITOS MÍNIMOS DEL SISTEMA ........................................................................ 28

INSTALACIÓN CLIENTE-SERVIDOR ........................................................................... 30

Índice de Tablas

Tablas Título Pág.

Nº 1 Curso típico y Excepcional del Caso de Uso Registro 18-19

Nº 2 Curso típico y Excepcional del Caso de Uso Actividades del Estudiantes

19-20

Nº 3 Curso típico y Excepcional del Caso de Uso Cambiar Contraseña

20-21

Nº 4 Curso típico y Excepcional del Caso de Uso Validar Actividades del Estudiante

21-22

Nº 5 Curso típico y Excepcional del Caso de Uso Proyecto Nuevo 22-23

Nº 6 Curso típico y Excepcional del Caso de Uso Modificar Proyecto 23-24

Nº 7 Curso típico y Excepcional del Caso de Uso Asignar Actividades a Proyecto

24-25


Nº 8 Curso típico y Excepcional del Caso de Uso Asignar Lugares a Proyecto

25-26

Nº 9 Curso típico y Excepcional del Caso de Uso Asignar Tutores a Proyecto

26-27

Nº 10 Curso típico y Excepcional del Caso de Uso Asignar Tutores a Estudiantes de un Proyecto

27-28

Nº 11 Curso típico y Excepcional del Caso de Uso Ingresar Fotografías a un Proyecto

28-29

Nº 12 Curso típico y Excepcional del Caso de Uso Designar Coordinadores

29-30

Nº 13 Curso típico y Excepcional del Caso de Uso Bienes de un Proyecto

30-31

Nº 14 Curso típico y Excepcional del Caso de Uso Estatus de Estudiantes

31-32

Nº 15 Curso típico y Excepcional del Caso de Uso Ingresar Número de Planilla

32-33

Nº 16 Leyenda del Diccionario de Datos 36

Nº 17 Diccionario de Datos. Tabla Actividad_Estudiante 36

Nº 18 Diccionario de Datos. Tabla Actividad_Proyecto 37

Nº 19 Diccionario de Datos. Tabla Bienes_Proyecto 37-38


Nº 20 Diccionario de Datos. Tabla Carrera 38

Nº 21 Diccionario de Datos. Tabla Carrera_Estudiante 38-39

Nº 22 Diccionario de Datos. Tabla Carrera_Profesor 39

Nº 23 Diccionario de Datos. Tabla EstadoDelRegistro 39-40

Nº 24 Diccionario de Datos. Tabla Estudiante 40-41

Nº 25 Diccionario de Datos. Tabla Facultad 41

Nº 26 Diccionario de Datos. Tabla Lugar_Ejecucion 42

Nº 27 Diccionario de Datos. Tabla Municipio 42

Nº 28 Diccionario de Datos. Tabla NivelDeUsuario 43

Nº 29 Diccionario de Datos. Tabla NivelProfesor 43

Nº 30 Diccionario de Datos. Tabla Noticia 43-44

Nº 31 Diccionario de Datos. Tabla Núcleo. 44

Nº 32 Diccionario de Datos. Tabla Parroquia. 44-45

Nº 33 Diccionario de Datos. Tabla Prestamo_Bien. 45-46

Nº 34 Diccionario de Datos. Tabla Profesor. 46-47


Nº 35 Diccionario de Datos. Tabla Proyecto. 47-48

Nº 36 Diccionario de Datos. Tabla Proyecto_Carrera. 48

Nº 37 Diccionario de Datos. Tabla Proyecto_Galeria. 48-49

Nº 38 Diccionario de Datos. Tabla Proyecto_Lugar_Ejecucion. 49

Nº 39 Diccionario de Datos. Tabla Registro. 49-51

Nº 40 Diccionario de Datos. Tabla Responsable. 51-52

Nº 41 Diccionario de Datos. Tabla Tutor_Proyecto. 52

Nº 42 Leyenda de la descripción de módulos 54

Nº 43 Descripción del Módulo Estudiante 54-57

Nº 44 Descripción del Módulo Tutor 58-60

Nº 45 Descripción del Módulo Coordinadores 60-73

Nº 46 Descripción del Módulo Reportes para ambos Coordinadores 74-78

Nº 47 Descripción del Módulo Estadísticas para el Coordinador de Facultad

78-81

Nº 48 Descripción del Módulo Usuario en General 81-84

Nº 49 Descripción de los Requisitos mínimos del sistema (Hardware y 86


Software)

Nº 50 Pasos para la instalación Cliente – Servidor 88

Figuras Título Pág.

Nº 1 Minuta de Reunión Nº 1 8



Nº 4 Mapa de Navegación del Servicio Comunitario 12

Nº 5 Caso de Uso- Usuario General 14

Nº 6 Caso de Uso- Estudiante 15

Nº 7 Caso de Uso- Tutor 16

Nº 8 Caso de Uso- Coordinadores 17

Nº 9 Modelo Entidad Relación Real. Servicio Comunitario 35

MINUTAS

Figura 1: Minuta de Reunión Nº 1.

Fuente: Betancourt, 2011

MAPA DE NAVEGACIÓN

10

Figura 4: Mapa de Navegación del Servicio Comunitario. Fuente: Betancourt, 2011

CASOS DE USOS

12

Figura 5: Caso de Uso- Usuario General.


13

Figura 6: Caso de Uso- Estudiante.


14

Figura 7: Caso de Uso- Tutor.


15

Figura 8: Caso de Uso- Coordinadores.


16

Nombre C.U Registro Id. C.U CU-001

Actores Estudiante

Descripción Permite al Estudiante registrarse en un proyecto de Servicio Comunitario que este activo en su carrera.

Casos de Usos relacionados Validar Usuario, Actividades, Imprimir, Ver Estatus.

Entradas Datos del estudiante y del registro.

Salidas Registro realizado con éxito.

Curso Típico

Acción del Actor Respuesta del Sistema

1. El estudiante introduce su usuario y contraseña.

1. El sistema verifica que el usuario esta en el sistema.

2. El sistema verifica que el registro esta activo.

3. El usuario llena el formulario del registro.

4. El sistema verifica que el proyecto tenga cupos.

5. El sistema verifica que el usuario no esté registrado en ese proyecto.

6. El sistema muestra mensaje de registro exitoso.

7. El sistema genera el comprobante de registro.

Curso Excepcional #1: El usuario no está en el sistema

Precondición En el paso 1 del flujo típico, el usuario introduce el usuario y la contraseña.


1. El sistema muestra un mensaje de que el usuario o la contraseña son inválidos.

2. El sistema muestra un mensaje, indicando que el usuario no existe en el sistema.

3. El caso de uso continúa en el paso 1 del flujo principal.

Curso Excepcional #2: El Registro no está activo

Precondición En el paso 3 del flujo típico, el sistema verifica si el registro esta activo.


1. El sistema muestra un mensaje, indicando que el registro no está activo en ese momento.


Curso Excepcional #3: El sistema verifica si tiene cupos el proyecto

Precondición En el paso 5 del flujo típico, el sistema verifica si el proyecto tiene cupos disponibles.


1. El sistema encuentra que no hay cupos disponibles

2. El sistema muestra un mensaje, indicando que no hay cupos disponibles en ese proyecto.


Curso Excepcional #4: El usuario ya está registrado en el proyecto

Precondición En el paso 6 del flujo típico, el sistema verifica si el usuario esta registrado en ese proyecto.


17

Nombre C.U Registro Id. C.U CU-001

Actores Estudiante

Descripción Permite al Estudiante registrarse en un proyecto de Servicio Comunitario que este activo en su carrera.

1. El sistema consigue que el usuario ya está registrado.

2. El sistema muestra un mensaje, indicando al usuario que ya está inscrito.

3. El sistema muestra un mensaje indicando que se actualizarán sus datos.


Tabla Nº 1. Curso típico y Excepcional del Caso de Uso Registro. Fuente: Betancourt, 2011

Nombre C.U

Actividades del Estudiante

Id. C.U CU-002

Actores Estudiante

Descripción Permite al Estudiante registrar las actividades que va realizando del proyecto en el cual se registró en el Servicio Comunitario.

Casos de Usos relacionados

Validar Usuario, Imprimir, Registro.

Entradas Datos de las actividades del estudiante.

Salidas Actividad ha sido guardada.

Curso Típico


1. El usuario introduce su usuario y su contraseña.

2. El sistema verifica los datos del estudiante.

3. El sistema verifica que el estudiante está registrado en algún proyecto.

4. El sistema verifica si el estudiante no ha culminado las horas de Servicio Comunitario.

5. El usuario introduce los datos de la actividad.

6. El sistema verifica que estén llenos todos los campos.

7. El sistema muestra un mensaje indicando que la actividad ha sido guardada.

Curso Excepcional #1: El usuario no está en el sistema

Precondición En el paso 1 del flujo típico, el usuario introduce el usuario y la contraseña.


1. El sistema muestra un mensaje de que el usuario o la contraseña son inválidos.

2. El sistema muestra un mensaje, indicando que el usuario no existe en el sistema.

3. El caso de uso continúa en el paso 1 del flujo principal

Curso Excepcional #2: El estudiante no está registrado en un proyecto de Servicio Comunitario

Precondición En el paso 3 del flujo típico, se verifica si el estudiante está registrado en algún

18

Nombre C.U

Actividades del Estudiante

Id. C.U CU-002

Actores Estudiante

Descripción Permite al Estudiante registrar las actividades que va realizando del proyecto en el cual se registró en el Servicio Comunitario.

proyecto.


1. El sistema muestra un mensaje indicando que el estudiante no se encuentra registrado en ningún proyecto de Servicio Comunitario.


Curso Excepcional #3: El estudiante ya culminó las horas de Servicio Comunitario

Precondición En el paso 4 del flujo típico, se verifica si el estudiante ya culminó las 120 de horas de prestación del servicio comunitario.


1. El sistema muestra un mensaje indicando que ya el estudiante culminó las 120 horas de prestación del servicio comunitario e indica si ya está aprobado o si le falta entregar el informe final.

2. El caso de uso continúa en el paso 4 del flujo principal

Tabla Nº 2. Curso típico y Excepcional del Caso de Uso Actividades del Estudiantes. Fuente: Betancourt, 2011

TABLA DE DATOS

Figura 9: Modelo Entidad Relación Real. Servicio Comunitario


Tabla Nº 16: Leyenda del Diccionario de Datos Fuente: Betancourt, 2011

Tabla Nº 1 Descripción

Actividad_Estudiante {Los estudiantes registrados en uno o más proyectos van ingresando sus actividades en esta tabla, las cuales serán validadas por los tutores.}

Campos de la Tabla

Nombre Tipo de dato

Acepta Null

Descripción

Id_Actividad INT

X

{Clave primaria, es de tipo numérico y se autoincrementa. No puede repetir valores. }

Id_registro INT

X

{Clave foránea de la tabla registro, es de tipo numérico. Representa el número de registro del estudiante.}

Id_carrera SMALLINT

X

{Es de tipo numérico, representa el número de la Carrera a la cual está adscrito el estudiante.}

Id_Estudiante INT

X

{Es de tipo numérico, representa el identificador del estudiante.}

Código_proyecto CHAR

X

{Es de tipo carácter, acepta hasta 20 caracteres. Representa el código del proyecto en el cual se registro el estudiante.}

Descripcion VARCHAR

X

{Es de tipo carácter, acepta hasta mil caracteres, describe la actividad que va realizando el estudiante en el proyecto en el cual se registro }

Horas INT

X

{Es de tipo numérico, representa el número de horas que duró el estudiante realizando la actividad descrita.}

Revisado CHAR

{Es de tipo carácter. Acepta los valores=[Aprobado |No Aprobado], Se verifica si la actividad descrita fue aprobada o no por el tutor. }

Fecha_actividad DATETIME

X

{Acepta sólo fechas, formato= dd/mm/aa. Representa la fecha en la que fue realizada la actividad.}

Id_lugar

INT

{Clave foránea de la tabla Lugar_Ejecucion. Es de tipo numérico. Representa el id del lugar donde el estudiante realizó la actividad.}

Tabla Nº 17: Diccionario de Datos. Tabla Actividad_Estudiante


Tabla Nº [número asociado a la tabla] Descripción

[Nombre físico de la tabla en la base de datos]

[Descripción de la tabla con sus datos almacenados en la base de datos]

Campos de la Tabla

Nombre Tipo de Dato Acepta NULL Descripción

[Nombre físico del

campo]

[Tipo de dato del

campo]

[Indica si el campo acepta valores de tipo Null. {X}=no acepta].

[Descripción detallada del valor almacenado

en el campo].

Tabla Nº2 Descripción

Actividad_Proyecto

{Se guardan las actividades de los proyectos que son fijas sí las tiene}

Campos de la Tabla

Nombre Tipo de Dato

Acepta NULL

Descripción

Id_actividadproyecto INT

X

{Clave primaria. Es de tipo numérico y se autoincrementa. No acepta valores repetidos.}

Codigo_proyecto CHAR

X

{Clave foránea. Es de tipo carácter. Guarda el código del proyecto al cual pertenece la actividad. }

Descripción_actividad VARCHAR

X

{Describe la actividad a guardar. Es de tipo carácter. Acepta hasta 1000 caracteres.}

Id_carrera SMALLINT

X

{Clave foránea. Es de tipo entero. Guarda el id de la carrera a la cual pertenece el proyecto en el cual se incluye la actividad.}

estado CHAR

{Es de tipo carácter. Acepta el valor= [INACTIVO]. Permite poner inactiva alguna actividad que ya no se vaya a realizar en algún proyecto.}

Tabla Nº 18: Diccionario de Datos. Tabla Actividad_Proyecto Fuente: Betancourt, 2011

Descripción de los módulos y relaciones con fuentes y

tablas de la base de datos

24

Módulo: {Define el nombre del nombre.}

Descripción: {Permite describir lo que contiene el módulo.}

Fuentes Descripción Relación con las tablas de la base de datos

{Define el nombre de cada página web (.php) que contiene el módulo.}

{Describe lo que hace cada fuente (página web).}

Vistas:{Relaciona la fuente con las tablas de la base de datos mediante la cláusula (select), con el siguiente formato: SC_VISTA_NOMREVISTA, donde SC: Servicio Comunitario, VISTA: que se relaciona a través de una vista con las tablas, NOMBREVISTA: describe el nombre de la vista.}

Procedimientos almacenados:{almacena los datos en la base de datos mediante un procedimiento, utiliza las cláusulas (insert, uptade y delete), con el siguiente formato: EXECUTE SC_NOMBREPROCEDURE, donde EXECUTE: nombre con el que se ejecuta el procedimiento, SC: Servicio Comunitario, NOMBREPROCEDURE: describe el nombre del procedimiento almacenado.}

Tabla Nº 42: Leyenda de la descripción de módulos Fuente: Betancourt, 2011.

Módulo: Estudiante Descripción: Permite al estudiante registrarse en proyectos aperturados de Servicio Comunitario, llevar un control de las actividades que va realizando, ver la lista de proyectos aperturados, ver su estatus, la opción de imprimir su registro, lista de actividades y su estatus.

Fuentes Descripción de las

fuentes

Relación con las Tablas de la BD

Vistas de las tablas Procedimientos Almacenados

Actividadproyecto.php

Permite al estudiante ingresar los datos de las actividades que va realizando en su Servicio Comunitario a través de un formulario.

SC_VISTA_SUMAHORAS SC_VISTA_DATOSACTIVIDAD SC_VISTA_ACTIVIDADPROYECTO SC_VISTA_LUGARESDEEJECUCION

Actualizarperiodoregistro.php

Permite al estudiante actual su fecha de registro, es decir el periodo en el cual se registró, si al momento de registrarse le aparece el mensaje indicando que ya está registrado en ese proyecto y que puede actualizarlo si lo desea.

EXECUTE SC_ACTUALIZARPERIODODEREGISTRO

Cambiodecarrera.php

Permite al estudiante cambiar de carrera si está cursando más de una carrera en la Universidad del Zulia y tiene proyectos comunitarios en ambas

SC_VISTA_VERIFICARESTUDIANTE

25



fuentes



carreras.

Estudiantes.php

Le muestra al estudiante un mensaje de bienvenida al sistema y las opciones del menú.

imprimir_actividad.php

Permite al estudiante imprimir su comprobante de las actividades que va realizando en su Servicio Comunitario.

SC_VISTA_CARRERA SC_VISTA_NOMBREPROYECTO SC_VISTA_DATOSESTUDIANTES SC_VISTA_DATOSACTIVIDAD SC_VISTA_SUMAHORASPORPROYECTO

imprimir_registro.php

Permite al estudiante imprimir su comprobante de registro.

SC_VISTA_REGISTRO SC_VISTA_DATOSESTUDIANTES

Insertaractividad.php

Permite guardar en la base de datos la información de las actividades que va realizando el estudiante.

SC_VISTA_DATOSACTIVIDAD

EXECUTE SC_ACTUALIZAR_FECHAINICIODELREGISTRO EXECUTE SC_INSERTAR_ACTIVIDADESTUDIANTE

Insertarestudiante.php

Guarda los datos personales de los estudiantes a la hora de registrarse en el sistema.

SC_VISTA_VERIFICARCEDULA SC_VISTA_BUSCARIDESTUDIANTE

EXECUTE SC_INSERTAR_ESTUDIANTE

insertarRegistro.php

Permite guardar los datos del proyecto en el cual se registro el estudiante en la base de datos.

SC_VISTA_CARRERA SC_VISTA_REGISTRO

EXECUTE SC_INSERTAR_REGISTRO EXECUTE SC_ACTUALIZAR_CUPOSDELPROYECTO EXECUTE SC_ACTUALIZAR_ESTATUSREGISTRO

Cambiodeclave.php

Permite al estudiante cambiar su contraseña actual por otra para poder ingresar al sistema.

SC_VISTA_VERIFICARCEDULA

EXECUTE SC_CAMBIARCLAVEESTUDIANTE

pre-registro.php

Muestra al estudiante un mensaje con los pasos que debe seguir para registrarse en un

26



fuentes



proyecto de servicio comunitario.

proyectos-actividad.php

Permite al estudiante ver el listado de los proyectos en los cuales se encuentra registrado para seleccionar en cual va a ingresar la actividad que realizó.

SC_VISTA_REGISTRO

proyectosOfertados.php

Permite al estudiante ver los proyectos que están aperturados en su carrera, junto a los tutores asignados a cada uno de los proyectos.

SC_VISTA_CARRERA SC_VISTA_PROYECTODATOS SC_VISTA_ACTIVIDADPROYECTO SC_VISTA_DATOSTUTORPROYECTO

Registrarestudiante.php

Le muestra al estudiante un formulario para que ingrese todos sus datos personales para que pueda acceder al sistema.

Registro.php

Muestra al estudiante el formulario para registrarse en un proyecto de servicio comunitario, selecciona el proyecto y pasa a la página de registro2.php

SC_VISTA_VERESTADOREGISTRO SC_VISTA_PROYECTODATOS

registro2.php

Después de haber seleccionado el estudiante el proyecto en el cual desea registrarse, aparecerá el código del proyecto con los demás datos del formulario que debe llenar el estudiante.

SC_VISTA_NOMBREPROYECTO

selec_imprimiractividad.php

Muestra al estudiante el listado de los proyectos en los cuales se encuentra registrado para que lo seleccione y pueda imprimir la planilla de horas.

SC_VISTA_REGISTRO

27



fuentes



selec_imprimiregistro.php

Muestra al estudiante el listado de los proyectos en los cuales se encuentra registrado para que lo seleccione y pueda imprimir la planilla de registro.

SC_VISTA_REGISTRO

selec_imprimirestatus.php

Muestra al estudiante el listado de los proyectos en los cuales se encuentra registrado para que lo seleccione y pueda imprimir la planilla con su estatus.

SC_VISTA_REGISTRO

status_registro.php

Permite al estudiante ver su estatus por cada proyecto en el cual se encuentra registrado.

SC_VISTA_REGISTRO SC_VISTA_DATOSPROFESOR SC_VISTA_DATOSESTUDIANTES SC_VISTA_SUMAHORASPORPROYECTO SC_VISTA_DATOSACTIVIDAD

status_registroImprimir.php

Permite al estudiante imprimir la planilla de su estatus por cada proyecto de servicio comunitario en el cual se encuentra registrado.

SC_VISTA_REGISTRO SC_VISTA_DATOSPROFESOR SC_VISTA_DATOSESTUDIANTES SC_VISTA_SUMAHORASPORPROYECTO SC_VISTA_DATOSACTIVIDAD

ventanadeErrores.php

Muestra en pantalla algún error que el estudiante comete durante su paseo por el menú del estudiante indicando que hizo algo mal.

Tabla Nº 43: Descripción del Módulo Estudiante Fuente: Betancourt, 2011.

Requisitos mínimos del sistema

29

Sistema

Hardware Software

Para el desarrollo Para su ejecución Para el desarrollo Para su ejecución

Pentium IV

Memoria Ram 1GB Disco duro 40GB

Cliente: Pentium IV


Servidor: Pentium IV


Editor de Contenido: Adobe Dreamweaver CS4. Lenguaje de Programación PHP. Servidor Web Apache (WampServer 2.0). Gestor de Base de Datos SQLSERVER 2000. Sistema Operativo Windows.

Conexión a Internet Sistema Operativo Windows Server 2003

Servidor Web Apache (WampServer 2.0). Gestor de Base de Datos SQLSERVER 2000.

Tabla Nº 49: Descripción de los Requisitos mínimos del sistema (Hardware y Software) Fuente: Betancourt, 2011.

Instalación Cliente-Servidor

31

Cliente

Internet, Safari, Mozilla, Google Crome Pdf, Office Excel

Servidor

Aplicación: WAMPSERVER 2.0 Configuración: Instalación típica siguiendo los pasos del software de instalación (no se necesita un configuración específica.)

Aplicación: PHP (Instalado en el WampServer) Configuración: El PHP por defecto trae las extensiones de PDO, MSSQL y ODBC deshabilitadas, para el buen funcionamiento de la base de datos se procedió a configurar el php.ini de la siguiente manera: 1 2 3

Aplicación: SQLSERVER 2000 Configuración: Instalación típica siguiendo los pasos del software de instalación (no se necesita un configuración específica.)

Tabla Nº 50: Pasos para la instalación Cliente - Servidor Fuente: Betancourt, 2011.