Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

Sistema de Portal WEB (SPT) Manual Tcnico para el Sistema

Descripcin y contenido del Manual Tcnico El Manual Tcnico del Sistema debe estar estructurado e incluir contendidos conforme al estndar de manual tcnico descrito en el presente documento: Tabla de Contenido 2. ALCANCE...................................................................................................................................................2 3. DOCUMENTOS DE REFERENCIA.......................................................................................................2 4. DEFINICIONES IMPORTANTES..........................................................................................................3 5. DESCRIPCIN DE MDULOS..............................................................................................................3 6. DICCIONARIO DE DATOS.....................................................................................................................3 7. POLTICAS DE RESPALDO...................................................................................................................5 8. DESCRIPCIN DE INTERFACES CON OTROS SISTEMAS...........................................................5 9. INSTALACIN Y CONFIGURACIN..................................................................................................5 10. DISEO DE LA ARQUITECTURA FSICA........................................................................................7 11. PROCESOS DE CONTINUIDAD Y CONTINGENCIA.....................................................................7 12. DESCRIPCIN DE USUARIOS............................................................................................................7

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

1.Propsito En esta seccin, se debe mencionar el objetivo del documento, informacin que presenta. en relacin con la

Para todos los casos, este manual debe proporcionar una gua para las principales actividades tcnicas del sistema <nombre del sistema> en la Institucin. 2. Alcance Este apartado debe detallar cules son los lmites del documento, los usuarios a quienes est dirigido, y los conocimientos bsicos para comprender los apartados descritos. El documento debe estar orientado a los clientes internos y externos del rea de Tecnologa, y debe ser presentado como parte de los criterios de aceptacin. Queda claro que no todas las soluciones pueden incorporar datos en cada uno de los apartados, por lo que su uso depende de la naturaleza del software. Esto ser evaluado por el departamento respectivo. Adicionalmente, se deben presentar los procesos de instalacin y configuracin, interaccin con otros sistemas y/o mdulos, descripcin de procesos de mantenimiento, descripcin del contexto de uso, detalles de implementacin y las principales funciones del software 3. Documentos de referencia Deben indicarse todos los documentos relacionados con la solucin, y cuya lectura complemente los conceptos tratados. Por ejemplo: Estatuto del Ministerio de Relaciones Exteriores y Culto Estatuto del Servicio Civil Reglamento al Estatuto del Servicio Civil Estatuto del Servicio Exterior Reglamento al Estatuto del Servicio Exterior Manual de Tareas y Funciones del Ministerio de Relaciones Exteriores y Culto Ley contra la corrupcin y el enriquecimiento ilcito en la funcin pblica, Ley n 8422 Ley general de control interno, Ley No. 8292 Manual de normas generales de control interno para la Contralora General de la Repblica y las entidades y rganos sujetos a su fiscalizacin. Criterios de aceptacin de Sistemas ( DISP-TI-11-05_ANEXO_012B)

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

4. Definiciones importantes 4.1 Conceptos generales Debe ser especificada toda la terminologa necesaria para comprender el contexto de la aplicacin. 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. Descripcin de mdulos Dependiendo de las caractersticas del aplicativo, se debe realizar una descripcin de sus diferentes mdulos. Al menos deber incluirse la siguiente informacin: Nombre del mdulo Funcionalidad/Propsito Dependencias funcionales 6. Diccionario de datos 6.1 Modelo entidad-relacin Se debe agregar el modelo entidad-relacin de la base de datos que forma parte de la solucin. Este diagrama debe incluir al menos: nombres de las tablas, sus atributos, y un detalle de las relaciones entre cada una de las tablas. 6.2 Distribucin fsica y lgica de base de datos Deben mencionarse todos los detalles relacionados con la distribucin fsica de la base de datos, por ejemplo: ubicacin de los archivos de datos, archivos de ndices y/o archivos de bitcora de transacciones en el sistema de archivos. Se deben indicar los tamaos sugeridos para cada uno de estos, sus caractersticas en cuanto a crecimiento proyectado e indicar si este crecimiento es automtico o manual. Adicionalmente, la distribucin de objetos lgicos por segmentos definidos (tablespaces, datafiles, filegroups, etc.). 6.3 Tablas y vistas

Descripcin de cada una de las tablas y vistas que son utilizadas por la aplicacin. Dentro de los datos mnimos estn: Nombre del objeto Descripcin/Propsito Lista de los atributos: incluyendo nombre, tipo de datos, longitud (en caso de ser necesario), permitir datos nulos, y cualquier otra restriccin. Propietario/Esquema En el caso de las vistas, las condiciones utilizadas para crearla. Llaves primarias y de referencias a otras tablas 6.4 Triggers

Para este punto debe presentarse:

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

Nombre del objeto Descripcin/Propsito Propietario/Esquema Cdigo del objeto (cuando no sea confidencial): debe documentarse fecha de creacin, modificacin, las variables, parmetros, condiciones especiales, etc., utilizadas y propsito de las mismas. Adicionalmente, cualquier comentario que facilite la comprensin del cdigo. 6.5 Restricciones especiales

Cualquier restriccin sobre tablas, vistas, campos u otro objeto debe ser mencionada en este apartado. 6.6 Funciones de usuario, Stored Procedures y paquetes

A estos objetos debe especificarse: Nombre del objeto Descripcin/Propsito Propietario/Esquema Cdigo del objeto (cuando no sea confidencial): debe documentarse fecha de creacin, modificacin, las variables, parmetros, condiciones especiales, etc., utilizadas y propsito de las mismas. Adicionalmente, cualquier comentario que facilite la comprensin del cdigo. 6.7 Tareas programadas darse un detalle de las tareas programadas dentro de la base de con al menos lo siguiente: Nombre de la tarea Descripcin/Propsito Secuencia de acciones (si es posible prosa o un diagrama) Consecuencias de no ejecucin Horarios de ejecucin Consideraciones antes de una ejecucin manual Cualquier otro detalle que resulte de inters 6.8 Data Transformation Services (Bases de datos SQL Server)

Debe datos

Para estos casos debe indicarse: Nombre del objeto Descripcin/Propsito Secuencia de acciones (si es posible prosa o un diagrama) Dependencias de funcionamiento (procesos, archivos, acciones, etc.) Tarea que ejecuta este objeto. Cualquier otro detalle que resulte de inters

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

7. Polticas de respaldo 7.1 Archivos Debe darse un detalle de los archivos a respaldar, dar una justificacin al respecto, su periodicidad, historial deseado, y posibles consecuencias que una mala prctica puedan ocasionar. Para esto debe completarse adicionalmente, el formulario para Respaldos respectivo. Ver documento FORMULARIO RESPALDOS 060119.xls. 7.2 Base de datos Debe darse un detalle de las bases de datos a respaldar, dar una justificacin al respecto, su periodicidad e historial deseado. Para esto debe completarse adicionalmente, el formulario para Respaldos respectivo. Ver documento FORMULARIO RESPALDOS 060119.xls. Adicionalmente, cualquier detalle a considerar durante el proceso de respaldo y restauracin de los datos, debe ser responsabilidad del proveedor indicarlo y dar la debida informacin al personal del Banco encargado. 8. Descripcin de interfaces con otros sistemas En esta seccin se debe indicar con detalle, cada una de las interfaces que la solucin utiliza para comunicarse o interactuar con otros sistemas. Se deben dar como mnimo los siguientes datos: Nombre del sistema relacionado Objetivo y descripcin del proceso de la interface Formas de comunicacin Diagrama Tramas Cmo bajar y subir la interface Cmo probar su adecuado funcionamiento. 9. Instalacin y configuracin Cada uno de estos apartados debe ser agrupado por servidor para garantizar su adecuada descripcin. Debe quedar claro el inventario de software de cada equipo. Este detalle debe darse tambin para realizar la instalacin de equipos- cliente de los servidores. 9.1 Requisitos generales pre-instalacin En este apartado debe especificarse cada uno de los requisitos de hardware y software de ambiente, necesarios para realizar sin problema el proceso de instalacin. Es recomendable especificar versiones de sistema operativo, paquetes adicionales, actualizaciones necesarias, y el orden en que deben ser instalados cada uno. 9.2 Detalles del proceso de instalacin Debe mencionarse paso a paso cada uno de los detalles de instalacin de la aplicacin, indicar los discos a utilizar, las versiones correctas, las opciones a seleccionar durante la instalacin, los sitios donde descargar

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

actualizaciones, detalle de licencias, rutas preferidas, y cualquier otra prctica recomendada, que sea mejor para obtener el resultado esperado. 9.3 Detalles de configuracin de la aplicacin Debe especificarse cualquier cambio a la configuracin a tomarse en cuenta, luego de finalizar el proceso de instalacin; y sin el cual, la aplicacin 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 propsito, y cualquier otro detalle de inters. b. Parmetros de aplicaciones Debe documentarse cualquier cambio en los parmetros por defecto de las aplicaciones, una vez instaladas. Es necesario indicar el nombre del parmetro, donde localizarlo, el nuevo valor, el propsito, etc. c. Archivos de configuracin En este apartado debe detallarse, el nombre de los archivos, su propsito, ubicacin, y una breve descripcin de los parmetros que contiene con sus posibles valores. d. Archivos de bitcora En caso de que la aplicacin cuente con archivos de bitcora, debe mencionarse lo siguiente: Nombre del archivo Ubicacin en el equipo Propsito del mismo Historia que mantiene: definir si su comportamiento es cclico, el tamao promedio de los archivos, la cantidad, y la forma de configurar este tipo de parmetros. e. 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 propsito, secuencia de acciones, consecuencias de no ejecucin, horarios de ejecucin, consideraciones antes de una ejecucin manual, y cualquier otro detalle que resulte de inters. f. Lista de contactos tcnicos 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 completo Empresa/Unidad Ejecutora Mdulo que atiende Telfonos/Beeper

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

10. Diseo de la arquitectura fsica Cada una de las aplicaciones, ya sea en ambientes de desarrollo, pruebas y/o produccin, debe tener un diagrama detallado con la siguiente informacin: Nombre de los equipos Ubicacin fsica dentro del centro de cmputo, y en el sitio alterno de procesamiento. Direcciones IP asignadas Puertos TCP/UDP necesarios para comunicacin Colas de mensajes Dependencias con otros sistemas Interrelaciones de conexin entre los equipos, diagramado por niveles (si es del caso), integrado al esquema fsico de seguridad Cualquier observacin importante. 11. Procesos de continuidad y contingencia Es necesario describir la solucin de continuidad y contingencia propuesta para la aplicacin. La informacin mnima requerida es: Mencionar la existencia de estas funcionalidades Indicar cmo fue implementada: detallando cualquier software adicional, o configuracin necesaria. Beneficios y consecuencias en los principales niveles de esta decisin (integridad de la informacin, posibles prdidas de datos, fallas en el servicio, posibles problemas para el usuario final, duracin del proceso, posibilidad de regresar al servidor principal y tiempo aproximado de ambos procesos). 12. Descripcin de usuarios 12.1 Usuarios de base de datos Se debe incluir un listado de los usuarios de base de datos necesarios para el aplicativo. Cada usuario debe incluir: Nombre del usuario Descripcin/Propsito Grupos a los que pertenece Privilegios generales a nivel de base de datos, y privilegios sobre objetos de las mismas (tablas, vistas, triggers, etc.) Usuarios de sistema operativo Incluir un listado con usuarios del sistema operativo que utiliza la aplicacin, incluyendo: Nombre del usuario: indicar el dominio al que pertenece. Descripcin/Propsito 12.2

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

Grupos a los que pertenece Privilegios sobre carpetas

12.3 Usuarios de aplicaciones Mencionar todo aquel usuario propietario de la aplicacin, con los siguientes detalles: Nombre del usuario Descripcin/Propsito Grupos a los que pertenece (en caso de que la aplicacin realice este manejo) Privilegios dentro de la aplicacin