vestandar: normas por objeto fecha de informe:...

de 8

06/05/2010

Objeto

vEstandar: Normas por objeto

Fecha de informe:


Nombre Observaciones

Tabla de datos

Identificador Irán del concepto más genérico al más particular. Ejemplo: VTA_PED_CABVTA: Tablas de Ventas: VTA_PED, VTA_ALB, etc.PED: Tipo de documento de Venta: PED, ALB, FAC, etc.CAB: Separación del documento. CABecera, LINeas.

En tablas relacionadas se pondrá el nombre de ambas tablas: ENT_ENT será la tabla que relacione Entidades entre sí

Identificador tablas en memoria Cuando la tabla sea en memoria añadiremos el sufijo "_MEM"

Nombres singular y plural de la tabla Deben completarse correctamente respetando el estilo de escritura donde sólo se pone en mayúscula la primera letra de la primera palabra.


Tabla estática

Icono 1) Recomendamos el uso de iconos. Ajustando el tamaño al lugar donde se vaya a mostrar.

2) Los iconos debería estar en el proyecto de datos, salvo que puedan ser heredados de otro proyecto.


Variable global

Precaución 1) Usar con precaución las variables globales en disco en objetos visuales o contenidos iniciales en campos o en fórmulas ya que no están optimizadas.


Librería externa

Identificador 1) Será el mismo que el nombre de la dll sin el punto y la extensión.

Parámetros 1) Los nombres de los parámetros han de describir su contenido.


Dibujo

Proyecto de datos 1) Irán incluidos los iconos de tablas, tablas estáticas y los que queramos utilizar en esquemas.

Proyecto de aplicación 1) Es conveniente crear un proyecto de aplicación para almacenar recursos comunes a múltiples aplicaciones como son los dibujos y que podrán utilizar todos los proyectos que lo hereden.

Optimización 1) Es muy importante optimizar el tamaño de los dibujos de cara a que el peso de la aplicación sea la menor posible.


Rejilla

Formato pieImportes tendrán la suma acumulada de la columna y formateados numéricamenteEn la primera columna posible pondremos el total de registros de la lista

Alineamiento textos Recomendación alineamiento vertical centrado salvo objetos texto

Numéricos y fecha a la derecha y textos a la izquierda. Tanto en títulos como en columnas.

Powered by velneo.esPol. Ind. A Granxa | Edif. vCenterRúa D Esquina paralela 336400 Porriño | PontevedraEspaña

Telf. (+34) 902 366 382Fax (+34) 902 932 [email protected]

velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:


Identificación Para identificar a una rejilla, se usará el Alias de la tabla a la que pertenece, y en el caso de que la tabla tenga más de una rejilla, añadiremos una descripción corta de la función de la rejilla.Una de localizador como mínimo y que el ancho totla de la rejilla no supere los 500 píxeles

PropiedadesUsaremos el ID: Sólo si son representativos o necesarios

Las rejillas con una sóla columna aunque tengan máximo disponible hay k ponerles un mínimo de espacio

Si ninguna de las columnas permite max disponible se palicará a la primera columna

Si creamos una rejilla editable siempre habrá otra no editable


Formulario

Maquetación 1) Como se va representar el titulo del formualrio:Ejercicio y empresa y cuando se debe representar

2) Botones disponibles: Aceptar, cancelar, desactivar y eliminar

3) Se verá el boton eliminar cuando el formulario sea de una tabla no importante

4) Como norma los textos irán centrados verticalmente

5) Los campos fecha llevarán siempre el calendario

6) Para los campos numéricos irán con microscroller

7) Se utilizarán layouts.

8) Separadores de pestaña arriba.

9) Recomendamos formulario de 1024 x 600

10) Crearemos siempre un pestañeador con un punto de insercciónRecomendación 1) Es más práctico y rápido utilizar un único formulario para el alta, modificación y baja.

2) Siempre que sea conveniente se creará un formulario independiente y específico para modificación o baja.

Botones 1) Por defecto un formulario estándar tendrá las siguientes teclas:

1) Aceptar: comando Aceptar 2) Cancelar: comando Cancelar 3) Eliminar: comando Eliminar Controlado


Cesta de la compra

Recomendación 1) Tener en cuenta que la rejilla que se presenta será en modo cuadro de diálogo por lo que su tamaño deberá estar optimizado al tamaño de presentación de la cesta que es fijo.


Búsqueda

Recomendaciones 1) Es recomendable, sustituir varias búsquedas sencillas por una compleja que permita buscar por trozos, palabras y fecha de modificación.

2) En el caso de no poder usar campos de la tabla mediante un formulario usar variables locales

3) Antes de usar n índices es mejor usar un único índice con n partes.



velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:



Localizador

Recomendaciones 1) No usar rejillas con totales.

2) El orden aconsejado de los índices del localizador es el siguiente:

1) Trozos. 2) Palabras. 3) Nombre. 4) Código.

3) El ancho del localizador lo determinará la rejilla. Para tablas con muchos campos crear una rejilla específica.


Tubo de ficha

Identificador 1) Contendrá el identificador de la tabla origen y de la tabla destino .


Tubo de lista

Identificador 1) Contendrá el identificador de la tabla origen y de la tabla destino .


Proceso

Recomendaciones - La primera línea de un proceso siempre sera un REM explicando su funcionamiento.- Documentar los procesos utilizando las instrucciones REM.- Marcar el proceso como Privado, siempre que no se desee lanzar desde más de un punto de la aplicación.

Condiciones campos y variables booleanos 1) Para preguntar si estan a 1 se escribe únicamente el campo.

Uso de comandos Se deben rellenar todos los parámetros de los comandos utilizados en proceso.


Función

Recomendaciones 1) La primera línea de una función debería ser un comentario REM explicando su funcionamiento.

2) Documentar los procesos y funcionando utilizando profusamente las instrucciones de comentario REM.


Menú arbolado

Recomendación 1) Poner en cada menú que lo componga dos acciones con punto de inserción. Una al principio y otra al final


Barra de herramientas

Recomendaciones 1) Incluir dos puntos de inserción. Uno al principio y otro al final.



velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:



Carpeta de objetos

Ordenación 1) Cuando existan dentro de una carpeta una organización de subcarpetas para múltiples tablas, dichas carpetas se ordenarán por orden alfabético del nombre de la carpeta.

2) Dentro de la subcarpeta de interfaz los objetos se ordenarán de la siguiente forma:

1) Formularios. 2) Rejillas. 3) Árboles. 4) Casilleros. 5) Blocs de formulario. 6) Viewflows. 7) Informes. 8) Multivistas. 9) Búsquedas. 10) Localizadores. 11) Lupas. 12) Cesta 13) Procesos (generales). 14) Resto de objetos...

3) Dentro de la subcarpeta de menús y acciones los objetos se ordenarán de la siguiente forma:

1) Menús. 2) Toolbars. 3) Acciones.

4) Si hay muchos objetos para una tabla se crearán subcarpetas bien para un determinado tipo de objeto o para agrupar objetos de un determinada funcionalidad. El objetivo es evitar, en la medida de lo posible, que dentro de una carpeta existan más de 20 objetos.

Organización Un mapa tipíco suele contener las carpetas:

- Recursos. - Menús. - Maestros. - Módulos. - plantilla base - etc.

Estas carpetas deben nombrarse y organizarse de tal forma que su agrupación permita copiar todos los objetos visuales específicos de la aplicación sin incluir las carpetas de otras plantillas o módulos integrados en el mismo mapa. En el ejemplo podrá observar una organización típica.


Campos de una tabla

Longitud Campos 1) Teléfono: Alfa256 de 15



velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:


Identificadores 1) Se respetarán los identificadores de los campos ID y NAME, ya que el sistema asume funcionalidades por defecto para dichos campos. Se puede cambiar su descripción.

2) Si no es un campo puntero, se identifica con una o variables palabras o abreviaturas. Estas abreviaturas han de estar en el documento "Diccionario de abreviaturas". 3) Si es un campo puntero se especificará el identificador de la tabla apuntada sea maestra o estática.

4) Si existen varios campos punteros a la misma tabla, se añadira un nº orden o un texto diferenciador.

5) Si es un campo puntero a sí misma, se puede añadir un sufijo que documente el motivo del enlace.

6) Los punteros a hermano contiguo tendrán como sufijo -ANT (Anterior) o -SIG (Siguiente).Descripción 1) La descripción interna de los campos se formara poniendo solo la 1ª letra del campo en

mayúsculas, el resto en minúsculas.

2) Sólo se pueden utilizar mayúsculas para acrónimos y nombres propios.

3) Siempre han de estar escritos ortográficamente correctos.

4) En caso de utilizar abreviaturas tienen que estar registradas en el documento "Diccionario de abreviaturas".

5) En el caso de campos puntero a otra tabla la descripción será, por defecto, el nombre singular de la tabla.

Campos booleanos 1) Su identificador debería hacer referencia al estado activo del campo, de esta forma por defecto se asume que estará inactivo. Por ejemplo, recomendamos poner como booleano "Facturado" en lugar de poner "Pendiente de facturar" ya que en este segundo caso habría que fozar el contenido inicial para que el booleano estuviese activo.

Campos tipo hermano contiguo 1) En el caso, por ejemplo, de hermanos contiguos con índices compuestos, tanto el identificador como la descripción deben hacer referencia a las partes no comunes en la resolución.

Objeto 1) A tener en cuenta que los tipos de campo objeto no ocupan espacio en disco cuando están vacíos, sin embargo, cuando tienen contenido, aunque sea un caracter, ocuparán como mínimo 512 bytes.

Multi empresa 1) El campo puntero a empresa se situará debajo de ID y NAME en caso de tabla maestra.

2) El campo puntero a empresa se situará encima del ID en caso de que la tabla sea submaestra.


Índices

Indices compuestos Su descripción debe componerse de las diferentes descripciones de los campos separados por comas.

Índices condicionados Cuando un índice esté condicionado se debe indicar en la descripción que registros son los que se almacenan en ese índice de forma positiva.

Indices de punteros La identificación de los índices punteros a tablas maestras o estáticas será la misma que recibió el campo en la tabla.

Consejos - Se aconseja el uso del campo de condición para indexar frente a cualquier otro sistema de cruce de listas de listas o filtrado.- Se aconseja que los índices creados manualmente con un campo de tipo alfabético tengan conversión a Alfa40.

Clave única compuesta - El identificador incluirá las partes del índice (hasta un máximo razonable).- La descripción incluirá todas las partes separadas por comas.

Orden - Los índices se pondrán en el mismo orden en que estén el primer campo de las partes del índice.



velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:



Proyectos

Esquemas -Deberemos asignarles un icono que se visualizará en el menú de navegante-Debe existir al menos un esquema general con todas las tablas.-Recomendamos que se hagan esquemas para documentar funcionalidades específicas

Numeración de versiones Recomendamos que el número de versión se componga de la siguiente manera:-Número versión de edición "7.3" + el número de historial. Este número sólo se actualizará cuando se publique la versión

Organización de objetos -Los Objetos se organizarán en carpetas y subcarpetas -Dentro de cada carpeta se ordenarán por tipo de objeto-Dentro de cada tipo de objeto se ordenarán alfabéticamente

Nombre Recomendamos que sea lo más corto posible porque en las propiedades que hacen referencia a objetos se indica "objeto@proyecto"

Configuración -Icono: Recomendamos no utilizar iconos en los proyectos de datos. En los proyectos de aplicación han de utilizarse del tamaño inidicado.-Idioma: Español por defecto.-Paleta: Recomendamos crear una paleta por defecto.

Organización carpetas -Carpeta TABLAS:En los proyectos de datos la organización dentro de una carpeta será: Esquema Tabla dinámica Tabla estática

-Tendremos una carpeta para Variables-Tendremos una carpeta para las Constantes


Actualizaciones

Recomendaciones 1) Rellenar los comentarios en cada componente de actualización.

2) Utilizar actualizaciones antes que eventos de tabla, siempre que sea posible.

3) Crear, si es posible, una actualización por tabla maestra y dentro de dicha actualización tantos componentes de actualización como sean necesarios, evitar crear una actualización por cada componentes de actualización.


Eventos de tabla

Recomendaciones 1) Se aconseja crear un proceso externo al trigger si va a ser llamado por varios eventos.

2) La normalización es similar a la de los procesos.


Variable local

Recomendación Las variables locales por defecto si no lo determina el comando se crean alfabéticas. Por lo que deberemos ajustar el tipo si es necesario.


Constante

Uso 1) Es obligatorio su uso para textos a incluir en fórmulas (mensajes de error, alertas, información, etc). De esta forma se garantiza la posibilidad de que la aplicación sea multi-idioma sin reprogramación del código.



velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:



Esquema

Recomendaciones 1) Los esquemas son la primera herramienta de documentación para que un programador pueda comprender una aplicación y su estructura de base de datos. Es importante invertir tiempo en crear bien los esquemas y añadirles imágenes y textos descriptivos.

Uso 1) Se creará un esquema general en cada proyecto de datos cuyo identificador será el mismo que el del proyecto.

2) Es conveniente crear esquemas específicos que puedan facilitar la comprensión de módulos o áreas concretas del proyecto de datos.


Fichero Adjunto

Recomendación 1) Tener presenta el tamaño del archivo que se adjunte


Acciones

Recomendaciones 1) Recomendamos poner una descripción en los textos de estado, tooltip, ayuda y texto de icono.2) El texto de icono debe ser distinto al de la acción y más sintético3) Recomendamos el uso de icono


Bloc de formularios

Recomendaciones 1) Por defecto, usaremos el mismo que el de mantenimiento.

2) Por defecto, el valor de la propiedad movimiento será cancelar.


Marco

Identificador 1) EI nombre ha de ser AUTOEXEC.

Uso 1) Tiene que haber uno en el proyecto principal de la solución.

2) Definiremos siempre un menú

3) Modo de arranque : Tab

4) Recomedamos un dock para una toolbar

5) Se pueden crear en proyectos que hereden del principal para hacer interfaces personalizados por usuario y utilizar las autorizaciones para que tenga sólo uno visible


Multivista

Identificador 1) El identificador ha de estar compuesto por los identificadores de cada una de las tablas de los componentes del mutivista


Toolbar



velneo.es

de 8

06/05/2010

Objeto


Fecha de informe:


Uso 1) Aconsejamos insertar 2 puntos de insercción. Uno al principio y otro al final


Comunes

Fórmulas 1) Todas las formulas deben llevar un espacio separando los elementos (variables, campos, operadores, incluso parámetros dentro de funciones etc) que lo componen.

2) No se pondrá espacio entre el paréntesis de inicio y el primer parámetro y tampoco entre el último parámetro y el paréntesis de cierre.

3) Si es necesario, se introduciran saltos de linea para separar y estructurar la información, de manera que sea más legible.

Identificador 1) Debe basarse en el libro de abreviaturas y utilizando el guión bajo para separar palabras.

2) Puede contener letras, números y el guión bajo. Cualquier carácter especial será sustituido por le guión bajo.

3) Es recomendable tratar de que el identificador de cualquier objeto o subobjeto sea lo más corto posible, siempre consiguiendo que sea descriptivo del contenido o del uso.

4) Los acrónimos se respetarán. Ejemplo: IBANDescripción 1) Todo objeto y subobjeto ha de tener descripción.

2) Al crear la descripción debe tenerse en cuenta que ha de ser clara y concisa ya que será la que vea el usuario final.

3) La descripción se formara poniendo solo la 1ª letra del campo en mayúsculas, el resto en minúsculas.

4) Solo se pueden utilizar mayúsculas para acrónimos y nombres propios.

5) Siempre han de estar escritos ortográficamente correctos.

6) En caso de utilizar abreviaturas tienen que estar registradas en el documento "Diccionario de abreviaturas".

Comentario 1) Se recomienda su uso para la documentación interna de la aplicación.


Solución

Compartida 1) Por defecto serán compartidas salvo que no vaya a ser heredada por otra solución.

Nombre 1) Recomendamos usar sólo letras y números evitando caracteres especiales.



velneo.es

vestandar: normas por objeto fecha de informe:...

Documents