manual tecnico.doc
TRANSCRIPT
Sistema BDPSystem V3Manual técnico
JORGE ALBERTO LOZANO CHARRY201021808
DANIEL HERNAN MELGAREJO RODRIGUEZ201021767
DAVID MORALES RIVERA201011083
Presentado a la Ingeniera:ANDREA ALARCON
UNIVERSIDAD PEDAGÓGICA Y TECNOLÓGICA DE COLOMBIAFACULTAD DE INGENIERÍA
ESCUELA DE SISTEMAS Y COMPUTACIÓNTUNJA2014
Tabla de Contenido 1. Propósito
1
2. Alcance3. Documentos de referencia4. Definiciones importantes
4.1. Conceptos generales4.2. Procesos de entrada y salida
5. Descripción de módulos6. Diccionario de datos
6.1. Modelo entidad-relación6.2. Tablas y vistas6.3. Triggers6.4. Restricciones especiales6.5. Funciones de usuario, Stored Procedures y paquetes6.6. Tareas programadas
7. Políticas de respaldo 7.1. Archivos 7.2. Base de datos
8. Instalación y configuración 8.1. Requisitos generales pre-instalación 8.2. Detalles del proceso de instalación 8.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
8.4. Lista de contactos técnicos 9. Diseño de la arquitectura física 10. Procesos de continuidad y contingencia 11. Descripción de usuarios
11.1. Usuarios de base de datos 11.2. Usuarios de sistema operativo 11.3. Usuarios de aplicaciones
2
1. Propósito
En este documento se presentará la información pertinente al Sistema BDPSystem V3, en relación a la estructura del sistema, como: descripciones, estructura de los datos, estrategias de respaldo de la información y requisitos para su instalación y uso.
Para todos los casos, este manual debe proporcionar una guía para las principales actividades técnicas del sistema BDPSystem V3.
2. Alcance
Este documento está dirigido a todo aquel que deba interactuar con el sistema descrito, ya sea como cliente o como experto, con el fin de brindar un enfoque técnico de la información relevante a al sistema.
3. Documentos de referencia
4. Definiciones importantes
4.1 Conceptos generales
Formulario: Conjunto de campos de entrada de datos para alimentar la base de datos.
4.2 Procesos de entrada y salidaDentro del sistema se contará con un conjunto de formularios mediante los cuales se realizará el ingreso de la información pertinente al uso de la aplicación. Los formularios contarán con los filtros necesarios para que la información que se desee ingresar sea consistente y no dé cabida a errores.
5. Descripción de módulosDentro del subsistema de Costos se encuentran los siguientes módulos:
Inicioo Dentro de este módulo se pueden realizar las funcione de
administración de Compras y Facturas.o Sus dependencias funcionales son: Registrar compra y Facturas.
Calendarioo Dentro de este módulo podrá visualizar los eventos que van a realizar
en la empresa, de toda índole como pagos, reuniones, entrega y recibo de pedidos, entre otros.
Inventario produccióno Dentro de este módulo encontrará las funciones relevantes al control y
administración del inventario de la empresa.o Sus dependencias funcionales son: Control de inventario, Cambios al
inventario e Historial de cambios inventario. Datos
o En este módulo encontrará las funciones relacionadas con la administración de la información de la empresa, información como: Artículos, Proveedores, Categorías y cuentas.
o Sus dependencias funcionales son: Artículos, Proveedores, Categorías y cuentas.
6. Descripción de los métodos
3
inicio_costos: Este método permite realizar la creación de compras de insumos para le empresa. Realizará la validación de los campos necesarios para la creación del registro.
inventario_produccion: Este método permite realizar la visualización de los registros de los artículos ya creados.
costos_articulos: Este método permite realizar la creación de los artículos que maneja la empresa. Realizará la validación de los campos necesarios para la creación del registro.
costos_articulos_editar: Este método permite realizar modificaciones a los registros de artículos ya creados. Realizará la validación de los campos necesarios para la creación del registro.
costos_categorias: Este método permite realizar la creación de los registros de categorías de productos que maneje la empresa. Realizará la validación de los campos necesarios para la creación del registro.
costos_categorias_editar: Este método permite realizar la modificación de los registros de categorías ya creados. Realizará la validación de los campos necesarios para la creación del registro.
costos_proveedores: Este método permite realizar la creación de los registros de los proveedores de la empresa. Realizará la validación de los campos necesarios para la creación del registro.
costos_proveedores_editar: Este método permite realizar la modificación de los registros de proveedores de la empresa. Realizará la validación de los campos necesarios para la creación del registro.
costos_cuentas: Este método permite realizar la creación de los registros de cuentas que maneje la empresa. Realizará la validación de los campos necesarios para la creación del registro.
costos_cuentas_editar: Este método permite realizar la modificación de los registros de cuentas ya creados. Realizará la validación de los campos necesarios para la creación del registro.
costos_facturas: Este método permite realizar la creación de los registros de facturas de compra y venta que realice la empresa. Realizará la validación de los campos necesarios para la creación del registro.
costos_datos: Este método redireccionará al usuario al módulo de Datos del sistema, que le presentará las opciones de creación de registros.
costos_cambios_inventario: Este método permite realizar la creación de los registros de cambios realizados sobre el inventario. Realizará la validación de los campos necesarios para la creación del registro.
costos_historial_cambios_inventario: Este método redireccionará a usuario al módulo de cambios de inventario, en donde podrá visualizar los registros de los cambios de inventario realizados.
costos_concultar_detalles_cambios: Este método permite ver los detalles de un registro de detalles de cambios seleccionado.
costos_concultar_detalles_cambios: Este método permite ver los detalles de un registro de factura seleccionado.
4
7. Diccionario de datos
7.1 Modelo entidad-relación
5
7.2 Tablas y vistas
costos_pagos_costos
En esta tabla se registrará la información de los pagos realizados sobre una factura
Atributos:
id INT(11)
valor INT(11)
descripción VARCHAR(200)
fecha DATE
cuenta_id INT(11)
Llaves foráneas:
cuenta_id (costos_cuenta_financiera_costos)
Llave primaria:
id
costos_cuenta_financiera_costos
En esta tabla se registrará la información de las cuentas financieras de la empresa.
Atributos:
id INT(11)
numero VARCHAR(10)
descripción VARCHAR(300)
nombre VARCHAR(100)
costos_cuenta_financiera_costos INT(11)
Llaves foráneas:
costos_cuenta_financiera_costos (costos_cuenta_financiera_costos)
Llave primaria:
id
costos_proveedor_costos_contactos
En esta tabla se registrará la información de contacto de los proveedores.
Atributos:
id INT(11)
proveedor_costos_id INT(11)
contacto_costos_id INT(11)
Llaves foráneas:
proveedor_costos_id (costos_proveedor_costos)
6
contacto_costos_id (costos_contacto_costos)
Llave primaria:
id
costos_evento_costos
En esta tabla se registrará la información de los eventos realizados en la empresa.
Atributos:
id INT(11)
fecha DATE
hora TIME
descripción VARCHAR(500)
tipo VARCHAR(30)
pago_id INT(11)
días_notificacion INT(11)
Llaves foráneas:
pago_id (costos_pago_costos)
Llave primaria:
id
costos_factura_costos
En esta tabla se registrará la información de las facturas generadas y recibidas en la empresa.
Atributos:
id INT(11)
numero VARCHAR(100)
fecha DATE
estado VARCHAR(20)
proveedor_id INT(11)
Llaves foráneas:
proveedor_id (costos_proveedor_costos)
Llave primaria:
id
costos_proveedor_costos
En esta tabla se registrará la información de los proveedores de la empresa.
7
Atributos:
id INT(11)
nit VARCHAR(50)
nombre VARCHAR(100)
cuenta_id INT(11)
Llaves foráneas:
cuenta_id (costos_cuenta_financiera_costos)
Llave primaria:
id
costos_contacto_costos
En esta tabla se registrará la información de contacto de los proveedores
Atributos:
id INT(11)
tipo VARCHAR(100)
contacto VARCHAR(100)
descipcion VARCHAR(200)
Llaves foráneas:
Llave primaria:
id
costos_item_factura_costos
En esta tabla se registrará la información de los productos relacionados a una factura.
Atributos:
id INT(11)
factura_pertenece_id INT(11)
articulo_id INT(11)
cantidad INT(11)
impuesto DOUBLE
valor_unitario INT(11)
Llaves foráneas:
factura_pertenece_id (costos_factura_costos)
articulo_id (costos_articulo_costos)
Llave primaria:
id
costos_articulo_costos
8
En esta tabla se registrará la información de los artículos de la empresa.
Atributos:
id INT(11)
codigo VARCHAR(30)
nombre VARCHAR(50)
descripción VARCHAR(300)
cantidad_minima INT(11)
unidad VARCHAR(50)
categoría_id INT(11)
activo TINYINT(1)
cantidad INT(11)
Llaves foráneas:
categoria_id (costos_categoria_costos)
Llave primaria:
id
costos_categoria_costos
En esta tabla se registrará la información de los artículos de la empresa.
Atributos:
id INT(11)
codigo VARCHAR(30)
nombre VARCHAR(50)
descripción VARCHAR(300)
Llaves foráneas:
categoria_id (costos_categoria_costos)
Llave primaria:
id
7.3 Triggers
Los triggers de la base de datos se generaran automáticamente al crearse la base de datos, los triggers se encargarán de controlar la integridad de la información, especialmente en la creación y eliminación o modificación de la información. Existirán triggers por cada tabla.
9
7.4 Restricciones especiales
No aplica.
7.5 Funciones de usuario, Stored Procedures y paquetes
No aplica.
7.6 Tareas programadas
No aplica
8. Políticas de respaldo
8.1 ArchivosPeriódicamente se generará un archivo de respaldo de la información de la base de datos, este archivo se generará en un archivo de formato .sql, mediante el cual se podrá realizar la restauración de la información.
8.2 Base de datosLa base de datos realizará un respaldo interno de la información, mediante el cual se podrá hacer un retroceso en el estado de la información, a un estado anterior, en caso de que la información se pierda, la base de datos se dañe o no se pueda acceder a la información o por una mala manipulación de la información en la base de datos. Este retroceso se realizara mediante un rollback en el motor de base de datos.
9. Instalación y configuración
9.1 Requisitos generales pre-instalaciónSistema Operativo: Ubuntu 12.04 LTSLenguaje de programación: Python 2.7, Django 1.5Motor de base de datos: MySQL 5.5Módulos especiales: mathfilters, pytz
9.2 Detalles del proceso de instalaciónSistema operativo: Para instalar el sistema operativo Ubuntu 12.04 LTS, inserte el CD con la imagen del sistema operativo y siga las instrucciones de instalación que se indican.Lenguaje de programación: El lenguaje de programación Python 2.7 viene incluido en el sistema operativo mencionado anteriormente, por lo que no necesita instalarlo, el framework Django 1.5 debe ser instalado manualmente, mediante la terminal de comandos ejecutar el siguiente comando: sudo pip install django==1.5, posteriormente se realizará la instalación automáticamente.Motor de base de datos: Para instalar MySQL 5.5, mediante la terminal de comandos ejecutar el siguiente comando: sudo apt-get install mysql-server mysql-client, posteriormente se realizará la instalación automáticamente.Módulos especiales: Para instalar mathfilters, mediante la terminal de comandos ejecutar el siguiente comando: sudo pip install django-mathfilters, posteriormente se realizará la instalación automáticamente. Para instalar el módulo pytz, mediante la terminal de comandos ejecutar el siguiente comando: sudo pip install pytz, posteriormente se realizará la instalación automáticamente.
10
9.3 Detalles de configuración de la aplicación
a. Variables de ambienteNo aplica
b. Parámetros de aplicacionesEn el archivo settings.py de la aplicación, los parámetros a especificar para el montaje de la aplicación son: el nombre y dirección de la base de datos a conectar para el almacenamiento de la información, el usuario y la contraseña de la base de datos a utilizar.
c. Archivos de configuraciónEn el archivo settings.py de la aplicación, en la sección de INSTALLED_APPS, se debe especificar los módulos a usar en la aplicación, no es necesario definir la ruta de los archivos solo el nombre de la librería o módulo a utilizar.
d. Archivos de bitácoraNo aplica.
e. Tareas programadasNo aplica.
f. Lista de contactos técnicos
Nombre completo Módulo que atiende
Correo electrónico
David Morales Rivera Costos, Inventario de bodega
11
10. Diseño de la arquitectura física
11. Procesos de continuidad y contingencia
El sistema contará con un servidor de base de datos de respaldo ubicado en una zona diferente a la del servidor principal, en este servidor de respaldo se guardaran copias de la información, para que en en caso de que se presente un fallo en el servidor principal, que este se dañe o que alguna catástrofe externa impida el funcionamiento del servidor, la información se mantenga a salvo y accesible en el servidor de respaldo.
Para el servidor Web, este estará alojado en una la plataforma de Amazon, en la cual se contará con una continuidad del servicio del servicio del 98% durante el año, es decir, de los 365 días del año solo durante 7 días el servidor Web no se encontrará disponible, estos siete días no son continuos, se pueden presentar en intervalos de minutos u horas.
12
12. Descripción de usuarios
12.1 Usuarios de base de datos
Nombre del usuario: root Descripción/Propósito: Superusuario de la base de
datos Privilegios: Posee todos los privilegios de creación,
modificación y eliminación de registros.
Posteriormente se podrán agregar usuarios a la base de datos, los cuales se verán reflejados en la aplicación, estos usuarios tendrán permisos diferentes a los del superusuario, y estarán en grupos definidos en la aplicación que tendrán permisos específicos.
12.2 Usuarios de sistema operativoNo aplica
12.3 Usuarios de aplicacionesNo aplica.
13