Proyecto de aplicación

Marco, módulos, submódulos y nivel funcional)

Marco

Utiliza la carpeta "Marco".

Contendrá como primer objeto el marco principal "AUTOEXEC".

Contendrá las siguientes subcarpetas:

Arranque

Esta carpeta contendrá los objetos que son ejecutados por el marco AUTOEXEC y el ON_INIT_SERVER en el caso de que exista.

Barra de menú

Está carpeta contendrá subcarpetas con los nombres de las opciones de menú principal de la barra en el mismo orden de aparición en la aplicación. Por ejemplo: Principal, Archivo, Registros, Supervisor, Ayuda, etc. Dentro de cada subcarpeta se incluirá en primer lugar el objeto menú y a continuación las acciones que lo componen. Los objetos de tipo Acción que son lanzados en ese menú, estarán ordenados dentro de la carpeta, debajo del menú y en el mismo orden en el que son utilizados. Este mismo criterio será aplicado en el caso de que existan subniveles.

Menú general

Esta carpeta contendrá los objetos que se usarán para visualizar dicho menú. En el caso de que el menú está incrustado en un dock, aquí situaremos el formulario usado dentro de dicho dock.

Formulario principal

Esta carpeta contendrá el formulario principal que se usa en el marco AUTOEXEC, así como las acciones principales para que pueda ser abierto en el caso de que sea cerrado desde el menú principal.

Módulos

Cada módulo de la aplicación tendrá una carpeta principal: Gestión, Contabilidad, TPV, Maestros, Configuración, etc.

Para los módulos comunes (Gestión, Contabilidad, TPV ) utilizaremos "Carpeta 1".

Para los módulos específicos: Maestros "Objetos 3" y Configuración "Objetos 5".

Submódulos

Dentro de la carpeta de cada módulo se incluirán tantas subcarpetas como submódulos existan, y se pondrán en el mismo orden en el que están incluidos en el menú.

Dentro de cada carpeta de submódulo se incluirán carpetas específicas para cada funcionalidad. Por ejemplo, dentro de la carpeta Ventas, incluiremos subcarpetas para Presupuestos, Pedidos, Albaranes, Facturas, etc.

Nivel funcional

Continuando con el ejemplo de Presupuestos de Venta, contendrá dos carpetas que se llamarán igual una con objetos (utilizando la carpeta "Interfaz") y otra con la carpeta "Acciones y menús"

Adicionalmente incluiremos subcarpetas para tablas plurales, por ejemplo, Líneas de Presupuesto de Ventas, creando así una estructura jerárquica que nos permita copiar todos los objetos de interfaz de las tablas relacionadas con la principal. Estás subcarpetas seguirán los mismos criterios de organización.

Interfaz, acciones y recuros

Interfaz

En esta carpeta organizaremos los objetos en el siguiente orden:

Formularios

El primer formulario será el del alta que normalmente tendrá como identificador el nombre de la tabla asociada. A continuación se situarán todos los subformularios contenidos en separadores de pestañas, pilas o cajas de formularios, etc. Estos subformularios se ubicarán en el mismo orden en que están incluidos en los controles contenedores. Este mismo criterio será aplicado a los puntos de inserción utilizados en los contenedores. Los formularios que sean de tipo Punto de Inserción llevarán el sufijo _INS seguido de un ordinal en el caso de que haya más de uno. Especialmente se utilizará el sufijo _INS_INI y _INS_FIN en el caso de que existan para indicar que ese punto de inserción irá ubicado antes de la primera pestaña o después de la última respectivamente. Si hubiese formularios especiales para bajas o modificaciones, se ubicarán a continuación del último subformulario con el sufijo _BAJ para las bajas y _MOD para las modificaciones.

Alternadores

Por orden alfabético.

Rejillas

Por orden alfabético.

Rejillas avanzadas

Por orden alfabético.

Árboles visores de tablas arboladas

Por orden alfabético.

Blocs de formularios

Por orden alfabético.

Listas QML

Por orden alfabético.

Comboviews

Por orden alfabético.

Listview

Por orden alfabético.

Viewflows

Por orden alfabético.

Informes

Por orden alfabético.

Impresoras lógicas

Por orden alfabético.

Multivistas

Por orden alfabético.

Toolbars

Por orden alfabético.

Búsquedas

Por orden alfabético.

Localizadores

Por orden alfabético.

Cestas

Por orden alfabético.

Procesos

Por orden alfabético.

Funciones

Por orden alfabético.

Subcarpeta con el icono "Objetos 2" y título "Menús de botón ..." que contendrá otras subcarpetas con los menús de botón para cada campo puntero a maestro. Cada menú de botón tendrá un carpeta "Objetos 2" específica con el título de "Menú de botón de maestro" (siendo maestro la descripción del campo apuntado). Dentro de la carpeta se situará como primer objeto el menú y debajo las acciones incluidas en el menú en el mismo orden que tienen en el menú. El menú de botón más estándar contiene en el menú las opciones de Localizar (tecla aceleradora F5), Alta (tecla aceleradora F6) y Editar (tecla aceleradora F7) teniendo como identificador la tabla de origen seguido del campo apuntado donde se situará el menú de botón y como sufijo el asociado a la acción específica, en los ejemplos estándar comentados serían _LOC, _ALT y _MOD.

En el caso de que existan muchos objetos de un determinado tipo, por ejemplo procesos, conviene crear al final de los objetos una subcarpeta en la que organizaremos todos los procesos que tengan una relación funcional.

Acciones y menús

En esta carpeta organizaremos como su nombre indica los objetos de tipo acción, los objetos menú y sus opciones de menú.

Todas las acciones se organizarán por orden alfabético.

En caso de que existan menús, se creará una subcarpeta de tipo "Acciones y menús" dentro de la cual ubicaremos el objeto menú y todas las acciones o procesos que se incluyan en dicho menú en el mismo orden en el que aparecen en el menú.

En el caso de que la carpeta una opción a disparar desde el menú general, se creará una carpeta con el nombre "Menú" de tipo "Acciones y menús" que incluirá los objetos necesarios para la ejecución de dicha opción incluyendo, en el mayoría de los casos, el control de opción ya abierta para que no se vuelva a abrir una nueva pestaña de esa opción si ya existe otra abierta. Un menú estándar utiliza 4 objetos:

El primero es una acción cuyo nombre comienza por MEN_ seguido del nombre de la tabla de origen y termina con el sufijo _TAB. Este sufijo indica que esta acción se encargará de revisar si la opción que se ejecuta ya está abierta y en ese caso no se abre una nueva pestaña central sino que se activa directamente la que ya está abierta. Esta acción ejecuta un proceso con el mismo nombre que la acción.

El segundo objeto es el proceso que se encarga de ejecutar un proceso JavaScript que revisará si esa opción ya ha sido lanzada y en caso afirmativo la activa, en caso contrario el proceso de menú se encarga de ejecutar la acción correspondiente para lanzar la opción del menú

El tercer objeto es la acción que ejecuta el formulario de menú que tendrá el prefijo estándar del nombre de la tabla de origen y el sufijo _MEN.

El cuarto objeto es el formulario de menú que tendrá el mismo identificador que la acción que lo lanza.

Recursos

En esta carpeta, como su nombre indica, se incluirán aquellos objetos de uso general, objetos reutilizables y recursos utilizables en toda la aplicación. Dentro de la carpeta Recursos del tipo "Recursos" se crearán subcarpetas para cada tipo de recurso organizándose por orden alfabético. Habitualmente nos podremos encontrar con subcarpetas de los siguientes recursos:

Constantes

Dentro de la carpeta principal Constantes de tipo "Objeto 10" se suelen incluir subcarpetas del mismo tipo para organizar las constantes en función de su uso: Errores, Mensajes, Preguntas y Textos. Cuando el número de constantes a incluir en una subcarpeta sea muy elevado crearemos subcarpetas, por ejemplo por la primera letra del identificador de la constante o por grupos de letras "De la A a la D", etc. El objetivo de crear este desglose de subcarpetas es conseguir que las constantes incluidas en una carpeta puedan verse en el editor sin tener que realizar desplazamientos verticales. Los constantes dentro de cada carpeta se organizan por orden alfabético.

Dibujos

Dentro de la carpeta de tipo "Dibujos" crearemos diferentes subcarpetas, ordenadas por nombre, para organizar los objetos dibujo de la aplicación. Una organización sencilla de hacer y que ayude a localizar los dibujos puede ser agruparlos por el uso de ellos en la interfaz como por ejemplo (Dibujos de la interfaz, iconos de botones, iconos de menús, iconos de menús contexturales de vistas, etc.). Tanto las subcarpetas como los objetos contenidos en la mismas se organizan por orden alfabético.

Funciones generales

En este carpeta de tipo "Procesos" se incluirán todas las funciones y procesos de uso general en la aplicación. Los objetos se organizan por orden alfabético.

Impresoras lógicas

En esta carpeta de tipo "Informes" incluiremos los objetos de tipo impresora lógica que se usen en informes de la aplicación. Normalmente no hay muchas así que puede ser cómodo incluirlas todas en esta carpeta aunque se usan en módulos concretos, y en el caso de que sean muchas se pueden crear subcarpeta de tipo "Informe" para organizarlas por módulos o tipos de informes. Los objetos se organizan por orden alfabético.

Menús contextuales

En esta carpeta de tipo "Menús" se incluyen subcarpetas del mismo tipo para agrupar los menús que se usarán en modo contexto de los objetos de lista, por ejemplo (Menú contextual de vista y menú contextual de vista (señales), etc.). Dentro de las subcapetas se organizan los objetos poniendo primero los objetos de tipo menú, luego los del tipo toolbar y posteriormente todos los objetos de tipo acción usados en los correspondientes menús o toolbars. El orden de los objetos dentro de cada tipo será alfabético.

Otras

En cualquier aplicación existen otros objetos de uso general que se organizarán por orden alfabético y con el tipo de carpeta que corresponda. En el caso de vERP tenemos carpetas como: Formulario pedir datos (genérico), Importador dinámico, Utilidades y vTools.