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
1. Propsito
2. Alcance
. !ocumentos de referencia
". !efiniciones importantes
".1. Conceptos #enerales
".2. Procesos de entrada $ salida
%. !escripcin de mdulos
&. !iccionario de datos
&.1. Modelo entidad'relacin
&.2. !istribucin f(sica $ l#ica de base de datos
&.. Tablas $ )istas
&.". Tri##ers
&.%. *estricciones especiales
&.&. +unciones de usuario, Stored Procedures $ pa-uetes
&... Tareas pro#ramadas
&./. !ata Transformation Ser)ices 01ases de datos S23 Ser)er4
.. Pol(ticas de respaldo
..1. Arc5i)os
..2. 1ase de datos
/. !escripcin de interfaces con otros sistemas
6. 7nstalacin $ confi#uracin
6.1. *e-uisitos #enerales pre'instalacin
6.2. !etalles del proceso de instalacin
6.. !etalles de confi#uracin de la aplicacin
a. 8ariables de ambiente
b. Parmetros de aplicaciones
c. Arc5i)os de confi#uracin
d. Arc5i)os de bitcora
e. Tareas pro#ramadas
6.". 3ista de contactos tcnicos
19. !ise:o de la ar-uitectura f(sica
11. Procesos de continuidad $ contin#encia
12. !escripcin de usuarios
12.1. ;suarios de base de datos
12.2. ;suarios de sistema operati)o
12.. ;suarios de aplicaciones
1
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
1.Propsito
En esta seccin, se debe mencionar el ob<eti)o del documento, en relacin con la
informacin -ue presenta.
Para todos los casos, este manual debe proporcionar una #u(a para las principales
acti)idades tcnicas del sistema =nombre del sistema> en la 7nstitucin.
2. lcance
Este apartado debe detallar cules son los l(mites del documento, los usuarios a
-uienes est diri#ido, $ los conocimientos bsicos para comprender los apartados
descritos.
El documento debe estar orientado a los clientes internos $ e?ternos del rea de
Tecnolo#(a, $ debe ser presentado como parte de los criterios de aceptacin.
2ueda claro -ue no todas las soluciones pueden incorporar datos en cada uno de los
apartados, por lo -ue su uso depende de la naturale@a del softAare. Esto ser
e)aluado por el departamento respecti)o.
Adicionalmente, se deben presentar los procesos de instalacin $ confi#uracin,
interaccin con otros sistemas $Bo mdulos, descripcin de procesos de
mantenimiento, descripcin del conte?to de uso, detalles de implementacin $ las
principales funciones del softAare
!. Documentos de re"erencia
!eben indicarse todos los documentos relacionados con la solucin, $ cu$a lectura
complemente los conceptos tratados. Por e<emplo:
Estatuto del Ministerio de *elaciones E?teriores $ Culto
Estatuto del Ser)icio Ci)il
*e#lamento al Estatuto del Ser)icio Ci)il
Estatuto del Ser)icio E?terior
*e#lamento al Estatuto del Ser)icio E?terior
Manual de Tareas $ +unciones del Ministerio de *elaciones E?teriores $ Culto
3e$ contra la corrupcin $ el enri-uecimiento il(cito en la funcin pCblica, 3e$
nD /"22
3e$ #eneral de control interno, 3e$ Eo. /262
Manual de normas #enerales de control interno para la Contralor(a Feneral de
la *epCblica $ las entidades $ r#anos su<etos a su fiscali@acin.
Criterios de aceptacin de Sistemas 0 D#SP$T#$11$%&'(E)*'%12B)
2
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
+. De"iniciones importantes
+.1 ,onceptos -enerales
!ebe ser especificada toda la terminolo#(a necesaria para comprender el
conte?to de la aplicacin.
+.2 Procesos de entrada y salida
!eben ser descritos todos los procesos de entrada $ salida -ue el aplicati)o
re-uiere para su funcionamiento.
&. Descripcin de mdulos
!ependiendo de las caracter(sticas del aplicati)o, se debe reali@ar una descripcin de
sus diferentes mdulos. Al menos deber incluirse la si#uiente informacin:
Eombre del mdulo
+uncionalidadBPropsito
!ependencias funcionales
.. Diccionario de datos
..1 Modelo entidad$relacin
Se debe a#re#ar el modelo entidad'relacin de la base de datos -ue forma
parte de la solucin. Este dia#rama debe incluir al menos: nombres de las
tablas, sus atributos, $ un detalle de las relaciones entre cada una de las
tablas.
..2 Distri/ucin "0sica y l-ica de /ase de datos
!eben mencionarse todos los detalles relacionados con la distribucin f(sica
de la base de datos, por e<emplo: ubicacin de los arc5i)os de datos,
arc5i)os de (ndices $Bo arc5i)os de bitcora de transacciones en el sistema
de arc5i)os. Se deben indicar los tama:os su#eridos para cada uno de
estos, sus caracter(sticas en cuanto a crecimiento pro$ectado e indicar si
este crecimiento es automtico o manual. Adicionalmente, la distribucin
de ob<etos l#icos por se#mentos definidos 0tablespaces, datafiles,
file#roups, etc.4.
..! Ta/las y 1istas
!escripcin de cada una de las tablas $ )istas -ue son utili@adas por la
aplicacin. !entro de los datos m(nimos estn:
Eombre del ob<eto
!escripcinBPropsito
3ista de los atributos: inclu$endo nombre, tipo de datos, lon#itud
0en caso de ser necesario4, permitir datos nulos, $ cual-uier otra
restriccin.
PropietarioBEs-uema
En el caso de las )istas, las condiciones utili@adas para crearla.
3la)es primarias $ de referencias a otras tablas
..+ Tri--ers
Para este punto debe presentarse:
3
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
Eombre del ob<eto
!escripcinBPropsito
PropietarioBEs-uema
Cdi#o del ob<eto 0cuando no sea confidencial4: debe documentarse
fec5a de creacin, modificacin, las )ariables, parmetros,
condiciones especiales, etc., utili@adas $ propsito de las mismas.
Adicionalmente, cual-uier comentario -ue facilite la comprensin del
cdi#o.
..& 2estricciones especiales
Cual-uier restriccin sobre tablas, )istas, campos u otro ob<eto debe ser
mencionada en este apartado.
... 3unciones de usuario4 Stored Procedures y pa5uetes
A estos ob<etos debe especificarse:
Eombre del ob<eto
!escripcinBPropsito
PropietarioBEs-uema
Cdi#o del ob<eto 0cuando no sea confidencial4: debe documentarse
fec5a de creacin, modificacin, las )ariables, parmetros,
condiciones especiales, etc., utili@adas $ propsito de las mismas.
Adicionalmente, cual-uier comentario -ue facilite la comprensin del
cdi#o.
..6 Tareas pro-ramadas
!ebe darse un detalle de las tareas pro#ramadas dentro de la base de
datos con al menos lo si#uiente:
Eombre de la tarea
!escripcinBPropsito
Secuencia de acciones 0si es posible prosa o un dia#rama4
Consecuencias de no e<ecucin
Gorarios de e<ecucin
Consideraciones antes de una e<ecucin manual
Cual-uier otro detalle -ue resulte de inters
..7 Data Trans"ormation Ser1ices (Bases de datos S89
Ser1er)
Para estos casos debe indicarse:
Eombre del ob<eto
!escripcinBPropsito
Secuencia de acciones 0si es posible prosa o un dia#rama4
!ependencias de funcionamiento 0procesos, arc5i)os, acciones,
etc.4
Tarea -ue e<ecuta este ob<eto.
Cual-uier otro detalle -ue resulte de inters
4
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
6. Pol0ticas de respaldo
6.1 rc:i1os
!ebe darse un detalle de los arc5i)os a respaldar, dar una <ustificacin al
respecto, su periodicidad, 5istorial deseado, $ posibles consecuencias -ue
una mala prctica puedan ocasionar. Para esto debe completarse
adicionalmente, el formulario para *espaldos respecti)o. 8er documento
H+I*M;3A*7I *ESPA3!IS 9&9116.?lsJ.
6.2 Base de datos
!ebe darse un detalle de las bases de datos a respaldar, dar una
<ustificacin al respecto, su periodicidad e 5istorial deseado. Para esto debe
completarse adicionalmente, el formulario para *espaldos respecti)o. 8er
documento H+I*M;3A*7I *ESPA3!IS 9&9116.?lsJ.
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.
7. Descripcin de inter"aces con otros sistemas
En esta seccin se debe indicar con detalle, cada una de las interfaces -ue la solucin
utili@a para comunicarse o interactuar con otros sistemas. Se deben dar como
m(nimo los si#uientes datos:
Eombre del sistema relacionado
Ib<eti)o $ descripcin del proceso de la interface
+ormas de comunicacin
!ia#rama
Tramas
Cmo ba<ar $ subir la interface
Cmo probar su adecuado funcionamiento.
;. #nstalacin y con"i-uracin
Cada uno de estos apartados debe ser a#rupado por ser)idor para #aranti@ar su
adecuada descripcin. !ebe -uedar claro el in)entario de softAare de cada e-uipo.
Este detalle debe darse tambin para reali@ar la instalacin de e-uipos' cliente de los
ser)idores.
;.1 2e5uisitos -enerales pre$instalacin
En este apartado debe especificarse cada uno de los re-uisitos de 5ardAare
$ softAare de ambiente, necesarios para reali@ar sin problema el proceso
de instalacin. Es recomendable especificar )ersiones de sistema operati)o,
pa-uetes adicionales, actuali@aciones necesarias, $ el orden en -ue deben
ser instalados cada uno.
;.2 Detalles del proceso de instalacin
!ebe mencionarse paso a paso cada uno de los detalles de instalacin de la
aplicacin, indicar los discos a utili@ar, las )ersiones correctas, las opciones
a seleccionar durante la instalacin, los sitios donde descar#ar
5
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
actuali@aciones, detalle de licencias, rutas preferidas, $ cual-uier otra
prctica recomendada, -ue sea me<or para obtener el resultado esperado.
;.! Detalles de con"i-uracin de la aplicacin
!ebe especificarse cual-uier cambio a la confi#uracin a tomarse en
cuenta, lue#o de finali@ar el proceso de instalacinK $ sin el cual, la
aplicacin funcionar de manera incorrecta. Por e<emplo: cambios de ruta,
arc5i)os, pa-uetes, )alores, etc.
a.<aria/les de am/iente
Cual-uier cambio en )ariables de ambiente, para sistemas operati)os
LindoAs o ;ni?, debe ser documentado, mencionando el nombre de la
)ariable, el nue)o )alor, el propsito, $ cual-uier otro detalle de
inters.
/. Par=metros de aplicaciones
!ebe documentarse cual-uier cambio en los parmetros por defecto de
las aplicaciones, una )e@ instaladas. Es necesario indicar el nombre del
parmetro, donde locali@arlo, el nue)o )alor, el propsito, etc.
c. rc:i1os de con"i-uracin
En este apartado debe detallarse, el nombre de los arc5i)os, su
propsito, ubicacin, $ una bre)e descripcin de los parmetros -ue
contiene con sus posibles )alores.
d. rc:i1os de /it=cora
En caso de -ue la aplicacin cuente con arc5i)os de bitcora, debe
mencionarse lo si#uiente:
Eombre del arc5i)o
;bicacin en el e-uipo
Propsito del mismo
Gistoria -ue mantiene: definir si su comportamiento es c(clico,
el tama:o promedio de los arc5i)os, la cantidad, $ la forma de
confi#urar este tipo de parmetros.
e. Tareas pro-ramadas
Cual-uier tarea pro#ramada en el sistema operati)o, o mediante
5erramientas de terceros 0e?cepto lo $a mencionado en el apartado
%..4, deben ser claramente documentadas, inclu$endo el nombre de la
tarea, el propsito, secuencia de acciones, consecuencias de no
e<ecucin, 5orarios de e<ecucin, consideraciones antes de una
e<ecucin manual, $ cual-uier otro detalle -ue resulte de inters.
". 9ista de contactos tcnicos
!ebe especificarse una lista de personas a las cuales se les pueda notificar
en caso de problemas con el aplicati)o $Bo con el GardAare. Estos contactos
deben incluir tanto a personal del 1anco como al personal del pro)eedor
-ue brinda el ser)icio.
(om/re
completo
Empresa>?nidad
E@ecutora
Mdulo 5ue
atiende
Tel"onos>Beeper
6
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
1%. DiseAo de la ar5uitectura "0sica
Cada una de las aplicaciones, $a sea en ambientes de desarrollo, pruebas $Bo
produccin, debe tener un dia#rama detallado con la si#uiente informacin:
Eombre de los e-uipos
;bicacin f(sica dentro del centro de cmputo, $ en el sitio alterno de
procesamiento.
!irecciones 7P asi#nadas
Puertos TCPB;!P necesarios para comunicacin
Colas de mensa<es
!ependencias con otros sistemas
7nterrelaciones de cone?in entre los e-uipos, dia#ramado por ni)eles 0si es
del caso4, inte#rado al es-uema f(sico de se#uridad
Cual-uier obser)acin importante.
11. Procesos de continuidad y contin-encia
Es necesario describir la solucin de continuidad $ contin#encia propuesta para la
aplicacin. 3a informacin m(nima re-uerida es:
Mencionar la e?istencia de estas funcionalidades
7ndicar cmo fue implementada: detallando cual-uier softAare adicional, o
confi#uracin necesaria.
1eneficios $ consecuencias en los principales ni)eles de esta decisin
0inte#ridad de la informacin, posibles prdidas de datos, fallas en el ser)icio,
posibles problemas para el usuario final, duracin del proceso, posibilidad de
re#resar al ser)idor principal $ tiempo apro?imado de ambos procesos4.
12. Descripcin de usuarios
12.1 ?suarios de /ase de datos
Se debe incluir un listado de los usuarios de base de datos necesarios para
el aplicati)o. Cada usuario debe incluir:
Eombre del usuario
!escripcinBPropsito
Frupos a los -ue pertenece
Pri)ile#ios #enerales a ni)el de base de datos, $ pri)ile#ios sobre
ob<etos de las mismas 0tablas, )istas, tri##ers, etc.4
12.2 ?suarios de sistema
operati1o
7ncluir un listado con usuarios del sistema operati)o -ue utili@a la
aplicacin, inclu$endo:
Eombre del usuario: indicar el dominio al -ue pertenece.
!escripcinBPropsito
7
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB
Frupos a los -ue pertenece
Pri)ile#ios sobre carpetas
12.! ?suarios de aplicaciones
Mencionar todo a-uel usuario propietario de la aplicacin, con los
si#uientes detalles:
Eombre del usuario
!escripcinBPropsito
Frupos a los -ue pertenece 0en caso de -ue la aplicacin realice
este mane<o4
Pri)ile#ios dentro de la aplicacin
8