General functions
Variables
There are two general variables that you can use to identify details about an execution:
executionID: the ID of this scenario executiontriggerTimestamp: The time at which this execution was triggered
get (object or array; path)
Returns the value path of an object or array. To access nested objects, use dot notation. The first item in an array is index 1.
Examples:
get( array ; 1 + 1 )get( array ; 5.raw_name )get( object ; raw_name )get( object ; raw_name.sub_raw_name )
if (expression; value1; value2)
Returns the value1 if the expression is evaluated to true; otherwise it returns the value2.
To create an if statement that returns a value only if two or more expressions are evaluated to true, use the and keyword.
To combine if statements, use the and and or operators.
Examples:
-
if( 1 = 1 ; A ; B )Returns A
-
if( 1 = 2 ; A ; B )Returns B
-
if( 1 = 2 and 1 = 2 ; A ; B )Returns B
ifempty (value1; value2)
Returns the value1 if this value is not empty; otherwise it returns the value2.
Examples:
-
ifempty(A;B)Returns A
-
ifempty(unknown;B)Returns B
-
ifempty("";B)Returns B
switch (expression; value1; result1; [value2; result2; 鈥; [else])
Evaluates one value (called the expression) against a list of values; returns the result corresponding to the first matching value. To include an else value, add it after the final expression or value.
Examples:
-
switch( B ; A ; 1 ; B ; 2 ; C ; 3 )Returns 2
-
switch( C ; A ; 1 ; B ; 2 ; C ; 3 )Returns 3
-
switch( X ; A ; 1 ; B ; 2 ; C ; 3 ; 4 )Returns 4
In this function, 4 is the value to be returned if no expressions apply (the
elsevalue).
omit(object; key1; [key2; 鈥)
Omits the given keys of the object and returns the rest.
Example:
omit( User ; password )
Returns a collection of the user鈥檚 information, excluding the password.
pick(object; key1; [key2; 鈥)
Picks only the given keys from the object.
Example:
pick( User ; password ; email )
Returns a collection of only the user鈥檚 password and email address.
mergeCollections(collection1; collection2)
Merges two collections by combining their key-value pairs. If both collections contain the same key, the value from the second collection overwrites that value from the first collection.