Sunteți pe pagina 1din 30

Sistema de información Events House

Sistema de Portal WEB (SPT)


Manual Técnico para el Sistema

Descripción y contenido del Manual Técnico

El Manual Técnico del Sistema debe estar estructurado e incluir contenidos


conforme al estándar de manual técnico descrito en el presente documento:

Tabla de Contenido
1. Propósito
2. Alcance
3. Documentos de referencia
4. Definiciones importantes
4.1. Conceptos generales
4.2. Procesos de entrada y salida
5. Descripción de módulos
6. Diccionario de datos
6.1. Modelo entidad-relación
6.2. Distribución física y lógica de base de datos
6.3. Tablas y vistas
6.4. Triggers
6.5. Restricciones especiales
6.6. Funciones de usuario, Stored Procedures y paquetes
6.7. Tareas programadas
6.8. Data Transformation Services (Bases de datos SQL Server)
7. Políticas de respaldo
7.1. Archivos
7.2. Base de datos
8. Descripción de interfaces con otros sistemas
9. Instalación y configuración
9.1. Requisitos generales pre-instalación
9.2. Detalles del proceso de instalación
9.3. Detalles de configuración de la aplicación
a. Variables de ambiente
b. Parámetros de aplicaciones
c. Archivos de configuración
d. Archivos de bitácora
e. Tareas programadas
9.4. Lista de contactos técnicos
10. Diseño de la arquitectura física
11. Procesos de continuidad y contingencia
12. Descripción de usuarios
12.1. Usuarios de base de datos
12.2. Usuarios de sistema operativo
12.3. Usuarios de aplicaciones

1
Sistema de información Events House

1.Propósito
Este manual debe proporcionar una guía para las principales actividades técnicas del
sistema de información Events House en la Institución de la Casa de Eventos y
Banquetes AMSAYUL, mediante la cual podrán verificar el funcionamiento técnico del
sistema, con cada uno de sus especificaciones e implementaciones (Disparadores,
restricciones, funciones, tareas programadas, entre otras opciones).

2. Alcance
El alcance el cual presenta el documento se basa en los desarrolladores que harán uso
del sistema desde el administrador hasta el empleado, evidenciándose en diferentes
procesos del sistema, mediante conocimientos básicos de manejo de equipos de
cómputo y se verá limitado mediante al acceso a Internet, las funciones
implementadas en el sistema van desde un registro de solicitud de cotización o
aspirante interesado en laborar en la casa de eventos hasta la misma aprobación de
los mismos, aplicando cambios de estado, asignaciones y validaciones. Se realizará
un respectivo mantenimiento en los procesos cuando exista una falla o alguna nueva
funcionalidad a utilizar, en la cual se puede utilizar mediante los clientes internos del
área de tecnología, implementando el nuevo código, el cual se encuentra sintetizado
mediante comentarios para así poder realizar la debida configuración, con los cambios
realizados se verán evaluados mediante los clientes externos, y con esto así se
aplicará la debida calidad del software.

3. Documentos de referencia

Los documentos utilizados para realizar el manual técnico se basaron desde el:
IEEE830
Documento de Arquitectura
Ley 1581 de 2012 Decreto 1377 de 2013 (para proteger los datos personales
registrados en cualquier base de datos)
Estatuto del Consumidor colombiano, Ley 1480 de 2011, como “Ventas a
distancia”.
Ley 527 de 1999, mejor conocida como “Ley de Comercio Electrónico” la cual dota de
efectos jurídicos concretos los datos que se compartan por medios electrónicos con
fines comerciales en tiendas online.

4. Definiciones importantes.
4.1. Conceptos generales
Backup: Copia de seguridad.
Events House: Sistema de información.
Cómputo: Computadores.
BD: Base de datos.
Triggers: Disparadores, acción que activa una nueva acción de forma inmediata.
Restricción: Limitación por parte de algún usuario del sistema.
Data Transformation Services: Servicios de transformación de datos, automatizando
la extracción, transformación y carga de datos, desde una base de datos.
MySQL = Gestor de base de datos, herramienta para el manejo de base de datos
relacional.

2
Sistema de información Events House

Tareas programadas = Acciones que realiza el sistema mediante cierto rango de


tiempo.
Interfaz = Zona de comunicación con el usuario.

Debe ser especificada toda la terminología necesaria para comprender el contexto de


la aplicación.
4.2. Procesos de entrada y salida
Deben ser descritos todos los procesos de entrada y salida que el aplicativo requiere
para su funcionamiento.

5. Descripción de módulos
“El Sistema de Información Events House consta de cuatro módulos: Cotización,
control de existencias, aprobación de empleados y el módulo de planeación y
ejecución del evento, en el cual se muestran las siguientes características:

Principalmente para poder realizar cualquier funcionalidad en el sistema debe de


contar con acceso a Internet.

Módulo de Cotización se abordará la generación de la solicitud indicando


los datos del evento formando así la solicitud en la que la secretaria realiza su
aprobación o cancelación, para así darle paso al módulo de control de
existencias, y para poder realizar la debida aprobación por parte de la secretaría
deberá de contar con solicitudes generadas con anterioridad.

Módulo de control de existencias se implementará el debido registro,


modificación, control de los implementos existentes dentro del sistema y la
asignación a los eventos para así buscar su respectivo cuidado y organización
del Stock, donde el administrador visualiza esta asignación gestionando así el
módulo de planeación y ejecución del evento, cada funcionalidad sea control,
modificación y/o asignación debe de contar con registros en el sistema.

Módulo de planeación y ejecución del evento se realiza la debida


asignación de los productos y empleados con el debido control de estos,
visualizandose en tres vistas Jefe de Bodega, Administrador y Empleado, las
funcionalidades se muestran mediante un registro previo tanto de productos o
empleados para así llevar a cabo correctamente el módulo.

Módulo de aprobación de personal se basará en la optimización del registro de datos


para los aspirantes y la aprobación, denegación, modificación de datos, funcionando
mediante la vista propia en el que ya no son aspirantes sino empleados del sistema
de información y poder llevar así el control de los empleados, este módulo depende
de la funcionalidad de la aprobación de empleados por parte de la secretaría y la cual
al gestionar la debida aprobación se podrá gestionar correctamente la modificación de
datos por el empleado en su respectiva vista. “

6. Diccionario de datos
Modelo entidad-relación

3
Sistema de información Events House

Modelo relacional del sistema

Distribución física y lógica de base de datos


Base de datos

4
Sistema de información Events House

Tablas
Alerta

Asignacion_Empleados

5
Sistema de información Events House

Aspirantes

Banquete

6
Sistema de información Events House

Cotización

Estado_Alerta

7
Sistema de información Events House

Estado_Asignacion_Empleado

Estado_Aspirante

8
Sistema de información Events House

Estado_Evento

Estado_Lugar

9
Sistema de información Events House

Estado_Notificacion

10
Sistema de información Events House

Estado_Solicitud

Estado_Trabajador

Estado_Usuario

11
Sistema de información Events House

Evento

Stock

12
Sistema de información Events House

Lugar

Notificación

13
Sistema de información Events House

Producto

Recordatorios

14
Sistema de información Events House

Rol_Ingreso

Rol_Trabajador

15
Sistema de información Events House

Ruta

Solicitud

16
Sistema de información Events House

Temática

Tipo_Implemento

17
Sistema de información Events House

Tipo_Lugar

Tipo_producto

18
Sistema de información Events House

Trabajador

Usuario

19
Sistema de información Events House

Tablas y vistas

Diccionario-Datos-Events-House

Triggers

6.4.1. Triggers N1
Nombre: Devolver Cantidad Stock
Descripción: El propósito del disparador es la devolucion de los productos asignados
a un evento después de la finalización de este.
Propietario: Tabla productos
Código del objeto

20
Sistema de información Events House

6.4.2. Triggers N2
Nombre: Suministrar Cantidad Stock
Descripción: El propósito del disparador es descontar la cantidad total del
implemento escogido dependiendo de la cantidad de productos requeridos para un
evento.
Propietario: Tabla productos
Código del objeto

21
Sistema de información Events House

6.4.3. Triggers N3
Nombre: Cotización After insert
Descripción:
Propietario: Tabla cotización
Código del objeto

6.4.3. Triggers N4
Nombre: Trabajador After insert
Descripción:
Propietario: Administrador
Código del objeto (cuando no sea confidencial): debe documentarse fecha de
creación, modificación, las variables, parámetros, condiciones especiales, etc.,
utilizadas y propósito de las mismas. Adicionalmente, cualquier comentario que facilite
la comprensión del código.

Restricciones especiales

No aplica

Funciones de usuario, Stored Procedures y paquetes

Procedimiento N1

22
Sistema de información Events House

Nombre: Ganancias Mensuales


Descripción: Comparar las ganancias de la casa de eventos mensualmente
Propietario:Cotización/Solicitud
Código del objeto:

Procedimiento N2
Nombre: Eventos solicitados
Descripción: Permite visualizar la cantidad de los eventos solicitados en el transcurso
del año 2019
Propietario:Solicitud/Evento
Código del objeto:

Procedimiento N3
Nombre: Cargo empleados
Descripción: Permite visualizar la cantidad total de empleados registrados en el
sistema mostrándose mediante cada uno de sus cargos.
Propietario:Aspirante/Rol Trabajador

23
Sistema de información Events House

Código del objeto:

6.7 Tareas programadas


Tarea programada N1
Nombre de la tarea: Desactivar empleados
Descripción/Propósito: Llevar el control de los empleados activos en el sistema de
información Events house.
Secuencia de acciones: Ejecuta una sentencia de actualización en el estado
empleado de la tabla Empleado cuando el usuario no ingresa al sistema en 3 meses.
Consecuencias de no ejecución: No habrán cambios secundarios.
Horarios de ejecución:01:00:00 a.m
Consideraciones antes de una ejecución manual: Cambio y actualización de
estados o gran cantidad de registros que no se manipulan.
Tarea programada N2
Nombre de la tarea: Eliminar Evento
Descripción/Propósito: Después de que realice un evento el sistema eliminará el
registro para optimizar el espacio de la BD.
Secuencia de acciones: Ejecuta una sentencia de eliminación en la tabla solicitud
cuando hayan pasado un mes desde la fecha de ejecución del evento.
Consecuencias de no ejecución: No habrán cambios secundarios.
Horarios de ejecución:01:00:00 a.m
Consideraciones antes de una ejecución manual: Cambio y actualización de
estados o gran cantidad de registros que no se manipulan.

7. Políticas de respaldo

Archivos

Mediante el respaldo de archivos tenemos como prioridad mantener copias de


seguridad tanto de nuestros clientes (cotizaciones), empleados (hoja de vida, foto),
reportes de sistema, desde las ganancias generadas hasta el ingreso de un empleado,
debido a que la información dictada anteriormente son el soporte de que se ha llevado

24
Sistema de información Events House

un proceso con algún usuario, realizando una copia en una periodicidad basada
semanalmente, utilizando almacenamientos fiables en la que el mal manejo de esta
información puede ocasionar ambigüedades, errores, entre otras opciones.
Base de datos
Mediante el respaldo de base de datos, donde almacena cada una de los datos del
sistema desde cotización hasta la vista del empleado, se realizará copia de seguridad
en una periodicidad de cada semana.

8. Instalación y configuración

Cada uno de estos apartados debe ser agrupado por servidor para garantizar su
adecuada descripción. Debe quedar claro el inventario de software de cada equipo.
Este detalle debe darse también para realizar la instalación de equipos- cliente de los
servidores.

8.1. Requisitos generales pre-instalación


En este apartado debe especificarse cada uno de los requisitos de hardware y software
de ambiente, necesarios para realizar sin problema el proceso de instalación. Es
recomendable especificar versiones de sistema operativo, paquetes adicionales,
actualizaciones necesarias, y el orden en que deben ser instalados cada uno.

8.2. Detalles del proceso de instalación


Debe mencionarse paso a paso cada uno de los detalles de instalación de la aplicación,
indicar los discos a utilizar, las versiones correctas, las opciones a seleccionar durante
la instalación, los sitios donde descargar actualizaciones, detalle de licencias, rutas
preferidas, y cualquier otra práctica recomendada, que sea mejor para obtener el
resultado esperado.

8.3. Detalles de configuración de la aplicación


Debe especificarse cualquier cambio a la configuración a tomarse en cuenta, luego de
finalizar el proceso de instalación; y sin el cual, la aplicación funcionará de manera
incorrecta. Por ejemplo: cambios de ruta, archivos, paquetes, valores, etc.

a.Variables de ambiente
Cualquier cambio en variables de ambiente, para sistemas operativos Windows o Unix,
debe ser documentado, mencionando el nombre de la variable, el nuevo valor, el
propósito, y cualquier otro detalle de interés.

b. Parámetros de aplicaciones
Debe documentarse cualquier cambio en los parámetros por defecto de las
aplicaciones, una vez instaladas. Es necesario indicar el nombre del parámetro, donde
localizarlo, el nuevo valor, el propósito, etc.

Archivos de configuración
En este apartado debe detallarse, el nombre de los archivos, su propósito, ubicacion,
y una breve descripción de los parámetros que contiene con sus posibles valores.

Archivos de bitácora
En caso de que la aplicación cuente con archivos de bitácora, debe mencionarse lo
siguiente:

25
Sistema de información Events House

Nombre del archivo


Ubicación en el equipo
Propósito del mismo
Historia que mantiene: definir si su comportamiento es cíclico, el tamaño promedio de
los archivos, la cantidad, y la forma de configurar este tipo de parámetros.

Tareas programadas
Cualquier tarea programada en el sistema operativo, o mediante herramientas de
terceros (excepto lo ya mencionado en el apartado 5.7), deben ser claramente
documentadas, incluyendo el nombre de la tarea, el propósito, secuencia de acciones,
consecuencias de no ejecución, horarios de ejecución, consideraciones antes de una
ejecución manual, y cualquier otro detalle que resulte de interés.
Lista de contactos técnicos
Debe especificarse una lista de personas a las cuales se les pueda notificar en caso de
problemas con el aplicativo y/o con el Hardware. Estos contactos deben incluir tanto
a personal del Banco como al personal del proveedor que brinda el servicio.

Nombre Empresa/Unidad Módulo que Teléfonos/Beeper


completo Ejecutora atiende
Carlos David Ejecución y 3142315004
Garcia Lopez SENA/ADSI planeación del
personal
Jorge Andres SENA/ADSI Cotización 3108125899
Garzon Paez
Estiven Aprobación del 3214703969
Fernando SENA/ADSI personal
Mampira Aldana
Jefferson David Control de 3058113089
Martinez SENA/ADSI existencias
Buitrago

10. Diseño de la arquitectura física


10.1. Módulo Cotización

26
Sistema de información Events House

10.2.Módulo Control de existencias

10.3. Módulo Aprobación del personal

27
Sistema de información Events House

10.4. Módulo Ejecución del personal

11. Procesos de continuidad y contingencia

28
Sistema de información Events House

El manejo de la continuidad y contingencia de la casa de eventos y banquetes


AMSAYUL en su sistema de información Events House se verá reflejada en cada una
de las funcionalidades en la plantilla IEEE 830 evidenciándose cada una de las
funcionalidades y requisitos o requerimientos solicitados por el cliente.

12. Descripción de usuarios

Usuarios de base de datos


Nombre del usuario:Administrador
Descripción/Propósito:El siguiente usuario de base de datos será el que tenga el
control total sobre la arquitectura de la bases de datos.
Privilegios: El usuario administrador tendrá un acceso total de todas las vistas,
funciones, tablas, triggers, procedimientos y tareas programadas de la base de datos
del sistema de información Events House.

Usuarios de sistema operativo


No aplica

Usuarios de aplicaciones
Usuario 1
Nombre del usuario : Administrador.
Descripción/Propósito: Este usuario tendrá como función principal la generación y
control de la cotizaciones de los clientes, también la asignación de empleados a los
eventos , consultas sobre reportes estadísticos de los eventos(ganancias) , y la opción
de enviar alertas, notificaciones y correos a todos los usuarios del sistema.
Privilegios dentro de la aplicación:
Consultar cotizaciones.
Cancelar cotización.
Devolver cotización.
Asignar Personal.
Consultar personal.
Eliminar personal.
Editar cargo personal.
Editar estado del personal.
Despedir personal.
Registra eliminar, editar y consultar Eventos, lugares, temáticas y usuarios.
Cambiar sus datos(nombre, apellido, foto, teléfono y contraseña).
Enviar alertas, notificaciones y/o correos.
Cambiar el idioma.

Usuario 2
Nombre del usuario : Secretaria.
Descripción/Propósito: Este usuario tendrá como función principal la aprobación
tanto de solicitudes de los clientes como solicitudes de trabajo de los aspirantes.
Privilegios dentro de la aplicación:
Consultar solicitudes.

29
Sistema de información Events House

Aprobar solicitudes.
Denegar solicitudes.
Consultar aspirantes.
Contratar aspirantes.
Denegar aspirantes.
Consultar empleados.
Cambiar sus datos(nombre, apellido, foto, teléfono y contraseña).
Responder notificaciones.
Cambiar el idioma.
Usuario 3
Nombre del usuario : Jefe bodega.
Descripción/Propósito: Este usuario tendrá como función principal la asignación de
productos un evento y control de las existencias de la empresa.
Privilegios dentro de la aplicación:
Consultar inventario.
Agregar implementos.
Editar implementos.
Eliminar implementos.
Consultar eventos.
Asignar productos
Consultar Productos
Editar productos
Retirar productos.
Cambiar sus datos(nombre, apellido, foto, teléfono y contraseña).
Responder notificaciones.
Cambiar el idioma.
Usuario 4
Nombre del usuario : Empleado.
Descripción/Propósito: Este usuario tendrá como función principal la consulta de
los eventos a los cuales está asignado.
Privilegios dentro de la aplicación:
Consultar eventos.
Cambiar sus datos(nombre, apellido, foto, teléfono y contraseña).
Responder notificaciones.
Cambiar el idioma.
Usuario 5
Nombre del usuario : Cliente.
Descripción/Propósito: Este usuario tendrá como función principal la generación
solicitud de un evento.
Privilegios dentro de la aplicación:
Consultar solicitudes.
Eliminar solicitudes.
Consultar cotización.
Confirmar cotización.
Generar solicitud.
Cambiar sus datos(nombre, apellido, foto, teléfono y contraseña).
Responder notificaciones.
Cambiar el idioma.

30

S-ar putea să vă placă și