INTRODUCCIÓN

Esta categoría refiere al software desarrollado usando Delphi. Como se mencionó previamente la aplicación actúa mayormente como un navegador mostrando pantallas, consultas y opciones que están definidas en la base de datos.

No sabe nada acerca de qué está mostrando, pero sí sabe cómo mostrarlo y qué hacer cuando debe accionar sobre objetos del catálogo. Por ejemplo: los auxiliares.

No obstante, incluye alguna funcionalidad específicamente relacionada con algunos objetos del sistema ya que en el momento del desarrollo era más rápido programarlo en Delphi que definirlo en el catálogo. Habitualmente trabajamos contra reloj. Esa funcionalidad se asocia al grupo “IMPLEMENTED” de los descriptos más abajo.

Es muy poco frecuente que se toque el código de Delphi, y cuando se hace es habitualmente para ajustes muy sencillos.

ASPECTOS BÁSICOS DE DELPHI

Instalación específica a Pragma

• Instalación de Delphi describe algunos aspectos básicos de la instalación específica de Delphi para Pragma.

Configuraciones importantes

• Configuraciones importantes de Delphi describe algunas configuraciones referidas a la instalación de Delphi para Pragma.

Ayuda en línea sobre Delphi

Para acceder a ayuda en línea sobre Delphi se puede consultar Documentación online de Delphi.

Aclaro que la ayuda de Delphi XE ya no está disponible en ese sitio, pero sí de versiones posteriores.

Introducción al desarrollo en Delphi

• En Introducción al desarrollo en Delphi hay una breve documentación sobre el desarrollo en Delphi usando Object Pascal.

 - IR AL LINK PORQUE HAY QUE AGREGAR ALGO SOBRE COMPONENTCOUNT...

DOCUMENTACIÓN DE PRAGMA

DATASETS

Los datasets en Delphi son los componentes que se conectan a una base de datos, y a los objetos que éstas contienen tales como tablas, procedimientos y demás. Pragma deriva de estos componentes agregando funcionalidad específica.

Delphi incluye una variedad de componentes de conexión a datos, los elegidos para Pragma son aquellos que se conectan a través de ADO que es un conjunto de clases que proporcionan servicios de acceso a datos. Por ejemplo, desde Pragma a un servidor SQL SERVER.

Conexión a la base de datos

Esta sección incluye componentes que, si bien no son datasets, tienen que ver con la conexión a la base de datos.

• Conexión a la base de datos describe estos componentes.

Queries

Los queries (que literalmente se traducen como consultas) son componentes que pueden usarse para ejecutar sentencias de SQL, normalmente de lectura, pero también de ejecución. Derivan de un componente de Delphi denominado TADOQuery y agregan funcionalidad propia. Se usan habitualmente para consultar datos o aplicar sentencias SQL a la base de datos, pero no se usan con controles de edición de datos de tablas.

• La categoría Queries describe a los queries.

Datasets

Los Datasets normalmente representan datos (de una base de datos, u otro origen como Excel) en forma de filas (llamadas registros) y columnas (llamadas campos). Introducen la funcionalidad básica para trabajar con esta información facilitando la edición de esos datos. No se usan para hacer consultas.

Los TADODatasets derivan de los Datasets y conectan con los orígenes de datos exclusivamente a través de una conexión ADO.

• La categoría Datasets describe a los datasets.

Datasets implementados

Los datasets implementados derivan de alguno de los datasets ya mencionados e implementan funcionalidad específica a alguna de las tablas del sistema.

Por ejemplo, el dataset implementado denominado Cabecera de factura de ventas FVCAB (TFVCAB_implemented) implementa funcionalidad específica a la tabla Facturación a clientes (FVCAB). Cuando la aplicación recibe la instrucción de abrir una ventana primero debe crear el dataset que conectará a la base de datos, y antes de abrir uno de los datasets mencionados verifica si existe un dataset que tenga el mismo nombre de la tabla (más el prefijo T) y el sufijo _implemented. Si existe lo usa, sino usa el dataset genérico.

Estos datasets implementados han resultado prácticos para incorporar funcionalidad específica que excede las posibilidades de las herramientas específicas.

• La categoría Datasets implementados describe a los datasets implementados.

 - Hay que agregar TprxADOClientDM en alguna parte de los datasets.

CONTROLES

Los controles en Delphi son componentes que tienen una representación visual y permiten la interacción del usuario con la aplicación.

TWinControl es el componente que define la funcionalidad de casi todos los controles visuales.

Los controles pueden recibir el foco, es decir que podemos posicionar el cursor sobre ellos (por ejemplo: picar una pantalla para traerla al frente), y el control con el foco recibe eventos del teclado y del mouse.

Algunos controles cambian de aspecto cuando reciben el foco, por ejemplo: los botones dibujan una caja en el contorno cuando reciben el foco.

Un control puede ser contenedor para otros controles, los que se refiere como 'hijos'. Esta relación se define usando la propiedad Parent del control que indica sobre qué control se ubica el analizado.

Ayuda de Delphi sobre TWinControl.

Controles de edición

Los controles de edición son aquellos que pueden recibirla interacción directa de un usuario, por ejemplo: ingresando un texto en una caja de edición.

• La categoría Controles describe los controles más usados.

 - Habría que describir prxcamposJER_RUNTIME_VISTA para mostrar cómo se define el control que usamos para cada campo de una clase.

Forms

Los forms permiten definir conjuntos visuales de controles (cajas de edición, botones, etc.) que se muestran al usuario como una pantalla.

• La categoría Forms describe los forms más usados.

Ayuda de Delphi sobre forms.

Frames

Los frames permiten definir los mismos conjuntos visuales de controles (cajas de edición, botones, etc.) que los forms, pero se muestran al usuario dentro de una pantalla. Bajo determinadas circunstancias es más conveniente definir frames que definir forms. Esto se argumenta más adelante.

• La categoría Frames describe los frames más usados.

Ayuda de Delphi sobre frames.

******* HASTA AQUÍ LLEGAMOS, LO QUE SIGUE ES MACHETE PARA USAR COMO GUÍA *******

 - Desde aquí para abajo es un machete para armar la documentación.
 - Está copiado de la propuesta y cronograma de documentación.
 - La documentación real es la que está arriba de este mensaje.

ANEXO “MANUAL DEL PROGRAMADOR” PROPUESTA

Componentes

El sistema está compuesto de clases, muchas de éstas extienden funcionalidad de Delphi para hacer su uso más sencillo, y otras son propias.

Hay clases que están deprecadas y deberían ser retiradas del código. Mi intención es hacerlo durante el proceso de la documentación.

Grupos de funcionalidad

A los efectos de este documento agrupé las clases de Delphi en grupos funcionales, todas refieren a clases de Delphi.

• OBJETOS/CATALOGO: clases relacionadas con los catálogos.
• OBJETOS/CLASES: clases relacionadas con las clases del catálogo.
• OBJETOS/ENUMERACIONES: clases relacionadas con las enumeraciones del catálogo.
• OBJETOS/CONSULTAS: clases relacionadas con las consultas del catálogo.
• OBJETOS/VISTAS: clases relacionadas con las vistas del catálogo.
• OBJETOS/FUNCIONES: clases relacionadas con las funciones del catálogo.
• OBJETOS/PROCEDIMIENTOS: clases relacionadas con los procedimientos del catálogo.
• OBJETOS/FRAMES: clases relacionadas con los frames del catálogo.
• OBJETOS/SCRIPTS: clases relacionadas con los scripts del catálogo.
• OBJETOS/AUXILIARES: clases relacionadas con los auxiliares del catálogo.
• OBJETOS/REFRESCO: clases relacionadas con el refresco de catálogos (cada vez que hacemos un cambio en el catálogo se ejecuta un refresco).
• EXPLORADOR: clases relacionadas con el form explorador de Pragma.
• MENU OPCIONES: clases relacionadas con el menú de opciones de las pantallas.
• FORMS: clases relacionadas con forms (pantallas) en general.
• DATASETS: clases relacionadas con el acceso a datos de la base de datos.
• EDICION/FORMS: forms (pantallas) de edición.
• EDICION/FRAMES: frames (una especie de pantalla, o porción, que se aloja en una pantalla) de edición.
• EDICION/CAMPOS: manejo de los campos durante la edición.
• EDICION/CONTROLES: controles de edición.
• IMPRESIÓN: clases relacionadas con la impresión.
• FILTROS: clases relacionadas con las opciones de filtrado de las pantallas.
• INTERFAZ DE USUARIO: otras clases relacionadas con la interfaz de usuario.
• MENU: clases relacionadas con los menús de usuario
• COMPROBANTES: clases relacionadas con el manejo genérico de comprobantes.
• IMPLEMENTED: clases relacionadas con funcionalidad específica de objetos del catálogo.
• REPLICACION: clases relacionadas con la replicación de datos.
• PROYECCION FINANCIERA: clases relacionadas con la planificación financiera.
• GRILLAS: clases relacionadas con las grillas de datos.

Casos de uso

La documentación incluirá “casos de uso” que recorre el uso de clases de Delphi para completar la tarea, Algunos casos son:

• Inicio de la aplicación hasta llegar al menú de usuario, analizar opciones del menú.
• Apertura de una consulta, ingreso de criterios y visualización del resultado, opciones de menú.
• Apertura de una pantalla de datos, aplicar criterios de filtrado, opciones de menú.
• Edición de una pantalla de datos, proceso de validación de los campos, grabado final.
• Eliminación de un registro.

ANEXO “MANUAL DEL PROGRAMADOR” CRONOGRAMA

Estoy previendo 2 meses (40 días) para el manual del programador. Creo que la estrategia más útil será la de desarrollar los “casos de uso” mencionados en la propuesta de la documentación, y siguiendo esos casos, documentar los objetos que Pragma usa.

La documentación no enseña a programar en Pascal orientado a objetos ni enseña a usar Delphi. Solo la programación de Pragma en esa herramienta.

Casos de uso: 30 días

Los casos de uso previstos, que recorren casi toda la funcionalidad de Pragma, son en principio:

• Inicio de la aplicación hasta llegar al menú de usuario, analizar opciones del menú.
• Apertura de una consulta, ingreso de criterios y visualización del resultado, opciones de menú.
• Apertura de una pantalla de datos, aplicar criterios de filtrado, opciones de menú.
• Edición de una pantalla de datos, proceso de validación de los campos, grabado final.
• Grabado de datos, transacciones.
• Eliminación de un registro.

Objetos implementados en Delphi y otros componentes: 10 días

Estos componentes agregan a los documentados en “Casos de uso”. Algunos son:

• Funcionalidad de objetos del catálogo implementados en Delphi (ej.: proyección financiera).
• Repaso de grillas y controles de edición.
• Repaso de Datasets.