Cómo funciona el motor de fórmulas

Conceptos básicos

El motor de fórmulas es una herramienta incrustada en ciertas aplicaciones. Permite al usuario escribir una fórmula a partir de datos proporcionados por la aplicación. Luego esta utiliza su resultado para realizar procesos. Las fórmulas permiten un alto grado de personalización de los procesos de la aplicación.

Fórmula es un conjunto de herramientas de programación y 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 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 fórmula dispone de un editor gráfico de fórmulas, que se puede se configurar totalmente por la aplicación.

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 seleccionando el punto Sistema | Herramientas de usuario, en el punto Catálogo de fórmulas.

Funciones básicas

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.

Cómo funciona el catálogo de fórmulas

Conceptos básicos

El catálogo de fórmulas es una biblioteca pública de fórmulas gestionada por UI. Le permite crear su propia colección de fórmulas, para utilizarlas posteriormente en otras 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.

Para acceder a la herramienta, desde Sistema y Herramientas de usuario; en Catálogo de 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.

Funciones avanzadas

Para usar una fórmula del catálogo dentro de otra fórmula, esté catalogada o no, basta con escribir el nombre de la fórmula con el prefijo "@" y el sufijo "()". Su uso es muy parecido a las funciones predefinidas del sistema añadiendo la arroba como prefijo.

Por ejemplo, una fórmula que usa una hipotética fórmula catalogada de nombre "pi": "@pi()".

Al definir la fórmula es importante especificar el tipo de retorno en la casilla Retorno, con las opciones siguientes: Número entero, Número con decimales, Texto, Moneda, o bien Fecha.

Es posible definir una fórmula que admita parámetros. Para ello es necesario indicar los campos Parámetros yAyuda parámetros con los siguientes valores:

• Parámetros. Indique los tipos de los parámetros separados por coma. Los tipos se indican con los literales int, double, string, currency o date, dependiendo de cuál sea su tipo de datos.
• Ayuda parámetros. Indique la ayuda (multiidioma) de cada uno de los parámetros, con el formato "Nombre parámetro 1=Descripción1,Nombre parámetro 2=Descripción2,...".

Los parámetros son anónimos, no tienen nombre. Para acceder a los parámetros desde el interior de la fórmula se deben usar las variables especiales pN, donde N es el ordinal del parámetro definido: 1 para el primero, 2 para el segundo, etc.

Por ejemplo, se define la función suma(), que acepta dos parámetros de tipo entero. La fórmula retorna la suma de ambos valores.

• Fórmula. Suma
• Descripción. Suma de dos valores enteros
• Retorno. Número entero
• Parámetros. int,int
• Ayuda parámetros. Número1=Primer sumando,Número2=Segundo sumando
• Fórmula. p1+p2

Desde otra fórmula suma(), se usa de la siguiente manera: "@suma(2, 3)".

Cada una de las fórmulas del catálogo están sujetas a los mecanismos de seguridad estándar. Esto permite asignar permisos de lectura, modificación, ejecución o eliminación para cada usuario individual.