Asistente de fórmulas

Ekon fórmula es un conjunto de herramientas de programación y de usuario para evaluar, editar y gestionar fórmulas. Una fórmula es una expresión a partir de la que se obtiene un resultado. Las fórmulas son la base de aplicaciones como las hojas de cálculo, pero su uso se puede extender a muchas otras.

La API fórmula permite evaluar dinámicamente fórmulas en tiempo de ejecución. Las fórmulas se escriben en una sintaxis muy similar a Java estándar. Su sintaxis admite expresiones matemáticas básicas e incorpora toda la potencia del lenguaje Java. En una fórmula puede usar cualquiera de las estructuras de control de flujo de Java (if, for, etc.), declarar variables locales, e instanciar y usar clases de bibliotecas externas.

La API permite definir un contexto de fórmula. El contexto es un conjunto de datos que acompañan la fórmula durante su ejecución. El uso más común del contexto es la definición de variables con sus respectivos valores. Al evaluar una fórmula, ésta podrá acceder al valor de las variables. El contexto se puede configurar dinámicamente para permitir que cada aplicación pueda definir su propio conjunto de variables.

El entorno Ekon fórmula dispone de una serie de funciones predefinidas de uso general. A través del contexto también puede añadir dinámicamente nuevas funciones que la fórmula podrá utilizar durante su ejecución. Con este mecanismo cada aplicación puede publicar su propia colección de funciones ajustable a sus necesidades concretas.

Algunos ejemplos sencillos de fórmulas:

• Fórmula muy básica: 2+3
• Fórmula que multiplica por 2 la variable de contexto: @A * 2
• Fórmula que usa una de las funciones predefinidas: WeekDay(@B)
• Fórmula que hace uso de instrucciones de control de flujo: if (@A == 1) { return 1; } else {return 2;}.

La biblioteca de Ekon fórmula dispone de un editor gráfico de fórmulas, que se puede se configurar totalmente por la aplicación.

Las fórmulas se escriben en una sintaxis similar a Java estándar. Las diferencias entre la sintaxis de una fórmula y la sintaxis de Java son las siguientes:

• Una fórmula no puede contener declaraciones de clases ni métodos.
• Puede contener declaraciones de variables locales, instrucciones de control de flujo y, en general, cualquier código Java válido, a excepción del caso del punto anterior.
• Result es una palabra clave reservada en sintaxis de una fórmula. Debe asignar el resultado de la fórmula a esta variable. Por ejemplo, result = 3;.
• Si la fórmula consta sólo de una línea, no es necesario asignar la variable result ni escribir el punto y coma final. Por ejemplo, 2 + 3 es equivalente a result = 2 + 3;. Puede utilizar indistintamente cualquiera de las dos fórmulas.
• La variable result es de tipo Object en Java, es decir, la fórmula puede devolver como resultado cualquier tipo de objeto, ya sea numérico o cualquier otro.
• Para hacer referencia a una variable de contexto, es necesario utilizar el carácter especial @ como prefijo a la variable. Por ejemplo, result = @A + @B; donde A y B son variables de contexto.
• Para modificar el contenido de las variables del contexto, se emplea la instrucción set seguida de la variable con @. Por ejemplo, set @A = 2.
• Se admiten sentencias del tipo import ; para enlazar con clases externas.

Editor de fórmulas

La biblioteca de Ekon fórmula dispone de un editor gráfico de fórmulas. Las propiedades de una fórmula son las siguientes:

• Nombre. El identificador o nombre de la fórmula.
• Tipo retorno. El tipo de dato de retorno de la fórmula. Puede ser un número entero, número con decimales, texto, moneda o fecha.
• Fórmula. Código fuente en Java de la fórmula.

El editor de la fórmula dispone de los siguientes accesos directos y acciones:

• Aceleradores de edición deshacer (Ctrl+Z), rehacer (Ctrl+Y) y seleccionar todo (Ctrl+A).
• Aceleradores de edición cortar (Ctrl+X), copiar (Ctrl+C ) y pegar (Ctrl+V).
• Asistente de contenidos con búsqueda (Ctrl + Barra espaciadora). Se muestra un mensaje de ayuda sobre los elementos clave del código de la fórmula.
• Aumentar o disminuir el zoom del texto (Ctrl + Rueda del ratón -desplazamiento-).

El editor de la fórmula permite las siguientes acciones:

• Validar. Validar la corrección de la fórmula.
• Probar. Probar la ejecución de la fórmula.

Además dispone de una potente herramienta de búsqueda por la ayuda jerarquizada.

Mejoras en la usabilidad

• Se mejora la usabilidad del Editor de fórmulas y el Catálogo de fórmulas para facilitar su compresión y su uso.
• Se mejora el Treeview de ayuda:
  • La caja de búsqueda está encima del Treeview de ayuda, y dispone de semántica de selección; para agilizar la búsqueda.
  • El Treeview de ayuda es redimensionable.
  • En los nodos se muestran iconos que indican el tipo de datos. Para simplificar se indican Numérico, Texto o Fecha.
  • Desde el nodo principal de la ayuda, nodo Ayuda, se dispone de la nueva acción Cambiar la vista; la cual permite personalizar la vista de los nodos de las variables y las fórmulas. Por ejemplo, puede visualizar @xcustomer_id, o bien Cliente ( @xcustomer_id ), o bien Código de cliente que realiza el pedido ( @xcustomer_id ).
  • Se añaden los operadores de comparación, comparteTo y contains.
• Se mejora la ayuda de las funciones de sistema; todo más claro y con ejemplos.
• Desde el diálogo de Ayuda para funciones, al incrustar un snippet, se puede indicar un tipo de dato de retorno, por lo que al aceptar, se añade automáticamente la función de conversión en caso de ser necesaria.
• Se mejoran los mensajes de error que pueden darse al validar la fórmula para hacerlos más comprensibles.

Catálogo de fórmulas

El catálogo de fórmulas es otra herramienta de la biblioteca que le permite crear su propia colección de fórmulas de uso generalizado, que posteriormente podrá incorporar dentro de otras fórmulas. Puede acceder al catálogo de fórmulas después de seleccionar Sistema / Herramientas de usuario, en el punto Catálogo de fórmulas.

Cada fórmula tiene un nombre único o identificador, que no se puede repetir en otro contexto ni producto. Junto al identificador se almacena el propio código fuente de la fórmula, y otra información adicional como la descripción, los parámetros y el tipo de retorno.

El catálogo está organizado con la siguiente estructura jerárquica: producto, contextos y fórmulas.

El contexto General es un contexto genérico siempre disponible, y en el que puede añadir sus fórmulas. El uso de otros contextos está ligado a usos específicos en el ámbito de una aplicación. En este caso, la propia aplicación provee el contexto adecuado para poder agregar en él sus fórmulas.

Funciones básicas

Después de seleccionar el producto y el contexto en el que desea crear la fórmula (puede seleccionar uno existente o crear un nuevo, situándose sobre Repositorio, mediante el botón secundario del ratón), puede crear una nueva fórmula, situándose sobre éste, mediante el botón secundario del ratón.

Puede indicar el nombre y la descripción de la fórmula, seleccionar el tipo de retorno, los tipos de parámetros, la ayuda de los parámetros y el código fuente de la fórmula.