Secretara de Planificacin Estratgica Oficina de Informtica

Gua para el desarrollo de aplicaciones en entorno desktop

VERSIN 2.1

Diciembre 2006

INDICE DE CONTENIDO Gua de Estndares

INDICE
1.
1.1. 1.2.

INTRODUCCIN ........................................................................................ 3
ALCANCE ......................................................................................................... 3 VIGENCIA ......................................................................................................... 3

2.

METODOLOGA DESARROLLO DE SISTEMAS ..................................... 4

2.1. VISIN GENERAL DEL PROCESO ....................................................................... 5 2.1.1. Fases .......................................................................................................... 5 2.1.2. Componentes del Proceso .......................................................................... 7 2.1.2.1 Componentes del Proceso de Ingeniera ............................................. 7

3.
3.1. 3.2.

ESTRUCTURA DEL MANUAL DE SISTEMA ........................................ 12

DEFINICIN .................................................................................................... 12 CONTENIDO ................................................................................................... 12

4.
4.1. 4.2.

ESTRUCTURA DEL MANUAL DE USUARIO ........................................ 13

DEFINICIN .................................................................................................... 13 CONTENIDO ................................................................................................... 13

5.

ESTNDARES PARA ESPECIFICACIONES TCNICAS ...................... 14

5.1. ESTNDARES DE DEFINICIN DE BASE DE DATOS ............................................ 14 5.1.1. Normas para definicin de Modelos de Datos Entidad Relacin ........... 14 5.1.2. Estndares para definir Nombre de Entidades y Relaciones.................... 16 5.1.3. Estndares para Nombrar los Datos ......................................................... 19 5.2. ESTNDARES DE PROGRAMACIN .................................................................. 23 5.2.1. Definicin de Variables ............................................................................. 23 5.2.2. Definicin de Funciones y Procedimientos ............................................... 23 5.2.3. Definicin de Mdulos ............................................................................... 24 5.2.4. Definicin de Clases ................................................................................. 24 5.2.5. Definicin de Formas ................................................................................ 24 5.2.6. Definicin de Controles ............................................................................. 24 5.3. ESTNDARES DE DISEO DE PANTALLAS ........................................................ 25

6.

ASPECTOS DE SEGURIDAD Y PARMETROS ................................... 27

6.1. MDULO DE SEGURIDAD ................................................................................ 27 6.1.1. Aspectos Funcionales del Mdulo de Seguridad ...................................... 27

7.

ANEXOS ................................................................................................... 45

7.1. REPRESENTACIN GRFICA USE CASE........................................................... 45 7.2. FORMATO DE ESPECIFICACIN USE CASE. ...................................................... 46 7.2.1. Formato de Use Case ............................................................................... 46 7.2.2. Descripcin ............................................................................................... 47 7.3. CABECERA DE REPORTES A SER USADOS POR EL SISTEMA. ............................. 48

MED

Pg. 2

INDICE DE CONTENIDO Gua de Estndares

1. Introduccin
Las organizaciones actuales emplean un conjunto de estndares que permiten la homogeneidad en los documentos y componentes elaborados durante la construccin de sistemas. Esto permite una fcil y rpida familiarizacin con el sistema proporcionando adems elementos fundamentales para el mantenimiento futuro del sistema. En ese sentido, el presente documento tiene por objetivo presentar los estndares a emplear en el desarrollo de los aplicativos informticos(Sistemas de Informacin) del tipo cliente / servidor 1. En el documento se describe los siguientes aspectos: Descripcin de la metodologa de desarrollo de sistemas analizados: Rational Unified Process o Unified Process Estndares a analizar en el Manual Tcnico de Sistemas. Estndares a analizar en el Manual de Usuario. Estndares de definicin de Base de Datos Estndares de programacin. Estndares de seguridad del Sistema. Aspectos funcionales del Modulo de Parmetros.

1.1. Alcance Los estndares establecidos en este documento deben ser respetados en el desarrollo de las aplicaciones en el entorno desktop en el Sector Educacin, tanto en el caso de desarrollo con esfuerzo propio como las que requieren el apoyo de terceros. 1.2. Vigencia La vigencia de estos estndares est condicionada a: Los cambios de poltica de la Oficina de Informtica del Ministerio de Educacin. Los cambios de versin de los productos seleccionados. Los cambios del entorno (mercado, tecnologas, precios, etc).

Esta normatividad se revisar cada 6 (seis) meses contados a partir del mes de su aprobacin.

El Presente Manual toma como referencia principal el Manual de Estndares que ha presentado al Ministerio de Educacin la firma GMD para el desarrollo del Sistema de Capacitacin Docente, de propiedad del MED, acuerdo a los trminos de la contratacin. La decisin se sustenta en el uso de la metodologa de desarrollo de sistemas denominada Unified Process (Proceso Unificado) o Rational Unified Process o simplemente Rational Process y el estndar UML, que han sido asumidos por la Industria de Software.

MED

Pg. 3

INDICE DE CONTENIDO Gua de Estndares

2. Metodologa Desarrollo de Sistemas

Para el desarrollo de nuevos sistemas MED utiliza el UNIFIED PROCESS (Proceso Unificado) o Rational Unified Process desarrollado por Rational Software. Rational Software es lder en el mundo en el tema de metodologas y herramientas de soporte para el desarrollo de software. Son clientes de Rational empresas del nivel de Microsoft, IBM, AT&T, Andersen Consulting, entre otras. El Rational Unified Process provee una disciplina para la asignacin de tareas y responsabilidades dentro de una organizacin de desarrollo. Sus metas son asegurar la produccin de software de alta calidad reuniendo las necesidades de los usuarios finales, dentro de cronogramas y presupuestos predecibles. Rational Unified Process captura muchas de las mejores practicas del desarrollo moderno de software de tal forma que es adaptable a un amplio rango de proyectos y organizaciones. El Rational Unified Process: Es un proceso iterativo. Dada la sofisticacin de los sistemas hoy, no es posible secuencialmente primero definir el problema entero, disear la solucin entera, construir el software y probar el producto al final. Se requiere una aproximacin iterativa que permita un entendimiento progresivo del problema a travs de refinamientos, y montar incrementalmente una solucin efectiva sobre mltiples iteraciones. Una aproximacin iterativa da una mejor flexibilidad al agregar nuevos requerimientos o cambios tcticos en los objetivos de negocio. Y permite al proyecto en forma temprana, identificar y resolver riesgos. Es un proceso controlado. Esta aproximacin iterativa solo es posible a travs de un muy cuidadoso manejo de requerimientos y control de cambios, para asegurar en cada punto un entendimiento comn de las funcionalidades esperadas, el nivel de calidad esperado, y permitir un mejor control de los costos y cronogramas. Orienta sus actividades a crear y mantener modelos. En lugar de enfocarse en la produccin de grandes cantidades de documentos, enfatiza el desarrollo y mantenimiento de modelosricas representaciones semnticas del sistema de software en desarrollo. Se enfoca en el desarrollo de una robusta arquitectura de software, la cual facilita el desarrollo paralelo, minimiza el trabajo doble, incrementa la reusabilidad y mantenibilidad. Esta arquitectura es usada para planear y manejar el desarrollo alrededor del uso de componentes de software. Maneja las actividades de desarrollo a travs de use cases (descripcin textual y grfica de la interaccin entre los actores del sistema). La nocin de use cases y escenarios manejan el flujo del proceso desde la captura de requerimientos hasta las pruebas, y provee un canal coherente entre el sistema y el proceso de desarrollo. Esta basado en las tcnicas orientadas-a-objetos. Muchos de los modelos son modelos orientados-a-objetos, basados en los conceptos de Objetos, clases y asociaciones entre ellos. Estos modelos, as como otros elementos tcnicos usan el Lenguaje Unificado de Modelamiento (UML) como su notacin comn. Propugna agresivamente el control permanente de la calidad. El aseguramiento de la Calidad forma parte del proceso, en todas las actividades, involucrando a todos los participantes, y no tratando el tema como una actividad separada ejecutada por un grupo separado. Esta soportado por herramientas, las cuales automatizan grandes partes del proceso. Ellas son usadas para crear y mantener los variados elementos modelos en particulardel proceso de ingeniera de software: modelamiento visual, pruebas de programacin, etc.

MED

Pg. 4

INDICE DE CONTENIDO Gua de Estndares 2.1. Visin General del Proceso El Rational Unified Process puede ser descrito en dos dimensiones : En el tiempo, los aspectos del ciclo-de-vida del proceso de desarrollo En el contenido, los aspectos del proceso de ingeniera

La primera dimensin representa el aspecto dinmico del proceso, expresado en trminos de ciclos, fases, iteraciones e hitos. La segunda dimensin representa el aspecto esttico del proceso: descrito en trminos de componentes de proceso, actividades, flujos de trabajo e instrumentos de manejo.
Organizacion en el tiempo

Fases P ro c e s o
In c e p c ioE la b o ra c io n C o n s tru c c io n T ra n s ic io n n

C a p tu r a R e q u e rim ie n to s A n a lis is & D is e n o Im p le m e n t a c io n P ru e b a s

Organizacion en el contenido

S o p o r te
G e re n c ia In fra e s t ru c tu r a E m p a q u e ta d o
ite ra c io n e s yite r. p re lim in a re s # 1 ite r. #2 ite r. #n ite r. ite r. #n+ 1 #n+ 2 ite r. #m ite r. #m +1

Ite r a c io n e s

2.1.1. Fases El ciclo de vida del software esta dividido en ciclos, cada ciclo trabajando en una nueva generacin del producto. El Proceso divide un ciclo de desarrollo en cuatro fases consecutivas. Incepcin.- Definicin de las fronteras y mbito del proyecto. Est fase define el dominio del sistema y su mbito. Elaboracin.- Planeamiento de las actividades necesarias y los recursos requeridos, especificacin de las funciones del sistema y diseo de su arquitectura. La meta principal de esta fase es analizar el dominio del problema, para definir y establecer la arquitectura, y direccionar los elementos de alto riesgo del proyecto. Construccin.- Desarrollo del producto, la arquitectura, y los planes hasta que el producto la visin completaeste listo para transferirse a los usuarios. Durante la fase construccin, se desarrolla iterativa e incrementalmente un producto completo que esta listo para la entrega a la comunidad de usuarios. Esto implica describir los use case restantes, no desarrollados en el diseo, y completar la implementacion y pruebas del software. Al final de la fase construccin, se decide si el software, los ambientes, los usuarios estn listos para operar.

MED

Pg. 5

INDICE DE CONTENIDO Gua de Estndares Transicin.- Produccin, entrega, entrenamiento, soporte, mantenimiento del producto hasta que el usuario est satisfecho.

Cada fase es concluida con un bien definido Hitoun punto en el tiempo en el cual ciertas decisiones criticas son hechas, y donde metas clave deben haber sido logradas.
HITOS IMPORTANTES

Incepcion

Elaboracion

Construccion

Transicion

Fases e Hitos importantes en el proceso Pasar a travs de las 4 fases es llamado un ciclo de desarrollo, y produce una generacin de software. Aunque la vida del producto se detenga, un producto existente puede evolucionar a su siguiente generacin repitiendo la misma secuencia de fases: incepcin, elaboracin, construccin, y transicin. Con una diferencia de nfasis, sin embargo, en las diferentes fases. Este perodo es denominado evolucin. Por ejemplo, el ciclo de evolucin puede ser disparado por un usuario que sugiere una mejora, cambios en el contexto del usuario, cambios en la tecnologa, etc.

Incepcin

Elaboracin Construccin

Transicin

Evolucin

Un ciclo de desarrollo inicial

Generacin 1

Incepcin

Elaboracin Construccin Transicin

Evolucin

El siguiente ciclo de evolucin Generacin 2

En la prctica, los ciclos pueden eventualmente montarse entre s: las fases incepcin y elaboracin pueden iniciarse mientras se lleva a cabo la fase de transicin del ciclo previo.

MED

Pg. 6

INDICE DE CONTENIDO Gua de Estndares 2.1.2. Componentes del Proceso El Unified Process (proceso unificado) est compuesto de 7 procesos componentes, los cuales son descritos en trminos de actividades, flujos de trabajo, trabajadores y documentos de trabajo. Hay cuatro componentes del procesos de ingeniera: Captura de Requerimientos, Anlisis y Diseo, Implementacion y Pruebas. Y tres componentes de soporte: Gerencia, Infraestructura, y Empaquetado Los nombres de los procesos componentes del Proceso Unificado provienen de los trminos que describen una actividad intelectual: anlisis, diseo, pruebas, etc., as que estar entendido que esta actividad no est confinada a una fase. Esas actividades tienen lugar, pero varan en intensidad en cada fase e iteracin. Este cambio de enfoque explica tambin que, aunque todo est estructurado en la misma forma, la naturaleza exacta y el contenido de las iteraciones evolucionan en el tiempo. Asimismo, el inicio de una actividad no esta limitada al fin de otra. Finalmente, en un proceso iterativo, las actividades de planeamiento, pruebas e integracin son realizadas incrementalmente a travs del ciclo, en cada iteracin, y no masivamente al inicio y al final respectivamente. Ellas no aparecen como pasos separados o fases en el proceso.
2.1.2.1

Componentes del Proceso de Ingeniera

Componentes del Proceso y Modelos Cada componente del proceso de ingeniera describe como crear y mantener un modelo. El Proceso Unificado tiene los siguientes modelos: modelo use-case, modelo de diseo, modelo de implementacin, y modelo de pruebas. La siguiente figura muestra las relaciones de los componentes del proceso y los modelos.

Componentes del Proceso

Captura de Requerimientos

Anlisis y Diseo

Implementacin

Pruebas

Modelos
Implementado Por Revisado Por

Realizado Por Modelo de Use Case

OK OK Err l

Modelo del Diseo

Modelo de la Implementacin

Modelo de las pruebas

Captura de Requerimientos La meta del componente del proceso Captura de Requerimientos es describir que debe hacer el sistema y permite a los desarrolladores y los clientes ponerse de acuerdo en esa descripcin. Para lograr esto, delimitamos el sistema, definimos su entorno y el comportamiento supuesto a ejecutar. Los clientes y usuarios potenciales son importantes fuentes de informacin as como cualquier requerimiento del sistema que pueda existir.

MED

Pg. 7

INDICE DE CONTENIDO Gua de Estndares La captura de Requerimientos resulta en un modelo use-case y algunos requerimientos suplementarios. El modelo use-case es esencial para ambos, para el cliente, quien necesita el modelo para validar que el sistema tenga lo que el espera, y para los desarrolladores, quienes necesitan el modelo para tener un mejor entendimiento de los requerimientos del sistema. El modelo use-case es relevante para todas las personas involucradas en el proyecto. El modelo use-case consiste de actores y use cases. Los actores representan los usuarios, y cualquier otro sistema que pueda interactuar con el sistema en desarrollo. Los actores ayudan a delimitar el sistema y dan una clara imagen de lo que se supone hacen. Los use-case representan el comportamiento del sistema y son desarrollados de acuerdo a las necesidades de los actores.Cada use-case es descrito en detalle. La descripcin del use-case muestra como el sistema interactua paso a paso con los actores y que hace el sistema. Los use cases funcionan como guas unificadoras a travs del ciclo de desarrollo del sistema. El mismo modelo use-case es usado durante la captura de requerimientos, anlisis & diseo, y pruebas.
Captura el Vocabulario Comun Aquitecto de Use Cases Describe el Modelo Use-Case Encuentra Use Cases y Actores Estructura el Modelo Use-Case Revision de Requerimientos

Especificador de Use Cases

Describe Use Cases

Revision del Modelo Use Case

Prioriza Use Cases Arquitecto

El flujo de trabajo en la captura de requerimientos, muestra en trminos de trabajadores y sus actividades. Las flechas indican un orden lgico entre las actividades. Anlisis & Diseo La meta del componente del proceso Anlisis & Diseo es mostrar como el sistema ser realizado en la fase de implementacin. Ud. Quiere construir un sistema que: Ejecuteen un ambiente especifico de implementacinlas tareas y funciones especificadas en las descripciones Use-Case. Satisfaga todos sus requerimientos. Esta estructurado para ser robusto y fcil de cambiar. El modelo Use-Case es la base para el diseo, junto a las especificaciones suplementarias. Anlisis & Diseo resulta en un modelo de diseo que sirve como una abstraccin del cdigo fuente; esto es, el modelo de diseo acta como un 'borrador' de cmo el cdigo fuente esta estructurado y escrito. Diseo tambin resulta en una descripcin

MED

Pg. 8

INDICE DE CONTENIDO Gua de Estndares 'vista desde dentro' de los use-case, o realizaciones use-case, las cuales describen como los use-case son realizados en trminos de objetos/clases participantes. El modelo de diseo consiste de estructuras de clases diseadas dentro de paquetes de diseo; tambin contiene descripciones de cmo los objetos de esas clases diseadas colaboran para ejecutar los use cases. Las actividades de diseo estn centradas alrededor de la nocin de arquitectura . La produccin y validacin de esta arquitectura es el principal foco de iteraciones tempranas de diseo. La arquitectura esta representada por un numero de vistas arquitectnicas. Estas vistas capturan las mayores decisiones de diseo estructural. En esencia, las vistas arquitectnicas son abstracciones o simplificaciones del diseo entero, en las cuales las caractersticas importantes se hacen mas visibles dejando los detalles a un lado.

A rqu itecto

A na lisis d e A rq u itectu ra

D iseno d e A rqu ite ctura

D escrib e C on currencia

D escribe D istribu cion

D isen ad or de U se C ase sr

A nalisis d e U se C ase s

D iseno de U se Ca ses

D isen ador

A nalisis d e O bje tos

D isen o de O bjetos

R evisor de D isen o

R evision del A n alisis

R evision de l D iseno

R evision de A rqu itectura

El flujo de trabajo en anlisis & diseo descrito en trminos de trabajadores y sus actividades. Las flechas indican un flujo lgico entre las actividades.

MED

Pg. 9

INDICE DE CONTENIDO Gua de Estndares Implementacin El sistema es realizado a travs de la implementacin produciendo fuentes (archivos de cdigo-fuente, archivos de cabecera, archivos de compilacin, etc.) que resultaran en un sistema ejecutable. La implementacin incluye probar por separado las clases y/o paquetes, pero no probar que los paquetes / clases trabajen junto, que es descrito en el siguiente componente del proceso pruebas.

Arquitecto

Define la Organizacion de Subsistemas

Integrador del Sistema

Plan de Integracion del Sistema

Integrar Sistemas

Plan de Integracin de Subsistemas Implementacion de Clases Implementador Fijar Defectos

Integrar Subsistemas Ejecutar Pruebas Unitarias

Revisor de Codigo

Revision deCodigo

El flujo de trabajo en la implementacion, muestra en trminos de trabajadores y sus actividades. Las flechas indican un orden lgico entre las actividades.

MED

Pg. 10

INDICE DE CONTENIDO Gua de Estndares Pruebas Las pruebas verifican el sistema entero. Primero se prueba cada use case separadamente para verificar que sus clases participantes trabajan juntas correctamente. Entonces se prueba (ciertos aspectos) el sistema como un todo con las descripciones de los use-case como input para esta prueba. Al final de la prueba, el sistema puede ser entregado

P lan de D is ena dor deP rueb as P rue bas

D is en o d e P rueb as

Im plem en tar P rue bas

E v alu ar P ru eba s

P roba dor de In tegrac io n

E jecu tar P ru eba s de Inte gracion

P rob ad or S istem a

E jecu ta r P ru eba s de S istem a

D isena dor

D is enar prueb as de C lase s y P aq uetes

Im pla m enta dor

Im ple m e ntar p rue bas de C om pon entes y S ubsis tem as

El flujo de trabajo en Pruebas, mostrado en trminos de trabajadores y sus actividades. Las flechas indican un orden lgico entre las actividades.

Iteraciones Desde una perspectiva tcnica el desarrollo de software es visto como una sucesin de iteraciones, a travs de las cuales el software en desarrollo evoluciona incrementalmente. Una iteracin consiste de las actividades de planeamiento, anlisis, diseo, implementacin y pruebas en varias proporciones dependiendo de donde esta localizada la iteracin en el ciclo de desarrollo. La perspectiva de manejo y la perspectiva tcnica estn conciliadas y en particular el fin de las fases est sincronizadas con el fin de las iteraciones. En otras palabras, cada fase esta partida en una o mas iteraciones. Sin embargo las dos perspectivas de manejo y tcnicahacen mas que simplemente sincronizarse en unos pocos hitos identificados, ambas contribuyen a producir un conjunto comn de productos y documentos que evolucionan en el tiempo. La habilidad de esos documentos y la satisfaccin de los criterios de evaluacin establecidos para el producto y los documentos son elementos tangibles que constituyen los hitos en mucho mas que meras fechas en el calendario.

MED

Pg. 11

INDICE DE CONTENIDO Gua de Estndares

3. Estructura del Manual de Sistema

3.1. Definicin El Manual de Sistema comprende el anlisis y diseo del Sistema.

3.2. Contenido En el documento se han contemplado principalmente los siguientes aspectos: Descripcin Tcnica General del Sistema, donde se muestra los mdulos y procesos definidos para el sistema, los tpicos que cubre son los siguientes: Objetivo. Alcance del Proyecto. Modelo Propuesto del Sistema. Aspectos Funcionales del Sistema Herramientas empleadas para el desarrollo del Sistema. Diagrama de Contexto del Sistema, conteniendo la relacin del Sistema con su entorno o clientes principales. Especificacin y Diagramacin de Use Cases, que permite mostrar la interaccin entre los actores identificados y el sistema. Se incluye la diagramacin de los Use Case. La descripcin del Use Case contara con una seccin en la cual se especificara las salidas (productos) que emitir el Sistema. En los anexos 7.1. ; 7.2. se muestra la representacin grfica y el formato de especificacin a utilizar para cada Use Case identificado. Modelo Entidad Relacin, este diagrama representara el modelo de datos, es decir todas las entidades contempladas para el Sistema con sus respectivas relaciones y cardinalidad. Modelo de Datos, contiene el diseo fsico y lgico de la base de datos, indicndose la descripcin de las entidades y sus atributos. Diccionario de Datos, definicin de atributos y campos definidos en la base de datos a ser empleada por el sistema. El diccionario de datos incluir la relacin de otros objetos creados en la Base de Datos como los procedimientos almacenados, vistas, reglas o triggers. Seguridad y Parmetros, Contiene la definicin de los niveles de Seguridad y Acceso de usuarios al Sistema; as como los programas de actualizacin de tablas paramtricas. Mdulos y Opciones del Sistema, contiene la estructura de mdulos y opciones desarrolladas para el funcionamiento del sistema. Relacin de Tablas Paramtricas, contiene la relacin de tablas paramtricas definidas en el sistema. Campos Auditables en el Sistema, contiene la relacin de tablas a ser auditadas en el sistema.

MED

Pg. 12

INDICE DE CONTENIDO Gua de Estndares

4. Estructura del Manual de Usuario

4.1. Definicin El manual de usuario comprende la descripcin detallada de las diferentes opciones comprendidas en los mdulos desarrollados para el sistema. 4.2. Contenido En el documento se han contemplado principalmente los siguientes aspectos: Introduccin, conteniendo una descripcin general del Sistema Requerimientos mnimos para un adecuado funcionamiento del Sistema, donde se indicara la caractersticas mnimas necesarias de los equipos donde se instalara el Sistema. Conceptos generales, conteniendo las instrucciones de operacin (ayudas, bsquedas, botones de acceso rpido, convenciones para el uso del teclado y mouse) Seguridad y Acceso, conteniendo las instrucciones para lograr accesar en forma adecuada al Sistema de acuerdo a los privilegios asignados por el administrador del Sistema. Descripcin de opciones del Sistema, conteniendo el inventario y descripcin detallada de cada una de las opciones existentes en el sistema. Se incluir la descripcin de las opciones correspondientes a los reportes anexndose modelos de dichos reportes.

MED

Pg. 13

INDICE DE CONTENIDO Gua de Estndares

5. Estndares para Especificaciones Tcnicas

5.1. Estndares de definicin de Base de Datos 5.1.1. Normas para definicin de Modelos de Datos Entidad Relacin Objetivo Establecer los Estndares a ser utilizados para el Diseo de Bases de Datos de los Sistemas de Informacin, normando la definicin de un Modelo de Datos Entidad Relacin como requisito fundamental para el Diseo de Bases de Datos. El propsito de los estndares es propiciar una gradual y efectiva integracin corporativa de los datos sin redundancias, mejorando al mismo tiempo la calidad y el nivel de satisfaccin de los Usuarios de los Mdulos que se desarrollen. Normas Generales para Modelamiento Entidad Relacin: Uso De Los Estndares: Los Estndares de Datos debern ser utilizados sin restricciones para el Modelamiento de Datos y Diseo de las Bases de Datos. Obligatoriedad del Modelo Entidad Relacin: La definicin de un Modelo Entidad Relacin ser un requisito fundamental y paso previo al diseo de una Base de Datos. Diccionario de Datos y uso de CASE: Para la Administracin integral de los Datos de los Sistemas de Informacin, se mantendr un Diccionario de Datos y un Modelo Global de Entidades y Relaciones, usando la herramienta CASE designada. Notacin a utilizar para los Diagramas Entidad Relacin: Los Diagramas Entidad Relacin debern elaborarse utilizando la notacin y convenciones de la Metodologa de Ingeniera de la Informacin, de amplia difusin. El CASE a emplear deber utilizar una notacin que es extensin al Mtodo de la Ingeniera de la Informacin. Administracin de Datos: El administrador de Datos apoyar, controlar y evaluar la definicin de los Modelos Entidad Relacin y diseo de Bases de Datos correspondientes, a fin de garantizar la calidad de sus definiciones sin redundancias. Administrar el Diccionario de Datos estableciendo los entregables que debern incorporarse al mismo. Revisar o formular los Mtodos de Codificacin.

MED

Pg. 14

INDICE DE CONTENIDO Gua de Estndares Informacin a entregar para el desarrollo de Software: Modelo de Entidad - Relacin Lista de Entidades, incluyendo la descripcin de cada una. Relaciones entre Entidades, incluyendo tipo de asociacin entre Entidades Atributos por Entidad, incluyendo: el significado de cada uno, claves primarias, tablas de codificacin utilizadas, uso de alias. Diagrama E-R, en CASE.

Diseo de la Base de Datos Indicar si se utiliza Software de Administracin Base de Datos y/o lenguaje Manejador de Archivos Si se utiliza Software de Base de Datos Relacionales (RDBMS), entregar: Lista de tablas con sus atributos o columnas, claves primarias y forneas Definicin de la base de Datos (DDL) incluyendo las reglas de integridad referencial y procedimientos necesarios para las operaciones de Base de Datos. Si se utiliza manejadores de Archivos y no RDBMS, entregar: Lista de archivos indicando la finalidad de cada uno Estructura de Datos de cada archivo, claves primarias, claves de relacionamiento, claves alternas e ndices.

MED

Pg. 15

INDICE DE CONTENIDO Gua de Estndares 5.1.2. Estndares para definir Nombre de Entidades y Relaciones Naturaleza de los Nombres Utilizados El modelo Entidad Relacin es una representacin conceptual e integral de la informacin del negocio, cuyas componentes (entidades, relaciones y atributos) deben ser entendibles por su nombre. El valor de un Diagrama Entidad Relacin no radica en su buen dibujo, sino en su capacidad de ser representativo y entendible. Los usuarios podrn verificar y comprobar si realmente ste cumple o recoge a cabalidad toda la informacin asociada a las reglas y funciones del negocio que manejan. Objetivo de los Estandares de Nombres Establecer un procedimiento nico que permita uniformizar la definicin de los nombres de ENTIDADES Y RELACIONES utilizando lenguaje natural a fin de lograr una rpida identificacin y comprensin del Modelo. Los objetivos especficos son: Documentar las Entidades y Reglas del negocio de manera nica en el Diccionario de Datos, para su uso compartido por cualquier nueva Base de Datos o Aplicacin desarrollada. Evitar la generacin de Entidades redundantes, la ocurrencia de sinnimos y homnimos, mediante la reutilizacin de Entidades ya definidas en el Diccionario. Utilizar estos nombres en los procesos de Ingeniera de Reversa de Bases de Datos existentes, a fin de que el modelo Entidad Relacin generado, se integre al resto de Entidades establecidas. Permitir la definicin de nombres tcnicos para la identificacin de Tablas Relacionales, Restricciones de Integridad, Indices de Archivos requeridos para la implementacin de las Bases de Datos que se diseen a partir del Modelo de Entidad Relacin. Estos nombres debern incluirse como alias o atributos de la Entidad que representan en el Diccionario. Definir nombres de RELACIONES entre Entidades claras y concisas, que permitan mediante su lectura comprender las reglas del negocio que representan.

Reglas Estndares para Definir Nombres de Entidades y Relaciones Se utilizarn nombres en singular en la identificacin de Entidades. Esto refuerza la idea de que una Entidad es un patrn para mantener el mismo tipo de informacin acerca de algo. Ejemplo: MEDICO, PACIENTE. Igualmente, por que la lectura de toda relacin entre Entidades (chequeo de cardinalidad de la regla del negocio) empieza con una Entidad leda en singular. En la generacin del nombre de ENTIDAD se eliminar todo tipo de proposiciones. Ejemplo: DE, DEL, DE LA, EN LA, LA, LO, POR. Adems del nombre de identificacin de cada ENTIDAD, se deber definir un sinnimo o alias denominado Nombre Abreviado por cada Entidad en el Diccionario. Este nombre estandarizado en ocho posiciones podr ser utilizado como nombre del archivo equivalente, cuando no se posea DBMS o para nombrar restricciones de integridad en el Diseo de Base de Datos con RDBMS.

MED

Pg. 16

INDICE DE CONTENIDO Gua de Estndares El Administrador de Datos verificar la definicin de nombres de ENTIDADES, RELACIONES, TABLAS y ATRIBUTOS que luego pasarn al Diccionario de Datos de Produccin de la Empresa. Toda relacin entre ENTIDADES tiene dos formas de lectura segn Entidad que se use como punto de partida en la lectura. Cada una de estas se expresar con un nombre diferente; por consiguiente una RELACION tendr dos nombres que lo identifican. Si la herramienta CASE lo facilita, toda RELACION entre ENTIDADES podr definirse con un nombre nico en lugar de los dos que lo identifican. Dicho nombre ser elegido entre los dos que se establecen, usndose aquel que mejor expresa dicha Relacin de forma natural. El nombre se ubicar en el diagrama en la posicin que corresponda segn el mtodo de las agujas del reloj. Ejemplo: La relacin entre entidades TRABAJADOR y DEPENDIENTE, puede tomar dos nombres: (Trabajador tiene...) y (Dependiente depende...), estableceremos como nombre nico de la relacin depende. No se deber inventar o crear ENTIDADES. El proceso de Modelamiento E-R, consiste en descubrir aquellas que estn ntimamente relacionadas a las funciones del negocio o sistema en estudio. Estructura De Formacin Del Nombre De Entidades Reglas de sintaxis a utilizar: SUSTANTIVO (Ejemplo: FACTURA) SUSTANTIVO ADJETIVO ADJETIVO (Ejemplo: TRABAJADOR MED) NOMBRE ENTIDAD 1 NOMBRE ENTIDAD 2.. (Ejemplo: MEDICO SERVICIO) Caractersticas: Nmero mximo de caracteres: 24

Debern ser escritas con letras MAYUSCULAS Solo en los casos en que sea muy difcil abreviar el nombre formado por varios Adjetivos, deber utilizar el tope de 24. Ejemplo: ORDEN COMPRA DIRECTA En lo posible deber evitarse utilizar muchos adjetivos, siendo lo ms recomendable utilizar como nombre de entidad un sustantivo. Ejemplo: PACIENTE, CONSULTORIO, ASEGURADO. El uso de separadores ser opcional, pudindose usar - o _, solo cuando la herramienta CASE no permitiese el uso de un carcter en blanco entre palabras. El nombre de Entidades Asociativas podra tomar la forma: NOMBRE ENTIDAD 1, NOMBRE ENTIDAD 2, ...; en los casos en que sea muy difcil encontrar un nombre nico apropiado. Entidad 1, Entidad 2, ...; son las entidades que participan como miembros de la Relacin que origin la Entidad Asociativa. En muchos casos, es posible encontrar nombres formados por Verbos en Gerundio o Sustantivos Abstractos (terminacin: into, sin, cin, dad) debido a que la gran mayora de las Entidades Asociativas provienen de relaciones muchos a muchos identificados con verbos. Ejemplo: Revisin, Programacin, Inscripcin, Almacenamiento, Enfermedad.
MED Pg. 17

INDICE DE CONTENIDO Gua de Estndares Es posible establecer conversaciones para definir nombres de Entidad. La ventaja de las convenciones es lograr una mayor abreviacin del nombre de la Entidad. Ejemplo: ORDEN DE COMPRA, se nombrar como O-C, PEDIDO COMPROBANTE DE SALIDA, se nombrar como PECOSA.

Estructura De Formacin Del Nombre Abreviado De Entidad Este es un nombre adicional definido como alias o sinnimo en el momento de definir una ENTIDAD en el Diccionario de Datos. Ser utilizado para nombrar el archivo plano equivalente a la Entidad, cuando las Aplicaciones a desarrollar se implementen sin usar Software de Administracin de Datos (DBMS). Tambin, podr ser utilizado para nombrar las restricciones de integridad o claves forneas en aquellos casos en que la herramienta CASE o RDBMS utilizada lo requieran. Estructura del Nombre Abreviado: Regla de Sintaxis a utilizar: Nmero mximo de caracteres: 8 DDDDDDDD

Las ocho posiciones son un descriptor abreviado del nombre de la Entidad en formato libre. Si el nombre de la Entidad est compuesto por dos o ms palabras, el descriptor, deber contener las primeras letras o consonantes de todas las palabras del nombre de Entidad, sin exceder la longitud normada. Ejemplo: PROMED Nombre abreviado de Entidad Asociativa Programacin Mdica. DIAGCON Nombre abreviado de la Entidad Diagnstico Consulta. Estructura De Formacin De Los Nombres De Las Relaciones Reglas de sintaxis a utilizar: Verbo (Ejemplo: supervisa, es, ordena, origina) Verbo Aux: Ser + Verbo: Pasado Part.(Ejemplo: es supervisado, es asignado) Verbo Aux: Ser + Propos + [Verbo] (Ejemplo: es para, es de, esta sobre, esta bajo, es en) (Ejemplo: es para trabajar bajo, es del alta de) Caractersticas: Nmero mximo de caracteres: 24

Debern ser escritas con letras minsculas

Debern ser capaces de hacer una oracin con significado con las Entidades, expresando de manera natural una regla del negocio de la Institucin. Ejemplo 1: Cada EMPLEADO trabaja en uno a ms DEPARTAMENTOS Ejemplo 2: Cada RECETA contiene uno o ms MEDICAMENTOS Ejemplo 3: Cada TRABAJADOR MED es ASEGURADO

MED

Pg. 18

INDICE DE CONTENIDO Gua de Estndares Tipos y Categoras De Entidades Las Entidades pueden ser: Entidades Fsicas

Caractersticas Tangibles Fcil de Identificar Fcil de Entender Categoras (Principales) Seres : MEDICO, EMPLEADO, PACIENTE, ANIMAL Equipos : COMPUTADORA, VEHICULO, PLANTA Bienes : ESCRITORIO, LIBRO, SOFTWARE, TELEFONO Materiales : LUBRICANTE, PAPEL, CABLE, COMBUSTIBLE Edificios, Lugares : ALMACEN, OFICINA, PLAYA ESTACIONAMIENTO Documentos : FACTURA, O-C, RECETA, PLANILLA, NORMA

Entidades Conceptuales

Caractersticas Intangibles Pueden ser difciles de entender Definido en trmino de otras Entidades Categoras (Principales) Organizaciones : CENTRO ASISTENCIAL, UNIDAD ORGANICA Acuerdos : CONVENIO, ALQUILER, HIPOTECA, PLAN Duracin Anticipada : CURSO, PROGRAMA, CONGRESO, ACTIVIDAD Abstracciones : ESTRATEGIA, SERVICIO, PUESTO, CUENTA

Entidades Evento/Estado

Caractersticas Tipo Evento Tipo Estado Ambas Ambas Categoras Evento Estado

: Algo que sucede : Una condicin o situacin : Muy abstractas : Definidas en trminos de otras

: CONSULTA, ENTREGA, COMPRA, DEPOSITO : HOSPITALIZACION, ENFERMEDAD, INSCRIPCION

5.1.3. Estndares para Nombrar los Datos Reglas (Lenguaje OF) Generales El nombre de Datos o Atributo, deber indicar la CLASE DE DATO a travs de un cdigo nico, el cual ser tomado como prefijo del nombre. Adicional a este prefijo, el

MED

Pg. 19

INDICE DE CONTENIDO Gua de Estndares nombre podr contener abreviaturas universales, propias de la Empresa, o acrnimos de acuerdo a reglas especficas de formacin. En la generacin del nombre se eliminar las preposiciones: DE, DEL, DE LA, EN LA, LA y LO; referenciando a las palabras (descritores) en singular. Cuando sea necesario aadir caractersticas, se deber utilizar acrnimos conocidos, eliminando las vocales en lo posible. Ejemplo 1: DESCUENTO PREFERENCIAL se codificar como M_DSC_PREFERN. Ejemplo 2: IMPUESTO GENERAL A LAS VENTAS DEL CLIENTE se codificar como M_IGV_CLNT (donde M indica que el dato es un Monto. Las reglas de formacin se vern en los siguientes puntos). La definicin de los nombres de datos se llevar a cabo bsicamente en el proceso de Modelamiento de Datos. Algunos nombres de datos podrn definirse tambin en el Modelamiento de Procesos elaborado por los Analistas de Sistemas, con cargo a ser incluido en el Modelo de Datos respectivo, todo ello de acuerdo a una Metodologa de Desarrollo de Sistemas a establecer. El administrador de Datos validar y aprobar la definicin de los nombres de datos (atributos) y sus caractersticas, que luego pasarn al Diccionario de Datos de la Empresa. El Diccionario de Datos, (implementado por el software CASE y DBMS oficial) es la fuente nica a partir del cual debern generarse las definiciones de Bases de Datos y las estructuras de datos a utilizar por el software de desarrollo de aplicaciones. Estructura Del Nombre De Un Dato o Atributo C - DDDDD_ < DDDDD_ . . . > Donde: C DDDDD la _ : Clase del Dato (se detalla en el punto 3.3). : Descriptor del Dato, pueden venir varios descriptores, en cuyo caso Longitud mxima de cada descriptor ser de cinco. : Separador de Descriptores. Si el software no soportase usar -

Consideraciones Bsicas Nmero mximo de caracteres del nombre de datos: 24

En lo posible deber evitarse utilizar muchos descriptores, siendo lo ms recomendable establecer el nombre del dato con un solo Descriptor, en cuyo caso se podr expandir a ms de cinco caracteres.

El Separador podr obviarse en los casos en que la lectura del nombre de datos permita una rpida identificacin del mismo. Solo en los casos que sea muy difcil abreviar un nombre de datos formado por varios descriptores, ste no deber excederse de 24 posiciones en total. Por lo general, deber tratarse de abreviar el nombre de acuerdo a las reglas establecidas sin poner en riesgo su rpida identificacin.

MED

Pg. 20

INDICE DE CONTENIDO Gua de Estndares Si por limitaciones del lenguaje de programacin ha utilizar para el desarrollo de Aplicaciones, el nmero mximo de caracteres soportado fuese menor de 24, el nombre abreviado establecido en los programas se definir como ALIAS en el Diccionario. Dicho ALIAS deber estar conformado por un solo descriptor. Clase De Dato o Atributo Las clases de dato que se identificarn son: B C D F H I M N P Q T G Z Bandera (flag), indicador de dos valores Cdigo Descripcin Fecha Tiempo (Hora, Minuto, Segundos) Indicador con ms de dos valores (ver clase B) Monto monetario Nmero Porcentaje Cantidad no monetaria Texto libre Grupo de datos (estructura) Perodo de tiempo (horas, das, semanas, meses, etc.)

Abreviaturas Universales Formacin Las Abreviaturas Universales (propias de la Empresa), usadas como descriptores en el nombre, son aplicadas a las palabras ms usuales y sern definidas en coordinacin con el Administrador de Datos, el mismo que mantendr una tabla de ellas en el Diccionario de Datos. Las Abreviaturas deben respetar ciertas reglas de generacin, estas son: Terminaciones CION, se aade la letra N aR, donde a es una vocal, se le aade la letra R aL, donde a es una vocal, se aade la letra L DA / DO, se aade la letra D Preposiciones Y / IN / IM, se comienza con la letra I DE / DES, se comienza con la letra D EX, se comienza con la letra X SUB, se comienza con la letra S. Convenciones Es posible establecer Convenciones para definir una abreviatura, solo en este caso se obviarn las reglas de generacin. La ventaja de las convenciones es lograr una mayor abreviacin del nombre de datos. Ejemplo: DEPARTAMENTO se nombra como DPTO.

MED

Pg. 21

INDICE DE CONTENIDO Gua de Estndares Dominios Es un conjunto de reglas de validacin de un Negocio, restricciones de formato y otras propiedades que se aplican a un grupo de atributos, parmetros y estructuras de datos. En general los Dominios se definen antes de ingresar los detalles de un atributo en el Diccionario, utilizando un nombre de identificacin estandarizado. Ejemplo de Dominios: Una lista de valores, un rango, una lista o rango calificado, o cualquier combinacin de estas. Cuando el atributo es definido se le asocia el nombre de Dominio, con lo cual estar sujeto a un conjunto comn de chequeos de validacin. Estructura del nombre de un dominio: DM_DDDDD <_DDDDD> Donde: Longitud DM DDDDD (3.2) _ : Nmero mximo de caracteres 15 : Abreviatura indicando que es un Dominio : Descriptor, sigue las mismas reglas que en el nombre de atributos : Separador, si el software no soportase usar -.

Procedimientos Almacenados ( Stored Procedures) Un procedimiento almacenado es un conjunto de instrucciones escritas en el lenguaje Transact - SQL (T-SQL) y es compilado y ejecutado en una base de datos relacional. Traduccin bsica: El conjunto de instrucciones que es usado por la computadora para llevar a cabo la operacin solicitada se desglosa hasta el menor nivel disponible posible en la plataforma en la que se trabaja. Estructura del Nombre de un Procedimiento Almacenado: SP_XXX_XXXXXXXXXX Descripcin SEL si es Consulta, INS si es solo insercin, UPD si es solo actualizacin, DEL si es solo eliminacin, MNT si es un proceso de insercin, actualizacin y eliminacin, REP si es un Store para Reportes y PRO si realiza un proceso, RGL si es un procedimiento de reglas validacin. Indica que el objeto es un Procedimiento Almacenado. Para colocar la descripcin, usar en lo posible el nombre de la tabla sobre la cual acta el Procedimiento Almacenado, y en el caso de ser un proceso, poner en forma abreviada una descripcin que lo identifique, si exceder en ningn caso los 30 caracteres en total.

MED

Pg. 22

INDICE DE CONTENIDO Gua de Estndares 5.2. Estndares de Programacin 5.2.1. Definicin de Variables Los tres primeros caracteres corresponden al tipo de variable, y los siguientes corresponden a la descripcin de la variable. Como mximo la longitud de la variable no debe exceder de los 15 caracteres. Si la variable va a contener los datos de un campo especfico, es preferible que la descripcin sea la misma que el nombre del campo. Si la variable es una variable global (del sistema) se le antepondr la letra G seguida de _. De acuerdo al tipo de variable los prefijos pueden ser: PREFIJO int ing crn vrn arr dte dbl sng str obj dcm rst bln TIPO DE VARIABLE Integer LongInt Currency Variant Array Date Double Single String Object Decimal Recordset Booleano (2 Estados)

5.2.2. Definicin de Funciones y Procedimientos Se utilizar el siguiente formato ABC_XXXXXXXXXXXX (funciones) AB_XXXXXXXXXXXX (procedimientos) A: Si es funcin o Procedimiento - F Funcin - S Procedimiento (Subrutina) B: Si es Local o Global - L Local - G Global C: El tipo de Dato que devuelve - S String - N Numeric - D Date - B Boolean - V Variant

MED

Pg. 23

INDICE DE CONTENIDO Gua de Estndares XXXXXXXXXXXX : El nombre que indica lo que realiza la funcin o procedimiento. Hay que tomar en cuenta que esta descripcin debe ser lo ms abreviada posible sin perder el sentido de la accin a realizar. Considerar un mximo total de 24 caracteres. 5.2.3. Definicin de Mdulos Para nombrar los Mdulos los cuales contendrn las funciones Generales del sistema se usar la siguiente nomenclatura: MOD_XXXXXXXXXXXXXXX XXXXXXXXXXXXXXX Indica la descripcin del mdulo Ejemplo: Mod_General Sistema Mdulo que contiene las Funciones Generales del

5.2.4. Definicin de Clases Se deber crear un directorio por cada clase, debido a que despus a cada clase se le anexara un proyecto para la creacin de un dll (Componente). El nombre de las clases tendr el siguiente formato: Donde : I Xxxxxxxxxxxx Ixxxxxxxxxxxx

Identificador de clase (siempre mayscula) Nombre de la clase, la primera en mayscula y las dems en minsculas.

Los objetos que se creen o instancien de estas clases, se les antepondr la o (en minscula) y el nombre de la variable. El nombre del proyecto debe ser el mismo que la clase, quitndole la I inicial y anteponiendo las letras MED, como se muestra a continuacin: MEDXxxxxxxxxxxx 5.2.5. Definicin de Formas Los tres primeros caracteres representan su tipo: frm, luego el nombre del mdulo respectivo, los caracteres siguientes corresponden al tema. En lo posible usar abreviaciones sin perder el significado del tema. Ejemplo: Si se tratara de un formulario que realiza el mantenimiento de la tabla de datos del empleado que se encuentra en el mdulo de operaciones, se llamara: frmOperacionesManEmpleado. 5.2.6. Definicin de Controles Los tres primeros caracteres indican el tipo de control del que se trata, que unidos al nombre del campo en la base de datos mediante _ (underline), conforman el nombre del control.

MED

Pg. 24

INDICE DE CONTENIDO Gua de Estndares

De acuerdo al tipo de control los prefijos pueden ser: PREFIJO chk cmd dir fil grd img iml lin mnu opt shp cbo dat drv fra hsb lbl lst ole pic txt uct: tab: dtp: crt TIPO DE CONTROL Chck Box Command Button Directory List Box File List Box Grid Image Image List Line Menu Option Button Shape Combo Box Data Drive List Box Frame Horizontal Scroll Bar Label List Box OLE Picture Box Text Box UserControl TabStrip o SStab DataPicker Cristal Report

Para los botones tipo Aceptar, Cancelar, basta con poner cmd_descripcin. Para los botones de Ayuda, cmd_ayu_nombre del campo. 5.3. Estndares De Diseo de Pantallas CONTROLES: Resolucin de pantalla FORMS Tipo de Letra Tamao Color Border style : : : : Sans Serif 8 pts. Negro ccFixedSingle No maximisable, si minimisable : 800x600

MED

Pg. 25

INDICE DE CONTENIDO Gua de Estndares CONTROLES TextBox y ComboBox Alto (Height) Colores 315 Campo normal fondo blanco letras negras Campo para muestra (read only) - fondo plomo(&H00E0E0E0&), letras negras Campo de ingreso obligatorio fondo amarillo(&H00C0FFFF&), letras negras Campo Deshabilitado fondo blanco letras gris Grillas Se usara el control DataGrid. Tabs Control Estilo Titulos Toolbar Todos las acciones se realizarn desde el toolbar del form, si se necesita agregar nuevas acciones (Botones) se le adicionarn en el toolbar del form. Las acciones(Botones) que el form nunca usar tendrn que ser ocultadas cambiando su propiedad Visible a FALSE. Los botones del numerados del 1 al 8 y del 12 al 14 son de mantenimiento estndar. Para agregar nuevos botones usar los espacios entre estos rangos. : : : ssTabs Windows 95 Proper

Item 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14.

Accin Nuevo Abrir Eliminar Grabar --- Separacin Visualizar Imprimir --- Separacin Libre Libre Libre --- Separacin Ayuda Cerrar

MED

Pg. 26

INDICE DE CONTENIDO Gua de Estndares

6. Aspectos de Seguridad y Parmetros

6.1. Mdulo de Seguridad 6.1.1. Aspectos Funcionales del Mdulo de Seguridad El Mdulo de Seguridad y Acceso permite al usuario accesar al Sistema, de acuerdo, a los privilegios asignados por el Administrador del Mdulo, donde el usuario debe ingresar su identificacin de usuario y contrasea para ingresar al Sistema.

La ventana que muestra es la siguiente:

Nombre de Usuario En este espacio se debe digitar el Nombre de Usuario. Contrasea En este espacio se debe digitar el password o contrasea.

As mismo encontramos los siguientes botones, cuya descripcin es la siguiente:

Permite el acceso al Sistema de Capacitacin Docente si la contrasea es correcta. Permite salir del Sistema.

MED

Pg. 27

INDICE DE CONTENIDO Gua de Estndares Actualizacin de Usuario Permite el registro de los usuarios que tendrn acceso al Sistema, as como dar o quitar privilegios a los mismos.

Para actualizar un Usuario, seleccione la opcin Actualizacin de Usuario del Men Seguridad y Parmetros, con lo cual aparece una ventana como se muestra:

En esta ventana el Sistema permite registrar nuevos usuarios, modificar los existentes o cambiar de clave a algn usuario, con la ayuda de los botones que aparecen en la parte superior de la ventana; Estos botones se activan conforme se ingresa la informacin solicitada en el campo Cdigo.

MED

Pg. 28

INDICE DE CONTENIDO Gua de Estndares Botones de la Barra de Herramientas de Actualizacin de Usuario:

Icono

Descripcin

Nuevo Abrir Grabar

Permite ingresar un nuevo usuario. Permite buscar un usuario existente.

Permite guardar los cambios de usuario.

Visualizar

Permite visualizar un reporte en relacin de usuarios existentes. Permite imprimir la relacin de usuarios existentes.

Imprimir Cambio de Clave

Permite cambiar la clave de ingreso de un mismo Usuario.

Permite regenerar el men de opciones en caso se haya ingresado una

Regenerar Men Opciones Ayuda Cerrar

nueva opcin. El Supervisor del Sistema opcin.

slo tiene acceso a esta

Proporciona ayuda sobre la opcin.

Permite cerrar la opcin y retornar al men principal.

MED

Pg. 29

INDICE DE CONTENIDO Gua de Estndares Para acceder a Actualizar un Usuario proceda de la siguiente manera:

Ingrese el Cdigo y Nombre:

Para que el Usuario tenga acceso a funciones que slo tiene acceso el Supervisor marque la casilla de verificacin:

Modifique el Estado del Usuario, marcando con un clic en el botn de radio de Activado o Desactivado.

Activado: El Usuario puede ingresar al Sistema de Capacitacin Docente con su Cdigo y Nombre.

Desactivado: El Usuario no puede ingresar al Sistema de Capacitacin Docente con su Cdigo y Nombre.

En la parte inferior derecha de la ventana, aparece tambin la opcin de registrar el rango de horas en las que un usuario puede tener acceso al sistema:

En este recuadro se ingresa la hora y minutos que se registra como hora de inicio y hora final de acceso para un usuario.

MED

Pg. 30

INDICE DE CONTENIDO Gua de Estndares Asimismo, en la parte derecha de la ventana aparece una columna que muestra los Das y Horas de trabajo:

En esta columna se marca con un Clic en las casillas de verificacin los das en los que el usuario puede tener acceso al Sistema. Las horas sealadas son las que se registraron en el recuadro de Hora de Inicio y Hora Final. Adems al hacer clic en actualizamos el rango de

horas en las que el usuario podr tener acceso al sistema.

Ingreso de Nuevo Usuario Para dar ingreso a un usuario el procedimiento es el siguiente:

Ingrese el Cdigo del Usuario y luego pulse la tecla <TAB> e ingrese el Nombre del Usuario:

Marque la casilla de Verificacin para que el usuario ejecute opciones como Supervisor.

MED

Pg. 31

INDICE DE CONTENIDO Gua de Estndares Ingresados los Datos del Usuario el Sistema muestra automticamente la Lista de Privilegios.

Cada una de las opciones del Sistema est marcada con un check en color rojo que indica que el Usuario tiene acceso a estas opciones.

Con la ayuda del mouse, haga doble clic en cada opcin, sta se marcar con un aspa en color celeste, indicando as que la opcin est desactivada, dando acceso al nuevo usuario slo a aqullas que queden con el check en color rojo.

La Pantalla de opciones del Men, tiene un manejo muy similar al Explorador del Windows, al dar doble clic sobre una opcin, se obtiene una relacin de opciones dentro de sta.

MED

Pg. 32

INDICE DE CONTENIDO Gua de Estndares Si se muestra este smbolo al lado de la opcin, significa que hay ms opciones por visualizar. Si se muestra este smbolo al lado de la opcin, significa que no hay ms opciones por visualizar. Indica que el usuario tiene acceso a esta opcin del sistema. Haciendo doble clic en cada opcin, sta se marcar con check de color rojo. Indica que el usuario no tiene acceso a esta opcin del sistema. Haciendo doble clic en cada opcin, sta se marcar con un aspa en color celeste. Luego de activar las opciones necesarias para el usuario en la Lista de Privilegios, se define tambin el Estado del Usuario, y los Das y Horas de Trabajo.

Haga clic en el botn de radio Activado.

El Usuario tiene acceso al Sistema de Capacitacin Docente los das lunes, martes, mircoles, jueves y viernes de 10.00 a 17.00 horas.

MED

Pg. 33

INDICE DE CONTENIDO Gua de Estndares La ventana completa con todos los atributos asignados es:

Haga clic en

y el Sistema muestra el siguiente cuadro de dilogo:

Si hace clic en Si, el Sistema devolver la Clave del Usuario o Contrasea:

Haga clic en ACEPTAR y el nuevo usuario ya est registrado en el Sistema.

MED

Pg. 34

INDICE DE CONTENIDO Gua de Estndares Modificacin de Usuario

Para modificar un usuario ya registrado en el sistema se procede de la siguiente manera: Haga clic en y aparece la Ayuda de Usuarios.

Ingrese el Cdigo o Nombre y haga clic en

MED

Pg. 35

INDICE DE CONTENIDO Gua de Estndares Haga clic en Aceptar. El Sistema muestra automticamente los privilegios ya existentes para el Usuario seleccionado.

Los botones

se encuentran activados.

Con la ayuda del Mouse haga las modificaciones necesarias para el Usuario, asigne o quite privilegios, modifique el Estado del Usuario as como Das y Horas de acceso.

MED

Pg. 36

INDICE DE CONTENIDO Gua de Estndares Haga clic en para actualizar los cambios realizados y el Sistema muestra el

siguiente cuadro de dilogo:

Si hace clic en Si, el Usuario queda registrado con los privilegios recientemente asignados.

Haga clic en Aceptar.

MED

Pg. 37

INDICE DE CONTENIDO Gua de Estndares Cambio de Clave El Sistema permite slo al propio Usuario cambiar su clave de acceso. Ingrese al Sistema de Capacitacin Docente con su Cdigo y clave de Usuario. Ingrese a la opcin Actualizacin de Usuario del Men Seguridad y Parmetros y proceda a recuperar los datos de Usuario. Hace clic en

El Sistema muestra la siguiente ventana de dilogo:

Proceda a ingresar la Contrasea Nueva y seguidamente confirme la Contrasea:

MED

Pg. 38

INDICE DE CONTENIDO Gua de Estndares Haga clic en Aceptar.

Haga clic en cuando lo imprima

y se muestra el aspecto que tendr el reporte de Usuarios

Haga clic en Haga clic en

para obtener la impresin del reporte. si desea exportar el reporte en formato de archivo.

MED

Pg. 39

INDICE DE CONTENIDO Gua de Estndares Actualizacin de Datos del Propietario Esta opcin nos permite actualizar la informacin de la Sede Administrativa donde se instalar el Sistema de Capacitacin Docente.

Botones de la Barra de Herramientas de Actualizacin de Datos del Propietario:

Icono

Descripcin

Grabar

Permite guardar los cambios de la Sede Administrativa seleccionada.

Ayuda

Proporciona ayuda sobre la opcin.

Cerrar

Permite cerrar la opcin y retornar al men principal.

MED

Pg. 40

INDICE DE CONTENIDO Gua de Estndares Para actualizar Datos del Propietario el procedimiento es el siguiente: Seleccione la Razn Social de la empresa y el Sistema muestra automticamente la Direccin, Telfono, Fax y E-mail.

Nota: La informacin que el Sistema muestra automticamente ha sido ingresada en la opcin Actualizacin de Sedes del men Seguridad y Parmetros.

Seleccione de las listas desplegables la Sede, Subsede, Unidad e ingrese el nmero de R.U.C.

Nota: La informacin que el Sistema muestra automticamente ha sido ingresada en la opcin Actualizacin de Sedes del men Seguridad y Parmetros. Las siguientes opciones de Parmetros y Informacin estn relacionadas con el Men de Transferencias (opcin Generacin de la Informacin y Recepcin/Consolidacin de la informacin) transferencia. de la seleccin que el Usuario realice aqu depende el proceso de

MED

Pg. 41

INDICE DE CONTENIDO Gua de Estndares El marco Parmetros contiene dos opciones: Haga clic en la casilla de verificacin Genera para la generacin de archivos de texto con la informacin de los parmetros que hayan sido modificados en el perodo de la generacin. Haga clic en la casilla de verificacin Consolida para la recepcin de archivos de texto obtenidos del Sistema en el proceso de la generacin de archivos.

El marco Informacin contiene dos opciones: Haga clic en la casilla de verificacin Genera para la seleccin de los registros con la informacin que haya sido modificada en el perodo de la generacin. Haga clic en la casilla de verificacin Consolida para la recepcin de registros obtenidos del Sistema en el proceso de la generacin de informacin.

Ingrese los datos que desean que aparezcan en la Cabecera 1 y Cabecera 2 de los reportes que proporciona el Sistema de Capacitacin Docente.

La informacin ingresada en el marco de Formato para Reportes (Cabecera 1 y Cabecera 2) se refleja como cabecera de los documentos emitidos por el Sistema de Capacitacin Docente.

MED

Pg. 42

INDICE DE CONTENIDO Gua de Estndares El marco Directorio Repositorio permite ingresar la ruta mediante una ventana de Ayuda.

Nota: El Directorio Repositorio se encuentra en la PC donde est instalado el Sistema de Capacitacin Docente.

Haga clic en

para acceder a la siguiente ventana:

Seleccione el Directorio y haga clic en Aceptar.

MED

Pg. 43

INDICE DE CONTENIDO Gua de Estndares La ventana con la informacin completa es:

Haga clic en

Haga clic en Si para grabar el registro.

Haga clic en Aceptar.

MED

Pg. 44

INDICE DE CONTENIDO Gua de Estndares

7. ANEXOS
7.1. Representacin Grfica Use Case.

Manejar Relacin con el Cliente(Use Case <N>)

USE CASE Extends/ Uses

USE CASE

Actor

Extends/ Uses

USE CASE

Fecha de Ultima modificacin:

Responsable de Modificacin:

MED

Pg. 45

INDICE DE CONTENIDO Gua de Estndares 7.2. Formato de Especificacin Use Case. 7.2.1. Formato de Use Case USE CASE <N> Objetivo Nivel Precondiciones Condicin de Fin Exitoso Condicin de Fin Errado Actores Primarios Actores Secundarios Evento DESCRIPCION

VALIDACIONES INFORMACION RELACIONADA

Use case Primario: Use cases Secundarios: SALIDAS

OBSERVACIONES COMENTARIOS DE DISEO

MED

Pg. 46

INDICE DE CONTENIDO Gua de Estndares 7.2.2. Descripcin TERMINOS USE CASE <N> Objetivo Nivel DEFINICION El nombre del Use Case que ser representado por una frase corta con verbos activos Especificacin detallada del objetivo

Se indicara si es de tipo resumen, tarea principal o sub-funcin Condiciones que deben cumplirse para la ejecucin del Use Case Estado Final Estado Final luego de un Final errado en base al objetivo Nombre del descripcin rol del actor primario o su

Precondiciones

Condicin de Fin Exitoso Condicin de Fin Errado

Actores Primarios

Actores Secundarios Evento DESCRIPCION VALIDACIONES

Nombre del rol del actor secundario o su descripcin Accin hacia el sistema con la cual se inicia el Use Case Descripcin del escenario desde el evento inicial hasta la conclusin final del objetivo. Consideraciones a tomarse en cuenta para lograr una condicin de fin con xito.

INFORMACION RELACIONADA

Use case Primario: Use cases Secundarios:

SALIDAS OBSERVACIONES COMENTARIOS DE DISEO

Nombre del Use Case que incluye al presente Use Case Nombre de los Uses Cases Secundario dependiente del presente Use Case Inventario de consultas y reportes emitidos por el presente Use Case Otras consideraciones en formato libre. Descripcin de posibles temas de diseo

MED

Pg. 47

INDICE DE CONTENIDO Gua de Estndares 7.3. Cabecera de Reportes a ser usados por el Sistema.

< ORGANIZACION > < SEDE > < SISTEMA > < PROGRAMA >

<TITULO DEL REPORTE>

Pgina : <n/m> Fecha : <dd/mm/aa> Hora : <hh/mm/ss>

Los Reportes debern de seguir el estndar definido a continuacin: Tamao de la Hoja: Formato A4 Fuente de Letra: Arial

TITULO DEL REPORTE ORGANIZACION SEDE NOMBRE DEL REPORTE PAGINA

: La fuente en Mayscula, negrita y tamao de 12 pts. : La fuente en Mayscula, negrita y tamao de 12 pts. : La fuente en Mayuscula y tamao de 10 pts. : La fuente en Tipo Ttulo y tamao de 08 pts. : El nmero de la pgina est seguido del smbolo " / " y

del total de pginas que contiene el reporte, la fuente es tamao 10 pts.

FECHA : Indica el Da, Mes y Ao en que se emite el reporte; la

fuente es tamao 10 pts. El ao debe contener 4 dgitos.

HORA : Hora, Minutos y Segundos en que se gener el reporte;

la fuente en tamao 10 pts.

MED

Pg. 48