NOMENCLATURA DE MODULOS TÉCNICOS, OBJETOS ORACLE Y NOMBRES DE ARCHIVOS DE PROYECTO

Transcripción

1 NOMENCLATURA DE MODULOS TÉCNICOS, OBJETOS ORACLE Y NOMBRES DE ARCHIVOS DE PROYECTO Fecha Versión Cambios 01/09/ Versión Inicial 15/01/ Normalización de particiones 18/03/ Inclusión de módulos para Business Objects 07/05/ Inclusión de módulos para Documentum 29/01/ Inclusión de módulo de Informes de Crystal Report 2008 en plataforma Business Objects Página: 1

2 1 TABLA DE CONTENIDO 1 TABLA DE CONTENIDO NOMENCLATURA DE LOS MÓDULOS TÉCNICOS Nomenclatura y Normativa de obligado cumplimiento NORMATIVA SOBRE OBJETOS ORACLE Estandares de Nomenclatura de Objetos Almacenados en el Núcleo Nomenclatura de Campos NOMENCLATURA SOBRE PROGRAMAS, GRÁFICOS, ETC ESTRUCTURA DE DIRECTORIOS PARA LOS PROYECTOS... 9 Página: 2

3 2 NOMENCLATURA DE LOS MÓDULOS TÉCNICOS 2.1 Nomenclatura y Normativa de obligado cumplimiento En este documento se pretende dejar fijada la nomenclatura que deben cumplir todos los módulos técnicos para su puesta en Producción. Entorno Nomenclatura Descripción Ejemplos Modelo de Datos [proy]_modd Todos los módulos técnicos que únicamente tengan modelo de datos, no teniendo ningún componente de aplicativo asociado, obligatoriamente llevarán después del código del proyecto el sufijo _modd. Java: Web [proy]_[descripcion] Todos los módulos técnicos Java, obligatoriamente llevarán después del código del proyecto un sufijo que identifique lo más claramente posible al módulo Java: Webservices [proy]_ws_[descripción] Todos los Webservices, obligatoriamente llevarán después del código del proyecto la particula _ws. Opcionalmente se podrá incluir un sufijo descriptivo del módulo técnico. Este sufijo será obligatorio en caso de que para un proyecto existan varios Webservices. Java: Batch [proy]_batch_[descripción] Todos los módulos técnicos Java Batch, obligatoriamente llevarán después del código del proyecto la partícula _batch. Opcionalmente se podrá incluir un sufijo descriptivo del módulo técnico. Este sufijo será obligatorio en caso de que para un proyecto existan varios módulos Batch. En el caso de que sea un Java Batch de Carga Inicial de datos de Documentum la descripción será cdatos sedp_modd sedp_pub sedp_ws sedp_ws_envio sedp_ws_recep sedp_batch sedp_batch_susc sedp_batch_cdatos Java: Librería [proy]_lib_[descripción] Todos los módulos técnicos Java Librería, sedp_lib Página: 3

4 obligatoriamente llevarán después del código sedp_lib_general del proyecto la partícula _lib. Opcionalmente se podrá incluir un sufijo descriptivo del módulo técnico. Este sufijo será obligatorio en caso de que para un proyecto existan varios módulos Librería. Java Informes [proy]_crws Módulo técnico que contiene los informes Crystal sedp_crws Crystal Report Reports de un determinado proyecto que se invocan a través de web services [PROY]_DOCU Módulo que contiene la docapp y los script SEDP_DOCU necesarios para crear el modelo de datos de documentum [proy]_jmtd_[descripción] Módulo que contiene los fuentes java en formato sedp_jmtd_mantenimiento proyecto eclipse de los java métodos desarrollados según plantilla Documentum [proy]_tbo_[descripción] fw2_jmtd_plantilla.zip Módulo que contiene los fuentes java en formato sedp_tbo_expedientes proyecto eclipse de los tbo s desarrollados según plantilla fw2_batch_plantilla.zip [proy]_webtop Módulo que contiene los fuentes java en formato sedp_webtop proyecto eclipse del programa de personalización del cliente estandar de documentum (Webtop) según plantilla fw2_web_pub.zip Forms 6 [proy]_apl Todos los módulos técnicos forms6 ó forms10g, sedp_apl Forms 10g obligatoriamente llevarán después del código del proyecto el sufijo _apl. El nombre de cualquier módulo desarrollo en otra tecnología no podrá empezar por [proy]_apl. Web estática [proy] Todas las web estáticas de entrada de una aplicación forms 6 o forms10g, obligatoriamente se denominarán como el código de proyecto. [proy]_ayuda Serán web estáticas las ayudas de las aplicaciones java (si existen varios módulos java para un proyecto compartirán la web estática de ayuda) sedp sedp_ayuda Página: 4

5 [descripción] El nombre de las web estáticas que no sean entrada de una aplicación forms, será libre, con la única restricción de que no exista ya algún módulo técnico con el mismo nombre. Por este motivo, se tendrá que dar de alta en POAPS un módulo funcional cuyo nombre sea igual al de la web estática empresas_publicas Datawarehouse [PROY]_DWH Todos los módulos técnicos Datawarehouse (Microstrategy), obligatoriamente llevarán después del código del proyecto el sufijo _DWH. URL [url] Cualquier URL (alias de acceso, redirección) a un módulo técnico será libre, con la única restricción de que no exista ya algún módulo técnico o alguna redirección con el mismo nombre. Por este motivo, se tendrá que dar de alta en POAPS un módulo funcional cuyo nombre sea igual al de la URL. Además, este módulo funcional se debe asociar con el módulo técnico para el que se esté realizando la redirección. SEDP_DWH seguimiento_contratos Forms 4.5 [proy]_f45 No se permite la instalación de nuevos módulos técnicos desarrollados en esta tecnología. Cliente/Servidor [proy]_cs No se permite la instalación de nuevos módulos técnicos desarrollados en esta tecnología. Business Objects: [proy]_bo_dw Todos los módulos técnicos Datawarehouse sedp_bo_dw Business Objects (Business Objects), obligatoriamente llevarán después del código del proyecto el sufijo _bo_dw. Business Objects: [proy]_bo_etl Todos los módulos técnicos de ETL (Data sedp_bo_etl Data Services Services), obligatoriamente llevarán después (ETL) del código del proyecto el sufijo _bo_etl. Informes Crystal [proy]_crbo Módulo técnico que contiene los informes Crystal sedp_crbo Report Plataforma Reports de un determinado proyecto que se Business Objects invocan a través de la plataforma de Business Objects Nota: Todos los ejemplos se hacen para el proyecto de ejemplo SEDP Importante: Cualquiera de los módulos de la lista anterior tendrá que registrarse en la aplicación MIDAX, asociándose bajo el proyecto a desarrollar Página: 5

6 3 NORMATIVA SOBRE OBJETOS ORACLE 3.1 Estandares de Nomenclatura de Objetos Almacenados en el Núcleo Objeto Nomenclatura Comentarios Table [proy]_[tabla] Tablas Oracle. Actualmente las tablas y vistas se crean con nombre interno y sinónimos iguales. Todos estos objetos son públicos. View [proy]_v_[vista] Vistas Oracle. Materialized View [proy]_mv_[vista] Consultar Guia de Diseño Erwin para ver la normalización (Construcción, Definición y restricciones) de éstos objetos Sequence [proy]_s_[secuenciador] Secuenciadores Oracle. Synonym [proy]_[sinónimo] Sinónimos. Indices con Integridad Referencial basada en Triggers o sin Integridad Referencial En este apartado no se permite el uso de índices XIF* (índices de clave ajena ó foránea), generados automáticamente por ERwin. Deberán crearse manualmente, bien como XAK* o como XIE*. XPK[Nombre_de_tabla] Para los índices de Clave Primaria Indices con Integridad Referencial basada en Primary Key y Foreign Key XAKnn[Nombre_de_tabla] XIEnn[Nombre_de_tabla] XGRnn[Nombre_de_tabla] XDTS[Nombre_de_tabla] XBMnn[Nombre_de_tabla] PK[Nombre_de_tabla] AKnn[Nombre_de_tabla] IEnn[Nombre_de_tabla] Para los índices de Clave Alternativa Únicos Para los índices alternativos (Con Duplicados) Para los índices Geográficos (Oracle Spatial) Índices multi columnas de Intermedia Text. Indices bitmap (Datawarehouse ) Para los índices de Clave Primaria Para los índices de Clave Alternativa Únicos Para los índices alternativos (Con Página: 6

7 Duplicados) IFnn[Nombre_de_tabla] Para los índices de Clave Foránea GRnn[Nombre_de_tabla] DTS[Nombre_de_tabla] BMnn[Nombre_de_tabla] Para los índices Geográficos (Oracle Spatial) Índices multi columnas de Intermedia Text. Indices bitmap (Datawarehouse ) Primary Key PK[Nombre_de_Tabla] Primary Key con el uso de integridad referencial declarativa. Foreign Key FK[Nombre_de_Tabla]_nn Foreign Key con el uso de integridad referencial declarativa. Check [proy]_check_[restricción] Checks de validación de atributo. El nombre de la restricción podrá o no incluir el nombre de la columna. Trigger [proy]_[tabla]_trig_[t]_[a] Se nombrará como la tabla y después en <T> tiempo se indicará y Before -antes o After -después- de ejecutar la A -acción, con lo que sus valores serán B/A. <A> será la acción y podrá ser Insert, Delete o Update, por lo que los valores serán I/D/U. Procedure [proy]_proc_[procedure] Las procedures pertenecerán siempre a un Proyecto y las generales irán con el proyecto SIS. Function [proy]_func_[función] Al igual que las Procedures, las funciones siempre pertenecerán a un proyecto y las generales serán de SIS. Packages [proy]_pack_[package] Los packages pertenecerán siempre a un Proyecto y las generales irán con el proyecto SIS. Temporary Table [proy]_gtt_[tabla] Tablas temporales Oracle (Global Temporary Table). Datastores [proy]_[tabla]_dts Se utilizará para definir los Datastores necesarios para los índices de INTERMEDIA TEXT Thesaurus [proy]_thesa_[nombre_de_thesa urus] Thesaurus de Intermedia Text. (Diccionario de sinónimos con Intermdia Text) Partition [Nombre_de_Tabla]_PAR_[criterio] [criterio] Se utiliza para definir el criterio por el que se rige la partición en concreto. Debe aparecer criterio y valor, pero si por motivos de longitud, no es posible se indicará el valor La longitud de las particiones es la misma que para las tablas Ejemplo: XXXX_EXP_PAR_ANNO_2007_MES_01 Página: 7

8 SubPartition [Nombre_de_Tabla]_SPAR_[criterio ] XXXX_EXPEDIENTES_PAR_2007_01 Para crear particiones se ha de justificar el motivo por el cual se requiere esta funcionalidad, posteriormente el DBA en base a criterios técnicos de ICM decidirá su creación. Por este motivo se aconseja no utilizar el nombre de la partición en sentencias SQL dado que si al final el DBA decide no crearla/s originaría modificaciones en el código fuente. Iden. pto. anterior Cualquier Obtejo a utilizar que no esté presente en el documento se debe consultar previamente a su implementación. 3.2 Nomenclatura de Campos Como norma general y siempre que sea posible se emplearán las dos primeras posiciones del nombre para identificar el tipo de campo de acuerdo con la siguiente lista: CD_ Código DS_ Descripción FC_ Fecha IT_ Item, marca, indicador NM_ Valor numérico, contador TL_ Texto libre, observaciones, comentarios, etc. 4 NOMENCLATURA SOBRE PROGRAMAS, GRÁFICOS, ETC Es necesario que establezcamos una nomenclatura de nombre de programas, gráficos, etc, ya que en muchas ocasiones, estos fichero de diferentes aplicaciones van a compartir directorios y si no se estableciese esta definición, tendríamos problemas pues se machacarían los citados ficheros al haber coincidencia entre aplicaciones. Por todo esto, las aplicaciones, sean del volumen de código que sea, es necesaria censarla en MIDAX con 4 letras o números, éstos nos servirán para la identificación de todos los ficheros del proyecto. Objeto Nomenclatura Comentarios CGI general [proy]_bd.exe CGI general. Se puede desarrollar en Página: 8

9 Delphi u otra herramienta. CGI calendario [proy]_cal.exe Lista de valores de calendario en CGI CGI listados [proy]_lis.exe Listados de CGI de Delphi CGI lista valores [proy]_lv.exe Programa de listas de valores CGI Batch de W NT [proy][nn]_jb.exe Programa de ejecución batch en Windows NT. [n] será cualquier valor letra o número. DLL control acceso [proy]_acc.dll Librería dinámica para recoger usuario/password Programa Windows [proy][nnnn].exe programa Windows escrito en Delphi o cualquier otra herramienta. Imágenes [PROY]_[NNN].[ext] Nos servirá para las imágenes del tipo ico, bmp, gif, jpg, etcetera [nnn] cualquier letra y/o número. [ext] las extensiones de ico, gif, jpg, etcetera Forms 4.5, 6, 10g [PROY]_[NNNN].[ext] Todos estos archivos irán en mayúsculas. [NNNN] podrá ser cualquier letra o número. [ext] se ajustará a las extensiones de estos archivos, inp, frm, fmb, fmx, mmb, mmx, pll, plx, etcetera. Archivos fmb hasta 12 caracteres sin incluir la extensión. En Forms10g los nombres de archivos irán en mayúsculas excepto la extensión. Informes Report 6, 10g [PROY]_[NNNN].[ext] Igual que en el caso de Forms salvo que las extensiones son diferentes. rep, Shell [PROY][NNNN].[ext] Cualquier script que sea necesario. [ext] podrá ser csh, sh, perl, etc, dependiendo del tipo de script que contenga. Pro*C y C s [PROY][NNNN] Cualquier programa escrito en C Plantillas ofimática [PROY][NNNN].[ext] Cualquier plantilla de WordPeferct, Quattro Pro, etc mantendrá este nombre y se utilizará la ext para indicar cuál es la aplicación que lo debe utilizar, WPD = WordPerfect, WB1, WB2, WB3 = Quattro Pro,... StarTeam [proy]_[nnnn] Así se nombrará el proyecto dentro de los repositorios de Starteam. En NNNN se indicará la versión del proyecto. Ejemplo: PROY_0100 Informes Crystal Reports 10, 11 [PROY]_[NNNN].[ext] Los informes de Crystal cuya ejecución se realice bajo plataforma Windows deben seguir ésta nomenclatura. (Los contenidos en un.ear no han de seguirla). Extensión rpt ActiveX IcmX[PROY][Nombre] Se utilizará el prefijo IcmX seguido del proyecto + porción descriptiva de lo que hace el ActiveX. 5 ESTRUCTURA DE DIRECTORIOS PARA LOS PROYECTOS Página: 9

10 Para todos los Desarrollos que sean necesarios desarrollarlos en entornos Windows y se utilice el producto de gestión de versiones Starteam, se establece que su estructura y contenido es el siguiente: Estructura: \\<proyecto><versión>\ directorio siendo los directorios los siguientes: FORMS REPORTS GRAF INI ETC AYUDAS SQL PLANTILLAS PROC DOC PROG PROG_CGI INSTALAR COMPONENTES Donde se guardarán los ficheros de fichero de Forms. Ficheros con extensión fmb, fmx, mmb, mmx, pll, etc Donde se almacenarán los programas de Reports, ficheros con extensión rdf, rep Cualquier fichero del tipo bmp, gif, ico que necesitemos para el desarrollo Se utilizará en el entorno Forms para almacenar el archivo.ini de la Aplicación Cualquier otro archivo que no sepamos ubicar se almacenará en este directorio Directorio donde se genera los ficheros HLP y donde están todos los fuentes necesarios para actualizar y mantener este archivo. Scripts de SQL, procedimientos, funciones, etc, en el que estemos trabajando en el proyecto. También se utilizará para almacenar los ficheros de ERWIN, BPWIN, etc -modelo de datos y procesos- cuando estemos trabajando en ellos, Se recuerda que es necesario que los archivos de ERWin, BPWin, se almacenen en MIDAX en sus versiones definitivas. Para almacenar las plantillas de documentos ofimáticos como los de WordPerfect, Quattro Pro, etc Se recogerá en este directorio los programas C s y Pro*C s del proyecto. Cualquier documento de la aplicación en el que estemos trabajando. Se recuerda que toda la documentación debe ser almacenada en MIDAX. Se utilizará para el entorno Delphi y aquí residirá todos los archivos de un proyecto. Se utilizará para almacenar los proyectos de Delphi-CGI. Se utilizará para almacenar los ficheros del asistente de creación de discos de instalación del proyecto. Se utiliza para almacenar los componentes especiales de este proyecto GLIS JAVA Se utiliza para almacenar los ficheros de creación del diccionario de GLIS Se seguirá la misma estructura que la utilizada en las plantillas suministradas con los distintos tipos de controlador como base de los nuevos proyectos. Solamente es necesario crear las carpetas si existe contenido, dado que al haberse estudiado todas las posibilidades/necesidades con todas las Página: 10

11 herramientas de desarrollo actuales, en algunos entornos hay carpetas que no tienen ningún sentido. Se puede indicar más de un directorio separando las "rutas" completas por el carácter ";" En proyectos FORMS, Los nombres de los directorios deben ir en minúscula y los nombres de los ficheros en mayúscula con la extensión en Minúscula Página: 11