nomenclatura de modulos técnicos, objetos oracle y nombres de

Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
NOMENCLATURA DE
MODULOS TÉCNICOS,
OBJETOS ORACLE Y
NOMBRES DE ARCHIVOS DE
PROYECTO
Fecha
01/09/2008
15/01/2009
18/03/2009
07/05/2009
29/01/2010
Versión
1.0
1.1
1.2
1.3
1.4
Cambios
Versión Inicial
Normalización de particiones
Inclusión de módulos para Business Objects
Inclusión de módulos para Documentum
Inclusión de módulo de Informes de Crystal Report 2008 en
plataforma Business Objects
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 1
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
1 TABLA DE CONTENIDO
1
TABLA DE CONTENIDO............................................................................ 2
2
NOMENCLATURA DE LOS MÓDULOS TÉCNICOS................................. 3
2.1
3
Nomenclatura y Normativa de obligado cumplimiento............................. 3
NORMATIVA SOBRE OBJETOS ORACLE............................................... 6
3.1
Estandares de Nomenclatura de Objetos Almacenados en el Núcleo .... 6
3.2
Nomenclatura de Campos .......................................................................... 8
4
NOMENCLATURA SOBRE PROGRAMAS, GRÁFICOS, ETC ................. 8
5
ESTRUCTURA DE DIRECTORIOS PARA LOS PROYECTOS ................. 9
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 2
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
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
sedp_modd
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,
sedp_pub
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
sedp_ws
sedp_ws_envio
sedp_ws_recep
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
sedp_batch
sedp_batch_susc
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
sedp_batch_cdatos
Carga Inicial de datos de Documentum la
descripción será cdatos
Java: Librería
[proy]_lib_[descripción]
Todos los módulos técnicos Java Librería,
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
sedp_lib
Página: 3
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
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
Crystal Report
Módulo técnico que contiene los informes Crystal
sedp_crws
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
proyecto
eclipse
de
desarrollados
los
java
sedp_jmtd_mantenimiento
métodos
según
plantilla
fw2_jmtd_plantilla.zip
Documentum
[proy]_tbo_[descripción]
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
proyecto
eclipse
personalización
documentum
del
del
programa
cliente
(Webtop)
de
estandar
según
sedp_webtop
de
plantilla
fw2_web_pub.zip
Forms 6
[proy]_apl
Todos los módulos técnicos forms6 ó forms10g,
sedp_apl
obligatoriamente llevarán después del código
Forms 10g
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
obligatoriamente
se
6
o
sedp
forms10g,
denominarán
como
el
de
las
código de proyecto.
[proy]_ayuda
Serán
web
estáticas
las
ayudas
sedp_ayuda
aplicaciones java (si existen varios módulos java
para un proyecto compartirán la web estática de
ayuda)
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 4
Nombre del manual
[descripción]
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
El nombre de las web estáticas que no sean
empresas_publicas
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
Datawarehouse
[PROY]_DWH
Todos los módulos técnicos Datawarehouse
(Microstrategy),
obligatoriamente
SEDP_DWH
llevarán
después del código del proyecto el sufijo _DWH.
URL
[url]
Cualquier URL (alias de acceso, redirección) a
seguimiento_contratos
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.
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), obligatoriamente llevarán
Business Objects
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
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
Report Plataforma
Reports de un determinado proyecto que se
Business Objects
invocan a través de la plataforma de Business
sedp_bo_etl
sedp_crbo
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
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 5
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
3 NORMATIVA SOBRE OBJETOS ORACLE
3.1 Estandares de Nomenclatura de Objetos Almacenados en
el Núcleo
Objeto
Nomenclatura
Table
[proy]_[tabla]
View
[proy]_v_[vista]
Materialized View [proy]_mv_[vista]
Sequence
Synonym
Indices con
Integridad
Referencial
basada en
Triggers o sin
Integridad
Referencial
Indices con
Integridad
Referencial
basada en
Primary Key y
Foreign Key
[proy]_s_[secuenciador]
[proy]_[sinónimo]
Comentarios
Tablas Oracle.
Actualmente las tablas y vistas se crean
con nombre interno y sinónimos iguales.
Todos estos objetos son públicos.
Vistas Oracle.
Consultar Guia de Diseño Erwin para ver
la normalización (Construcción, Definición
y restricciones) de éstos objetos
Secuenciadores Oracle.
Sinónimos.
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
XAKnn[Nombre_de_tabla]
Para los índices de Clave Alternativa
Únicos
XIEnn[Nombre_de_tabla]
Para los índices alternativos (Con
Duplicados)
XGRnn[Nombre_de_tabla]
Para los índices Geográficos (Oracle
Spatial)
XDTS[Nombre_de_tabla]
Índices multi columnas de Intermedia
Text.
XBMnn[Nombre_de_tabla]
Indices bitmap (Datawarehouse …)
PK[Nombre_de_tabla]
Para los índices de Clave Primaria
AKnn[Nombre_de_tabla]
Para los índices de Clave Alternativa
Únicos
IEnn[Nombre_de_tabla]
Para los índices alternativos (Con
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 6
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
Duplicados)
Primary Key
Check
Trigger
Procedure
Function
Packages
Temporary Table
Thesaurus
Partition
Para los índices de Clave Foránea
GRnn[Nombre_de_tabla]
Para los índices Geográficos (Oracle
Spatial)
DTS[Nombre_de_tabla]
Índices multi columnas de Intermedia
Text.
BMnn[Nombre_de_tabla]
Indices bitmap (Datawarehouse …)
PK[Nombre_de_Tabla]
Foreign Key
Datastores
IFnn[Nombre_de_tabla]
Primary Key con el uso de integridad
referencial declarativa.
FK[Nombre_de_Tabla]_nn
Foreign Key con el uso de integridad
referencial declarativa.
[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.
[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.
[proy]_PROC_[procedure]
Las procedures pertenecerán siempre a
un Proyecto y las generales irán con el
proyecto SIS.
[proy]_FUNC_[Función]
Al igual que las Procedures, las funciones
siempre pertenecerán a un proyecto y las
generales serán de SIS.
[proy]_PACK_[package]
Los packages pertenecerán siempre a un
Proyecto y las generales irán con el
proyecto SIS.
[proy]_GTT_[Tabla]
Tablas temporales Oracle (Global
Temporary Table).
[proy]_[tabla]_DTS
Se utilizará para definir los Datastores
necesarios para los índices de
INTERMEDIA TEXT
[proy]_THESA_[Nombre_de_Thesa Thesaurus de Intermedia Text.
urus]
(Diccionario de sinónimos con Intermdia
Text)
[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
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 7
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
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.
[Nombre_de_Tabla]_SPAR_[criterio Iden. pto. anterior
]
SubPartition
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_
DS_
FC_
IT_
NM_
TL_
Código
Descripción
Fecha
Item, marca, indicador
Valor numérico, contador
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
CGI general
Nomenclatura
[proy]_bd.exe
Comentarios
CGI general. Se puede desarrollar en
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 8
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
CGI calendario
CGI listados
CGI lista valores
Batch de W NT
[proy]_cal.exe
[proy]_lis.exe
[proy]_lv.exe
[proy][nn]_jb.exe
DLL control acceso
[proy]_acc.dll
Programa Windows
[proy][nnnn].exe
Imágenes
[PROY]_[NNN].[ext]
Forms 4.5, 6, 10g
[PROY]_[NNNN].[ext]
Informes Report 6,
10g
Shell
[PROY]_[NNNN].[ext]
[PROY][NNNN].[ext]
Pro*C y C’s
Plantillas ofimática
[PROY][NNNN]
[PROY][NNNN].[ext]
StarTeam
[proy]_[NNNN]
Informes Crystal
Reports 10, 11
[PROY]_[NNNN].[ext]
ActiveX
IcmX[PROY][Nombre]
Delphi u otra herramienta.
Lista de valores de calendario en CGI
Listados de CGI de Delphi
Programa de listas de valores CGI
Programa de ejecución batch en Windows
NT. [n] será cualquier valor letra o número.
Librería
dinámica
para
recoger
usuario/password
programa Windows escrito en Delphi o
cualquier otra herramienta.
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
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.
Igual que en el caso de Forms salvo que las
extensiones son diferentes. rep,
Cualquier script que sea necesario. [ext]
podrá ser csh, sh, perl, etc, dependiendo
del tipo de script que contenga.
Cualquier programa escrito en C
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, ...
Así se nombrará el proyecto dentro de los
repositorios de Starteam. En NNNN se
indicará la versión del proyecto. Ejemplo:
PROY_0100
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
Se utilizará el prefijo ‘IcmX’ seguido del
proyecto + porción descriptiva de lo que
hace el ActiveX.
5 ESTRUCTURA DE DIRECTORIOS PARA LOS PROYECTOS
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 9
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
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”
siguientes:
siendo
los
directorios
los
FORMS
Donde se guardarán los ficheros de fichero de Forms. Ficheros con extensión
fmb, fmx, mmb, mmx, pll, etc
REPORTS
Donde se almacenarán los programas de Reports, ficheros con extensión rdf,
rep
GRAF
Cualquier fichero del tipo bmp, gif, ico que necesitemos para el desarrollo
INI
Se utilizará en el entorno Forms para almacenar el archivo .ini de la Aplicación
ETC
Cualquier otro archivo que no sepamos ubicar se almacenará en este directorio
AYUDAS
Directorio donde se genera los ficheros HLP y donde están todos los fuentes
necesarios para actualizar y mantener este archivo.
SQL
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.
PLANTILLAS
Para almacenar las plantillas de documentos ofimáticos como los de
WordPerfect, Quattro Pro, etc
PROC
Se recogerá en este directorio los programas C’s y Pro*C’s del proyecto.
DOC
Cualquier documento de la aplicación en el que estemos trabajando. Se
recuerda que toda la documentación debe ser almacenada en MIDAX.
PROG
Se utilizará para el entorno Delphi y aquí residirá todos los archivos de un
proyecto.
PROG_CGI
Se utilizará para almacenar los proyectos de Delphi-CGI.
INSTALAR
Se utilizará para almacenar los ficheros del asistente de creación de discos de
instalación del proyecto.
COMPONENTES
Se utiliza para almacenar los componentes especiales de este proyecto
GLIS
Se utiliza para almacenar los ficheros de creación del diccionario de GLIS
JAVA
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
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 10
Nombre del manual
Nomenclatura sobre Objetos Oracle y Nombres de Archivos de Proyecto
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
Área de Integración y Arquitectura de Aplicaciones
Dirección de Análisis y Mantenimiento de Aplicaciones y Desarrollos Institucionales
Subdirección General de Desarrollo, Tecnología e Infraestructuras
Página: 11