Funciones

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Asistente de Procesos > Reglas de Negocio > Elementos de las reglas de negocio > Elemento de expresiones >

Funciones

XPath provee una serie de funciones que ayudan al rendimiento de cálculos a través de las colecciones en una forma fácil e intuitiva.

Las funciones se encuentran en el Editor de funciones de las expressiones.

 

Funciones básicas

 

FUNCIÓN

DESCRIPCIÓN

SINTAXIS

And

Compara dos booleanos que pueden ser XPath o el resultado de una función XPath.  La función devuelve verdadero si las dos condiciones son verdaderas, de lo contrario retorna falso.

<and(XPath,XPath)>

Avg

Obtiene el promedio de los elementos de la colección. El atributo para realizar el cálculo debe ser un numérico o moneda.

<avg(XPath)>

Count

Cuenta el número de elementos de una colección.

<count(XPath)>

Empty

Regresa verdadero cuando una colección no tiene elementos, falso de lo contrario.

<empty(XPath)>

Equals

Compara dos argumentos XPath y regresa true si son equivalentes. Los parámetros pueden ser expresiones XPath o funciones XPath.

<equals(XPath,XPath)>

Exist

Retorna verdadero si la colección tiene al menos un elemento, de lo contrario retorna falso.

<exists(XPath)>

Greater than

Compara dos argumentos XPath y retorna verdadero si el primero es mayor que el segundo, retorna falso de lo contrario. Los parámetros pueden ser expresiones XPath o funciones XPath que retornen enteros, decimales, moneda o fechas.

<greater-than(XPath,XPath)>

Greater than or equals to

Compara dos argumentos XPath y retorna verdadero si el primero es mayor o igual que el segundo, retorna falso de lo contrario. Los parámetros pueden ser expresiones XPath o funciones XPath que retornen enteros, decimales, moneda o fechas.

<greater-equals-than(XPath,XPath)>

Is Empty

Retorna verdadero si el atributo de tipo string es nulo o esta vacío. Retorna falso de lo contrario.

<is-empty(XPath)>

Is False

Evalúa una expresión XPath o el resultado de un función Xpath Retorna verdadero si el parámetro es falso, de lo contario retorna falso.

<is-false(XPath)>

Is not Empty

Retorna verdadero si el atributo de tipo string esta lleno. Retorna falso de lo contrario.

<is-not-empty(XPath)>

Is not Null

Retorna verdadero si algún atributo esta lleno (no es nulo), de lo contrario retorna falso.

<is-not-null(XPath)>

Is Null

Retorna verdadero si un atributo es nulo (no lleno), de lo contrario retorna falso.

<is-null(XPath)>

Is True

Evalúa si el resultado de una expresión XPath o el resultado de una función Xpath. Regresa verdadero si el parámetro es verdadero, falso de lo contrario.

<is-true(XPath)>

Less than

Compara dos argumentos XPath y retorna verdadero si el primero es menor que el segundo, retorna falso de lo contrario. Los parámetros pueden ser expresiones XPath o funciones XPath que retornen enteros, decimales, moneda o fechas.

<less-than(XPath,XPath)>

Less than or equals to

Compara dos argumentos XPath y retorna verdadero si el primero es menor o igual que el segundo, retorna falso de lo contrario. Los parámetros pueden ser expresiones XPath o funciones XPath que retornen enteros, decimales, moneda o fechas.

<less-equals-than(XPath,XPath)>

Like

Compara dos parámetros y retorna verdadero si el segundo esta incluido dentro del primero. Los parámetros pueden ser XPath string o string. Cuando se utiliza un texto fijo utilice las comillas sencillas (').

Si alguno de los parámetros está vacío la función retornará Verdadero.

<like(XPath,XPath)>

Max

Obtiene el valor máximo de una colección de elementos. El atributo deber ser numérico o moneda.

<max(XPath)>

Min

Obtiene el valor mínimo de una colección de elementos. El atributo deber ser numérico o moneda.

<min(XPath)>

Not equals

Compara dos argumentos XPath y regresa verdadero si NO son equivalentes. Los parámetros pueden ser expresiones o funciones XPath.

<not-equals(XPath,XPath)>

Or

Compara dos booleanas que pueden ser una expresión XPath o el resultado de una función XPath. Regresa falso cuando ambos parámetros son falsos, verdadero de lo contrario.

<or(XPath,XPath)>

Sum

Suma el valor de un atributo de una colección. El atributo debe ser numérico o moneda.

<sum(XPath)>

 

 

 

Funciones Avanzadas

 

FUNCIÓN

DESCRIPCIÓN

SINTAXIS

Nuevo item de una colección

Permite la inclusión o creación de un nuevo item (registro) a una colección. El item se incluye inicialmente como una entrada en blanco. Puede asignar una variable para establecer los valores para el nuevo registro.

Me.newCollectionItem("XPath")

 

El XPath debe ser una colección

Asociar item a una colección

Permite asociar UN item (registro) de una colección a otra colección. El artículo no se duplica, es compartido por las dos colecciones.

Ambas colecciones han de pertenecer (relacionarse) con la misma entidad.

Me.attachCollectionItem("XPath", item)

 

El XPath debe ser una colección que recibirá el item.

El  item es el Xpath al registro que se asociará.

Asociar items a una colección

Permite asociar uno o más items (registros) de una colección a otra colección. Los items no están duplicados, son compartidos por ambas colecciones.

Ambas colecciones han de pertenecer (relacionarse) con la misma entidad.

Me.attachCollectionItems("XPath", items)

 

El XPath debe ser una colección que recibirá los items.

Los items son Xpath a los registros que se asociarán.

Desasociar item de una colección

Permite desasociar UN elemento (registro) de una colección. El item ya no serán parte de la colección, pero no van a ser borrado de la base de datos.

Me.detachCollectionItem("XPath", item)

 

El XPath debe ser una colección

El item debe ser un registro de la colección. Si no es UNO solo la función fallará en ejecución.

Desasociar items de una colección

Permite desasociar ALGUNOS (uno o más) items (registros) de una colección. Los items ya no serán parte de la colección, pero no van a ser borrados de la base de datos.

Me.detachAllCollectionItems("XPath")

 

El XPath debe ser una colección

Desasociar todos los items de una colección

Permite desasociar TODOS los items (registros) de una colección. Los items ya no serán parte de la colección, pero no van a ser borrados de la base de datos.

Me.detachAllCollectionItems("XPath")

 

El XPath debe ser una colección que tendrá todos sus items desconectados.

Eliminar un item de una colección

Permite la eliminación completa UNO de los items (registros) de una colección. El elemento se eliminará de la colección y de la base de datos.

Me.deleteCollectionItem("XPath", item)

 

El XPath debe ser una colección

El item debe ser un registro de la colección. Si no es UNO solo la función fallará en ejecución.

Eliminar items de una colección

Permite la eliminación completa de uno o más items (registros) de una colección. Los elementos se eliminarán de la colección y de la base de datos.

Me.deleteCollectionItems("XPath", item)

 

El XPath debe ser una colección.

Los items deben ser uno o más registros de dicha colección

Eliminar todos los items de una colección

Permite la eliminación completa de TODOS los items (registros) de una colección. Los elementos se eliminarán de la colección y de la base de datos.

Me.deleteAllCollectionItems("XPath")

 

El XPath debe ser una colección.

Distinct-values

Retorna una (no una colección) con valores no repetidos de un atributo específico, de una colección. Es necesario indicar el atributo con el cuál se encontrarán los valores no repetidos. La lista con los valores no repetidos serán entradas de este atributo.

<distinct-values(XPath)>

El XPath debe ser una colección que navegue hasta un atributo por el que se pueda hacer un filtro de valores distintos.

Get value as collection

Transforma una lista de valores almacenados en cadenas de texto en un arrayList. En algunos casos es necesario manejar las colecciones utilizando expresiones y no a través de la funcionalidad Iterate over XPath para permitir una completa manipulación del código.

CHelper.GetValueAsCollection(<XPath>)

 

El XPath debe ser una colección

Sort

Ordenar registros de una colección en orden ascendente de acuerdo a un atributo. Solo es posible ordenar utilizando un entero, real, fecha o un atributo string. El método recibe una colección y regresa la colección ordenada de acuerdo a los valores del atributo.

<sort(XPath,'attribute')>;

 

El XPath debe ser una colección

Add relation

DEPRECADO

Permite incluir nuevos registros dentro de la colección. Los registros se incluyen inicialmente como una entrada vacía. Usted puede utilizar XPath o variables para asignar los valores del nuevo registro.

Me.addRelation("XPath")

 

El XPath debe ser una colección

Remove relation

DEPRECADO

Permite borrar elementos de una colección. Es posible especificar si se quiere o no eliminar los registros de la base de datos en el Segundo parámetro.

Me.removeRelation("XPath",remove from database)

Funciones matemáticas

 

FUNCIÓN

DESCRIPCIÓN

SINTAXIS

Abs

Devuelve el valor absoluto de un número (entero, moneda, real, flotante).

Abs(1.5)  -> 1.5

Abs(-1.5) -> 1.5

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Abs(Number)

Average

Obtiene el promedio (media aritmética) de un conjunto de números (entero, moneda, real, flotante).

Los parámetros pueden ser Xpaths, variables o números y deben estar contenidos entre braquets []

CHelper.Math.Average([Number1,Number2,....])

Ceiling

Redondea un número (entero, moneda, real, flotante) hacia arriba al entero más cercano.

Ceiling(1.2) -> 2

Ceiling(1.9) -> 2

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Ceiling(Number)

Exp

Devuelve e (la base de logaritmos naturales) elevado a la potencia dada.

El parámetro puede ser Xpath, variable o número.

EL RESULTADO DE ESTA FUNCIÓN DEBE SER GUARDADO EN UN ATRIBUTO TIPO FLOAT.

CHelper.Math.Exp(Number)

Floor

Redondea un número (entero, moneda, real, flotante) hacia abajo al entero más cercano.

Floor(1.2) -> 1

Floor(1.9)-> 1

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Floor(Number)

IsNaN

Esta función evalúa si un parámetro no es un número:

Devuelve verdadero si el parámetro no es un número.

Devuelve falso si el parámetro es un número.

El parámetro puede ser XPath, variable o número.

CHelper.Math.IsNaN(Parameter)

Ln

Devuelve el logaritmo natural de un número (entero, moneda, real, flotante).

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Ln(Number)

Log10

Devuelve el logaritmo de base 10 de un número (entero, moneda, real, flotante).

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Log10(Number)

Max

Devuelve el mayor valor entre de un conjunto de números (entero, moneda, real, flotante).

Los parámetros pueden ser Xpaths, variables o números y deben estar contenidos entre braquets []

CHelper.Math.Max([Number1,Number2...])

Min

Devuelve el menor valor entre de un conjunto de números (entero, moneda, real, flotante).

Los parámetros pueden ser Xpaths, variables o números y deben estar contenidos entre braquets [].

CHelper.Math.Min([Number1,Number2...])

Module

Devuelve el residuo de una división.

Mod(8,3) -> 2

Mod(10,2) -> 0

Los parámetros pueden ser Xpaths, variables o números.

Solo recibe parámetros enteros.

CHelper.Math.Module(Number,Divisor)

Percentage

Devuelve el equivalente en porcentage de un número( entero, moneda, real, flotante).

Percentage(100) -> 1

Percentage( 75)  -> 0.75

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Percentage(Number)

Pow

Obtiene el resultado de número elevado a una potencia (entero, moneda, real, flotante).

Los parámetros pueden ser Xpaths, variables o números.

CHelper.Math.Pow(Base,Power)

Quotient

Devuelve la porción entera de una división.

Quotient(100,3)-> 33

Quotient(5,2)-> 2

Los parámetros pueden ser Xpaths, variables o números.

Solo recibe parámetros enteros.

CHelper.Math.Quotient(Number,Divisor)

Rand(to,from)

Devuelve un número aleatorio entero entre dos números.

Los parámetros pueden ser Xpaths, variables o números.

Solo recibe parámetros enteros.

CHelper.Math.Rand(ValueFrom,ValueTo)

Rand()

 

Devuelve un número aleatorio decimal entre 0.0 y 1.0. No tiene parámetros.

CHelper.Math.Rand()

Round

Reduce un número dado (entero, moneda, real, flotante) a un número específico de decimales (entero).

Round (1.247,2) -> 1.25

Round (1.534,1) -> 1.5

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Round(Number,DecimalPlaces)

Sqrt

Obtiene la raíz cuadrada de un número (entero, moneda, real, flotante).

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Sqrt(Number)

Truncate

Trunca un número (entero, moneda, real, flotante) a un entero al remover su parte decimal o fraccional.

Truncate(35.5) -> 35

Truncate(35.89) -> 35

El parámetro puede ser Xpath, variable o número.

CHelper.Math.Truncate(Number)