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.

Instalación

La aplicación está desarrollada en Delphi XE usando Pascal orientado a objetos, la única librería adicional es “ReportBuilder” de https://www.digital-metaphors.com/.

Esta combinación de software se encuentra en mi PC de la oficina que próximamente será trasladada a la sala de servidores.

Las fuentes están instaladas en una carpeta denominada C:\DevelopPrx y no deberían ser movidas a otra carpeta.

 - 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 debería quedar 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.