Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB

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 contendidos conforme al estándar de manual técnico descrito en el presente documento: Tabla de Contenido 2. ALCANCE...................................................................................................................................................2 3. DOCUMENTOS DE REFERENCIA.......................................................................................................2 4. DEFINICIONES IMPORTANTES..........................................................................................................3 5. DESCRIPCIÓN DE MÓDULOS..............................................................................................................3 6. DICCIONARIO DE DATOS.....................................................................................................................3 7. POLÍTICAS DE RESPALDO...................................................................................................................5 8. DESCRIPCIÓN DE INTERFACES CON OTROS SISTEMAS...........................................................5 9. INSTALACIÓN Y CONFIGURACIÓN..................................................................................................5 10. DISEÑO DE LA ARQUITECTURA FÍSICA........................................................................................7 11. PROCESOS DE CONTINUIDAD Y CONTINGENCIA.....................................................................7 12. DESCRIPCIÓN DE USUARIOS............................................................................................................7

1

Queda claro que no todas las soluciones pueden incorporar datos en cada uno de los apartados. se deben presentar los procesos de instalación y configuración. en relación con la Para todos los casos. Esto será evaluado por el departamento respectivo. descripción de procesos de mantenimiento. descripción del contexto de uso. interacción con otros sistemas y/o módulos. 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 corrupción y el enriquecimiento ilícito en la función pública. Alcance Este apartado debe detallar cuáles son los límites del documento. Ley No.Propósito En esta sección. y cuya lectura complemente los conceptos tratados. Adicionalmente. 2. 8292 Manual de normas generales de control interno para la Contraloría General de la República y las entidades y órganos sujetos a su fiscalización. información que presenta. por lo que su uso depende de la naturaleza del software. detalles de implementación y las principales funciones del software 3. los usuarios a quienes está dirigido. se debe mencionar el objetivo del documento. Criterios de aceptación de Sistemas ( DISP-TI-11-05_ANEXO_012B) 2 . Ley nº 8422 Ley general de control interno. este manual debe proporcionar una guía para las principales actividades técnicas del sistema <nombre del sistema> en la Institución.Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB 1. Documentos de referencia Deben indicarse todos los documentos relacionados con la solución. El documento debe estar orientado a los clientes internos y externos del área de Tecnología. y debe ser presentado como parte de los criterios de aceptación. y los conocimientos básicos para comprender los apartados descritos.

6.4 Triggers Para este punto debe presentarse: 3 . por ejemplo: ubicación de los archivos de datos. las condiciones utilizadas para crearla. archivos de índices y/o archivos de bitácora de transacciones en el sistema de archivos. y un detalle de las relaciones entre cada una de las tablas.Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB 4. permitir datos nulos. Se deben indicar los tamaños sugeridos para cada uno de estos. • Propietario/Esquema • En el caso de las vistas.1 Modelo entidad-relación Se debe agregar el modelo entidad-relación de la base de datos que forma parte de la solución. Diccionario de datos 6. 6. filegroups.2 Procesos de entrada y salida Deben ser descritos todos los procesos de entrada y salida que el aplicativo requiere para su funcionamiento. Descripción de módulos Dependiendo de las características del aplicativo.).3 Tablas y vistas Descripción de cada una de las tablas y vistas que son utilizadas por la aplicación. datafiles.2 Distribución física y lógica de base de datos Deben mencionarse todos los detalles relacionados con la distribución física de la base de datos. longitud (en caso de ser necesario). 5. Dentro de los datos mínimos están: • Nombre del objeto • Descripción/Propósito • Lista de los atributos: incluyendo nombre. sus características en cuanto a crecimiento proyectado e indicar si este crecimiento es automático o manual. etc. 4. sus atributos. Este diagrama debe incluir al menos: nombres de las tablas. Definiciones importantes 4. tipo de datos.1 Conceptos generales Debe ser especificada toda la terminología necesaria para comprender el contexto de la aplicación. se debe realizar una descripción de sus diferentes módulos. y cualquier otra restricción. Al menos deberá incluirse la siguiente información: • Nombre del módulo • Funcionalidad/Propósito • Dependencias funcionales 6. • Llaves primarias y de referencias a otras tablas 6. Adicionalmente. la distribución de objetos lógicos por segmentos definidos (tablespaces.

condiciones especiales..8 Data Transformation Services (Bases de datos SQL Server) Debe datos • • • • • • • Para estos casos debe indicarse: • Nombre del objeto • Descripción/Propósito • Secuencia de acciones (si es posible prosa o un diagrama) • Dependencias de funcionamiento (procesos. las variables. etc. cualquier comentario que facilite la comprensión del código. utilizadas y propósito de las mismas. 6. Stored Procedures y paquetes A estos objetos debe especificarse: • Nombre del objeto • Descripción/Propósito • Propietario/Esquema • Código del objeto (cuando no sea confidencial): debe documentarse fecha de creación. 6. modificación.Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB • • • • Nombre del objeto Descripción/Propósito Propietario/Esquema Código del objeto (cuando no sea confidencial): debe documentarse fecha de creación. cualquier comentario que facilite la comprensión del código. • Cualquier otro detalle que resulte de interés 4 . etc. vistas.5 Restricciones especiales Cualquier restricción sobre tablas. parámetros. 6. utilizadas y propósito de las mismas. las variables. condiciones especiales..6 Funciones de usuario. parámetros.7 Tareas programadas darse un detalle de las tareas programadas dentro de la base de con al menos lo siguiente: Nombre de la tarea Descripción/Propósito Secuencia de acciones (si es posible prosa o un diagrama) Consecuencias de no ejecución Horarios de ejecución Consideraciones antes de una ejecución manual Cualquier otro detalle que resulte de interés 6. acciones. Adicionalmente. campos u otro objeto debe ser mencionada en este apartado. Adicionalmente. archivos. modificación.) • Tarea que ejecuta este objeto. etc.

paquetes adicionales. Para esto debe completarse adicionalmente. Descripción de interfaces con otros sistemas En esta sección se debe indicar con detalle.xls”. cada una de las interfaces que la solución utiliza para comunicarse o interactuar con otros sistemas. su periodicidad. historial deseado.cliente de los servidores. Ver documento “FORMULARIO RESPALDOS 060119. Instalación y configuración Cada uno de estos apartados debe ser agrupado por servidor para garantizar su adecuada descripción. y posibles consecuencias que una mala práctica puedan ocasionar. Debe quedar claro el inventario de software de cada equipo.2 Base de datos Debe darse un detalle de las bases de datos a respaldar. 9. 9. debe ser responsabilidad del proveedor indicarlo y dar la debida información al personal del Banco encargado. Se deben dar como mínimo los siguientes datos: • Nombre del sistema relacionado • Objetivo y descripción del proceso de la interface • Formas de comunicación • Diagrama • Tramas • Cómo bajar y subir la interface • Cómo probar su adecuado funcionamiento.xls”. indicar los discos a utilizar.2 Detalles del proceso de instalación Debe mencionarse paso a paso cada uno de los detalles de instalación de la aplicación. Políticas de respaldo 7. el formulario para Respaldos respectivo. 7. 9. cualquier detalle a considerar durante el proceso de respaldo y restauración de los datos. necesarios para realizar sin problema el proceso de instalación. su periodicidad e historial deseado. actualizaciones necesarias. dar una justificación al respecto. Es recomendable especificar versiones de sistema operativo. las opciones a seleccionar durante la instalación. los sitios donde descargar 5 . dar una justificación al respecto. Este detalle debe darse también para realizar la instalación de equipos. 8. el formulario para Respaldos respectivo.Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB 7. Adicionalmente. y el orden en que deben ser instalados cada uno.1 Requisitos generales pre-instalación En este apartado debe especificarse cada uno de los requisitos de hardware y software de ambiente. las versiones correctas.1 Archivos Debe darse un detalle de los archivos a respaldar. Para esto debe completarse adicionalmente. Ver documento “FORMULARIO RESPALDOS 060119.

debe mencionarse lo siguiente: • Nombre del archivo • Ubicación en el equipo • Propósito del mismo • Historia que mantiene: definir si su comportamiento es cíclico. consideraciones antes de una ejecución manual. valores. Es necesario indicar el nombre del parámetro. horarios de ejecución. b. etc. Por ejemplo: cambios de ruta. la cantidad. d. para sistemas operativos Windows o Unix. luego de finalizar el proceso de instalación.3 Detalles de configuración de la aplicación Debe especificarse cualquier cambio a la configuración a tomarse en cuenta. el nombre de los archivos. secuencia de acciones. 9. el nuevo valor. paquetes. archivos. el tamaño promedio de los archivos. ubicación. la aplicación funcionará de manera incorrecta. e. 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. Parámetros de aplicaciones Debe documentarse cualquier cambio en los parámetros por defecto de las aplicaciones. y una breve descripción de los parámetros que contiene con sus posibles valores. y cualquier otro detalle que resulte de interés. el propósito. o mediante herramientas de terceros (excepto lo ya mencionado en el apartado 5.Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB actualizaciones. donde localizarlo. y cualquier otro detalle de interés. que sea mejor para obtener el resultado esperado. y sin el cual. mencionando el nombre de la variable.7). Archivos de configuración En este apartado debe detallarse. el nuevo valor. consecuencias de no ejecución. el propósito. f. a. Tareas programadas Cualquier tarea programada en el sistema operativo. deben ser claramente documentadas. debe ser documentado. detalle de licencias. rutas preferidas. Archivos de bitácora En caso de que la aplicación cuente con archivos de bitácora. una vez instaladas. Nombre completo Empresa/Unidad Ejecutora Módulo que atiende Teléfonos/Beeper 6 . incluyendo el nombre de la tarea.Variables de ambiente Cualquier cambio en variables de ambiente. su propósito. c. y la forma de configurar este tipo de parámetros. Estos contactos deben incluir tanto a personal del Banco como al personal del proveedor que brinda el servicio. el propósito. etc. y cualquier otra práctica recomendada.

Cada usuario debe incluir: • Nombre del usuario • Descripción/Propósito • Grupos a los que pertenece • Privilegios generales a nivel de base de datos. 12. posibles problemas para el usuario final. posibles pérdidas de datos. posibilidad de regresar al servidor principal y tiempo aproximado de ambos procesos). Descripción de usuarios 12. Procesos de continuidad y contingencia Es necesario describir la solución de continuidad y contingencia propuesta para la aplicación.2 7 . Diseño de la arquitectura física Cada una de las aplicaciones. • Descripción/Propósito 12. etc. • Direcciones IP asignadas • Puertos TCP/UDP necesarios para comunicación • Colas de mensajes • Dependencias con otros sistemas • Interrelaciones de conexión entre los equipos. o configuración necesaria. incluyendo: • Nombre del usuario: indicar el dominio al que pertenece. La información mínima requerida es: • Mencionar la existencia de estas funcionalidades • Indicar cómo fue implementada: detallando cualquier software adicional.Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB 10. diagramado por niveles (si es del caso). integrado al esquema físico de seguridad • Cualquier observación importante.1 Usuarios de base de datos Se debe incluir un listado de los usuarios de base de datos necesarios para el aplicativo. fallas en el servicio. 11. debe tener un diagrama detallado con la siguiente información: • Nombre de los equipos • Ubicación física dentro del centro de cómputo. duración del proceso. pruebas y/o producción. y privilegios sobre objetos de las mismas (tablas. ya sea en ambientes de desarrollo. y en el sitio alterno de procesamiento. • Beneficios y consecuencias en los principales niveles de esta decisión (integridad de la información. vistas.) Usuarios de sistema operativo Incluir un listado con usuarios del sistema operativo que utiliza la aplicación. triggers.

Ministerio de Relaciones Exteriores y Culto Sistema de Portal WEB • • Grupos a los que pertenece Privilegios sobre carpetas 12. con los siguientes detalles: • Nombre del usuario • Descripción/Propósito • Grupos a los que pertenece (en caso de que la aplicación realice este manejo) • Privilegios dentro de la aplicación 8 .3 Usuarios de aplicaciones Mencionar todo aquel usuario propietario de la aplicación.

Sign up to vote on this title
UsefulNot useful