Nomenclatura y estándares en el modelo de datos

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Mejores prácticas y recomendaciones de implementación > Mejores prácticas en el Modelo de Datos >

Nomenclatura y estándares en el modelo de datos

Introducción

La siguiente sección lista una nomenclatura sugerida para definir su modelo de datos de una manera que se promueva la usabilidad, mantenibilidad y la legibilidad para usted y sus compañeros del equipo.

 

Una nomenclatura clara y estándar para nombrar sus entidades y atributos es fundamental para una construcción fácil e intuitiva (p.e para la navegación de XPath) y para su comunicación, la cual conlleva a un mejor entendimiento de los procesos para cualquier miembro del equipo realizando cambios sobre ellos.

 

 

Nomenclatura para entidades

Al apoyarse en un estándar para nombrar sus entidades, usted ahorrará tiempo durante la implementación de sus proyectos y al realizar cambios sobre ellos en un futuro.

 

1. Definición de las entidades

Los nombres de las Entidades deben describir claramente la información que contenga. Asegúrese de utilizar nombres cortos o abreviaturas.

 

BPDatamodel2

 

2. Nomenclatura sugerida para las entidades

Se recomienda utilizar una nomenclatura para las entidades que identifique claramente su tipo y alcance.

Las entidades pueden ser clasificadas por varios criterios:

 

Tipo de entidad (Maestra, Paramétricas).

Para facilitar la generación de reportes personalizados, se sugiere utilizar los siguientes prefijos para los tipos de entidades:

oP: identifica la entidad como paramétrico.

oM: identifica la entidad como maestro.

 

Tipo Alcance (Privado, Público).

oPrivado: Se utiliza dentro de un proceso.

oPúblico: Se utiliza en más de un proceso. por ejemplo. Cliente, TipoDocumento, etc.

Recomendamos el uso de prefijos para nombrar las entidades privadas utilizando 3 caracteres basados el nombre del proceso.

 

Ejemplos.

Entidad: Cliente

Tipo: Maestro

Alcance: Privado (usado por el proceso Solicitud del Cliente)

Nombre: M_SC_Cliente

 

Entidad: Ciudad

Tipo: Paramétrica

Alcance: Privado (usado por el proceso Solicitud del Cliente)

Nombre: P_SC_Ciudad

 

Entidad: Firmas

Tipo: Paramétrica

Alcance: Pública (utilizado por varios procesos)

Nombre: P_Firma

 

 

Nomenclatura para atributos

Al apoyarse en un estándar para nombrar sus atributos, usted ahorrará tiempo durante la implementación de sus proyectos y al realizar cambios sobre ellos en un futuro.

 

1. Definición de los atributos

Dé a los atributos un nombre corto y claro que permita fácilmente su mapeo en el diseño de formas, la definición de las expresiones o la configuración de interfaces.

Se recomienda que trate de usar el mismo nombre que se mostrará en los Formularios.

 

2. Nomenclatura sugerida para los atributos

Se recomienda utilizar una nomenclatura que utilice prefijos en los atributos, y así identificar claramente su tipo y alcance.

 

Nótese que el nombre de un atributo debe tener menos de 15 caracteres, incluyendo el prefijo que pueda tener.

Utilice nombres en singular. Utilice nombres en plural cada vez que utilice colecciones, por ejemplo: xSolicitudes, xClientes, xDocumentos.

 

La siguiente tabla muestra los prefijos sugeridos de acuerdo al tipo de atributo:

 

Tipo de atributo

Prefijo

Ejemplo

Boolean

b

bCustomer, bActive

Currency

c

cSalary, cDiscount, cPrice

Date – Time

d

dBirth, dCreated

Integer, Big Integer, Small Integer, Tiny Integer

i

iDistance

String, Extended text

s

sNotes

File

u

uPhoto, uAttachment

Float

f

fRate, fDiscount

Image

img

imgProfile

Real

r

rGreatDistance

Entity

km, kp (km para maestra, kp para paramétrica)

kmCustomer, kpCurrency

Collection

x

xElements, xRequests,

xMembers