Generic Functions in QPR ProcessAnalyzer

Generic Properties and Functions are available for all objects.

Generic Properties

Property	Description
_	Refers to the current context.
_empty	Returns an object which represent a non-existent value. Textual representation of this value is "EMPTY".
_remove	Returns an object which represent a value that should automatically be recursively pruned out of the resulting hierarchy object when processing chained expressions. If all the child values of one context object used in chaining expressions return this object, the root object itself will also be pruned out of the resulting hierarchy object. Examples: Both: [1,2]._remove [1,2].Where(_==3, _remove) Return EMPTY whereas [1,2].Where(_==3, _empty) [1,2].Where(_==3) [1,2]._empty Returns an empty collection (collection of length 0). For("i", 0, i < 10, i + 1, i).Where(_ % 2 == 0) For("i", 0, i < 10, i + 1, i).If(_ % 2 == 0, _, _remove) Both return: [0, 2, 4, 6, 8]
CalcId (string)	Returns an id that is unique between all QPR ProcessAnalyzer objects. CalcId is remains the same at least for the duration of the expression calculation. It is possible that CalcId for an object is different in the next calculation. CalcId is EMPTY for other than QPR ProcessAnalyzer objects.
Models (Model*)	All Model objects in the QPR ProcessAnalyzer server (that the user have rights).
Now (DateTime)	DateTime object representing the current date and time.
Null	Returns a special null value. Null value is similar to EMPTY value, except null values can also be recursed. In some cases null values can be converted into numbers in which case they act as 0.
Projects (Project*)	All Projects in the QPR ProcessAnalyzer server (that the user have rights).

Aggregation Functions

Aggregation functions are performed by default to the leaf level (the deepest level). Aggregation means that leaf level arrays are replaced by the aggregated values, and thus the depth of the hierarchy decreases by one. There are following aggregation functions available: Average, Count, Min, Max and Sum.

Examples:

Count([[1, 2], [3, 4, 5]])
Returns: [2, 3]

Sum([[1, 2], [3, 4, 5]])
Returns: [3, 12]

In addition to the aggregation functions, functions that modify the contents of leaf arrays (OrderBy, Distinct, ...), the operation will be performed separately for every leaf array.

OrderByValue([[4, 3], [2, 1]])
Returns: [[3, 4], [1, 2]]

Mathematical functions

Function	Parameters	Description
Ceiling (Integer)	Number (Float)	Returns the smallest integer greater than or equal to the specified number.
Floor (Integer)	Number (Float)	Returns the largest integer less than or equal to the specified number.
Round (Float)	Number to be rounded (Float) Number of decimals (Integer)	Rounds a value to the nearest integer or to the specified number of fractional digits.

Ordering functions

Function	Parameters	Description
OrderBy (array)	Array to order Order expression	Orders the given array using values from the given order expression. The order expression is evaluated once for each item in the array. The order expression supports all atomic (=not collection) primitive value types. Examples: OrderBy(["a", "x", "b", "z", "n", "l", "a"], _) Return: ["a", "a", "b", "l", "n", "x", "z"] OrderBy([9,8,7,6,5,4,3,2,1], _%3) Returns: [9,6,3,7,4,1,8,5,2] OrderBy([9,8,7,6,5,4,3,2,1], _%3 + _/30) Returns: [3,6,9,1,4,7,2,5,8]
OrderByDescending (array)	Array to order Order expression	Result is same as in the OrderBy function, except the order is reverse.
OrderByValue (array)	Array to order	Orders the given array using the natural order of items, for example numbers it's the increasing order, and for strings it's text ordering. OrderByValue(["a", "x", "b", "z", "n", "l", "a"]) Return: ["a", "a", "b", "l", "n", "x", "z"]
OrderByValueDescending (array)	Array to order	Result is same as in the OrderByValue function, except the order is reverse.

Recursion functions

Function	Parameters	Description
Recurse	Expression to call recursively Stop condition expression Maximum depth (Integer)	Evaluates the given expression recursively until given condition or recursion depth is met. The function returns all the traversed objects in a single array. When the stop condition expression evaluates to false, it will stop the current recursion without including the false evaluated object into the result. Default stop condition is !IsNull(_). The default maximum depth is 1000. Examples: (1).Recurse(_ + 1, _ < 5) Returns: [1, 2, 3, 4] event.Recurse(NextInCase) Returns: An array of all the events following given event inside the same case. event.Recurse(NextInCase, Type.Name != "Invoice") Returns: An array of all the events following given event inside the same case until event whose type name is "Invoice", which will itself not be included into the result. event.Recurse(NextInCase, Type.Name != "Invoice", 2) Returns: An array of all the events following given event inside the same case until event whose type name is "Invoice" or until the recursion depth of 2 has been reached, which will itself not be included into the result.
RecurseWithHierarchy	Expression to call recursively Stop condition expression Maximum depth (Integer)	Evaluates the given expression recursively until given condition or recursion depth is met. The function returns the traversed object hierarchy. When the stop condition expression evaluates to false, it will stop the current recursion without including the false evaluated object into the result. Default stop condition is !IsNull(_). The default maximum depth is 1000. Examples: [1,2].RecurseWithHierarchy([1,2], false, 2) Returns: [1:[1:[1,2],2:[1,2]],2:[1:[1,2], 2:[1,2]]] (1).RecurseWithHierarchy(_ + 1, _ < 5) Returns: 1:[2:[3:[4]]] RemoveLeaves(eventLog.Flows:From.Where(IsNull(_))).To.RecurseWithHierarchy(OutgoingFlows.To, !IsNull(_), 2) Returns: A hierarchy consisting of all the starter events of given event log and recursively all the event types reachable from them via flows until depth of 2 is reached.
RecursiveFind	Expression to call recursively Find condition expression Stop condition expression Maximum depth (Integer) Continue after finding (Boolean)	Evaluates given expression recursively until given condition or recursion depth is met. The function collects all the traversed objects that match the given find expression along the way. When the find condition expression evaluates to true for the current object, it causes the following: Current object is added to the result array returned by the function call If continue after finding is false, the recursion will not be continued on this branch When the stop condition expression evaluates to false, it will stop the current recursion without including the false evaluated object into the result. Default stop condition is !IsNull(_). The default maximum depth is 1000. Continue after finding tells should the recursion be continued after a match has been found in the current branch. Examples: (1).RecursiveFind(_ + 1, _ == 100) Returns: 100 eventLog.Cases:GetAt(0, Events).RecursiveFind(NextInCase, Organization=="Finance", !IsNull(_)) Returns: For each case, returns the first (by time) event whose organization equals to "Finance". eventLog.Cases:Events.Where(Organization=="Finance") eventLog.Cases:GetAt(0, Events).RecursiveFind(NextInCase, Organization=="Finance", true, true) Returns: Both return for each case all events whose organization equals to "Finance".

Loop functions

Function	Parameters	Description
For	Iterated variable name (String) Initial value for iterated property (object) Iteration condition expression Next iteration step expression Expression to calculate iterated items	Iterates the given expression until the given condition is met, and returns the results of the iterated expressions for every iteration as an array. Examples: For("i", 0, i < 4, i + 1, i) Returns: [0, 1, 2, 3] For("x", 0, x < 3, x + 1, For("y", 0, y < 3, y + 1, StringJoin(",", [x, y])) Returns: [["0,0", "0,1", "0,2"], ["1,0", "1,1", "1,2"], ["2,0", "2,1", "2,2"]] For("i", 0, i < 4, i + 1, DateTime(2010 + i)) Returns: [DateTime(2010), DateTime(2011), DateTime(2012), DateTime(2013)] For("str", "a", str != "aaaaa", str + "a", str) Returns: ["a", "aa", "aaa", "aaaa"]
ForEach	Variable to repeat (String) Array to repeat Expression to calculate repeated items	Repeats the given expression as many times there are items in the given array. Item in the array is available as the given variable in the expression. Examples: ForEach("i", [1,2,3], "Value is: " + i) Returns: Value is: 1 Value is: 2 Value is: 3 ForEach("myVariable", ["a", "b", "c"], myVariable + myVariable) Returns: aa bb cc
NumberRange	Start (Number) End (Number) Interval (Number)	Creates an array of numbers within given range with the given interval. Interval parameter is optional, and by default it is one. Examples: NumberRange(1, 3) Returns: [1, 2, 3] NumberRange(1, 3, 0.5) Returns: [1, 1.5, 2, 2.5, 3] NumberRange(1, 3, 0.8) Returns: [1, 1.8, 2.6]
Repeat	Number of times to repeat (Integer) Expression to repeat	Repeats the defined expression the defined number of times. Examples: Repeat(3, "Repeat me!") Returns: "Repeat me!" "Repeat me!" "Repeat me!" Repeat(1, 5) Returns 5
TimeRange	Start (DateTime) End (DateTime) Interval (Timespan)	Generates a timestamp array starting from the start timestamp with the defined interval, and ending when the end timestamp is reached. Note that this function only creates timestamps with equal durations, so it's not possible to e.g. create timestamps for each month (to do that, you can use the loops). Generate datetimes starting from Monday 2017-01-01 and ending to Monday 2017-12-31 including all Mondays between them: Timerange(Datetime(2018,1,1), Datetime(2018,1,1), Timespan(7))

Array handling functions

Function	Parameters	Description
Array	Item 1 (Object) Item 2 (Object) ...	Creates a new array where the provided parameters are items of the array. There can be any number of parameters. Note: arrays can also be created using [] syntax. Examples: Array(1, 2, 3) Returns: An array having three elements which are 1, 2 and 3. Also following syntax can be used: [1, 2, 3] Array() Returns: An empty array.
GetAt	Index (Integer) Array	Returns element at given index from the beginning of the array. The first item has index zero. If given a hierarchical object, returns the element at given index of the root level array. Throws a calculation exception if the given index does not exist in given object or given object is not an array. Examples: GetAt(0, [1,2,3]) Returns: 1 GetAt(1, [[1, 2], [3, 4]]) Returns: [3, 4] GetAt(1, [[[5, 6]], [[1, 2], [3, 4]]]) Returns: [[1, 2], [3, 4]] GetAt(1, GetAt(1, [[[5, 6]], [[1, 2], [3, 4]]])) Returns: [3, 4]
GetAtReverse	Index (Integer) Array	Same as the GetAt function, except that the index is calculated from the end of the array.
StringJoin	Separator between joined parts (String) Array of items to join (Array)	Joins the given array of values (converted to strings) by using given separator into a single string. If given a hierarchical object, applies the function as described in at the level that is one level up from the leaf level. The depth of the result is one level less than the object that was given as parameter. Examples: StringJoin(", ", [1,null,"foo",DateTime(2017)]) Returns: 1, , foo, 01/01/2017 00:00:00 StringJoin(", ", [[1,2], [3,4]]) Returns: ["1, 2", "3, 4"]

Set functions

Function	Parameters	Description
Distinct	Array or hierarchical object	Modify given array by filtering out all duplicate values leaving only distinct values in the input array into the result. If given a hierarchical object, applies the function at the level that is one level up from the leaf level. Examples: Distinct([1]) Returns: [1] Distinct([1, 1]) Returns: [1] Distinct([1, 1, 2, 2]) Returns: [1, 2] Distinct([1, 1, 2, 2, "a", DateTime(2017), DateTime(2017), "b", DateTime(2016), "a"]) Returns: [1, 2, "a", DateTime(2017), "b", DateTime(2016)]
Intersect	First array Second array ...	Creates an intersection of multiple arrays. Returns a single array which contains an intersection of all the items in all the arrays given as parameter. If a parameter is not an array, it will be converted into an array having only the given element. Examples: Intersect([1, 2, "a", DateTime(2017), 5], ["a", 2, 3, DateTime(2017), 5], [DateTime(2017), "a", 2]) Returns: [2, "a", DateTime(2017)]
Except	First array Second array ...	Creates an substract given items from an array. Returns a single array which contains all the elements that were in the first array that were not in any of the subsequent arrays. If a parameter is not an array, it will be converted into an array having only the given element. Examples: Except([1, 2, "a", DateTime(2017), 5, "b", 6], ["a", 2, 3, DateTime(2017), 5], [DateTime(2017), "a", 2, 6]) Returns: [1, "b"]
Union	First array Second array ...	Creates an union of multiple arrays. Returns a single array which contains an union of all the items in all the arrays given as parameter. If a parameter is not an array, it will be converted into an array having only the given element. Examples: Union([1, 2, "a", DateTime(2017), 5], ["a", 2, 3, DateTime(2017), 5], [DateTime(2017), "a", 2, "b"]) Returns: [1, 2, "a", DateTime(2017), 5, 3, "b"]

Variable handling functions

Function	Parameters	Description
Def	Function name (String) Variable 1 name (String) Variable 2 name (String) ... Function expression	Creates a new user defined function. Parameters starting from the second, are the parameters that user gives when calling the function. The last parameter is the expression to evaluate when the function is called. In that definition expression the named parameters are used. The created function is valid only within the current scope and all its child scopes. Examples: Def("Inc", "a", a + 1); Inc(2); Returns: 3 Def("Add", "a", "b", a + b); [1, 2, 3].Add(_, 2); Returns: [3, 4, 5] Def("AddSelf", "b", _ + b); [1, 2, 3].AddSelf(2); Returns: [3, 4, 5] Def("Fib", "a", If(a < 2, 1, Fib(a - 1) + Fib(a - 2))); Fib(10); Returns: 89
Let	Variable 1 name (String) Variable 1 value (Object) Variable 2 name (String) Variable 2 value (Object) ... Expression to evaluate	Defines one or several user defined variables which can be used in the expression provided as the last parameter. Note that user defined variables cannot override existing properties. Examples: Let("var1", "Orange", "Value is " + var1) Returns: Value is Orange Let("var1", "Orange", "var2", "Mango", "Values are " + var1 + " and " + var2) Returns: Values are Orange and Mango
Set	Variable 1 name (String) Variable 1 value (Object) Variable 2 name (String) Variable 2 value (Object) ...	Set a value for a named variable. Can also be used to set several variable values at once. The variable to set must have been created in some visible scope by Let function. There can be any number of variable name and variable value pairs as long as the number of parameters is even number. If the number of parameters was two, the result is just the value that was set for that single value. If the number of parameters is more than two, the result is an array of all the set values.
Variable	Variable name (String)	Function to get a variable value. The function is needed when there are spaces in a variable name, because that variable cannot be referenced otherwise in the expressions.

Other functions

Function	Parameters	Description
DateTime	Year (Integer) Month (1-12) (Integer) Day (>= 1) (Integer) Hour (>= 0) (Integer) Minute (>= 0) (Integer) Second (>= 0) (Integer) Millisecond (>= 0) (Integer)	Creates a new DateTime object. Only the first (year) parameter is mandatory. Examples: DateTime(2017) Returns: A datetime for 1st January 2017 at 0:00:00. DateTime(2017, 5) Returns: A datetime for 5th January 2017 at 0:00:00. DateTime(2017, 5, 6, 13, 34, 56, 123) Returns: A date time object for 6th May 2017 at 13:34:56.123.
TimeSpan	Days (Integer) Hours (Integer) Minutes (Integer) Seconds (Integer) Milliseconds (Integer)	Creates a new Timespan object. Only the first parameter (number of days) is mandatory. By default, other parameters are assumed to be zero. Examples: TimeSpan(1) Returns: Time span for the duration of 1 day. TimeSpan(12,3,4,5,6) Returns: Time span for the duration of 12 days, 3 hours, 4 minutes, 5 seconds and 6 milliseconds.
Catch	Expression to calculate Result if exception (Object)	Calculates the given expression and if any exceptions are thrown during the calculation, catches that exception and returns the given result. Note that this function does not catch any syntactical errors. Examples: Catch(1, 1234) Returns: 1 Catch(undefined, 1234) Returns: 1234 Catch([1,2].undefined, 1234) Returns: 1234 Catch(EventLogById(-1), 1234) Returns: 1234
Coalesce	Object to coalesce Result if Null	Returns the second parameter if the first parameter evaluates to null or empty. If given a hierarchical object, applies the function at the leaf level. If the the given object is a hierarchical object, all its leaf level values are coalesced separately. Examples: Coalesce(0, 1) Returns: 0 Coalesce(null, 1) Coalesce(_empty, 1) Coalesce(_remove, 1) All return: 1 Coalesce([[null, 1], [null, null]], 3) Returns: [[3, 1], [3, 3]] Coalesce([[null, 1], 2], 3) Returns: [[3, 1], null] Coalesce([1, [null, 2], null], 3) Returns: [1, [null, 2], 3]
EventLogById	FilterId (Integer)	Returns EventLog object corresponding to the provided filter Id.
ModelById	ModelId (Integer)	Returns Model object corresponding to the provided model Id.
FindRepeats
Flatten	Array or hierarchical object	Collects all the actual leaf values from given array, array of arrays or hierarchical object and returns them in a single array. If given a hierarchical object, this function collects actual leaf values instead of leaf level values. Elements in the returned array are in the same order they were found when traversing the input object using depth first search. Examples: Flatten(1) Returns: 1 Flatten([1, 2]) Returns: [1,2] Flatten([[[1, 2],[3, 4]],[[5, 6]]]) Returns: [1, 2, 3, 4, 5, 6] Flatten([[1, 2], 3]) Returns: [1, 2, 3] Flatten([[1,2,3,4], null, [5], [1, null]]) Returns: [1, 2, 3, 4, null, 5, 1, null]
If	Condition expression True expression False expression	Evaluates the condition expression and if it's true, returns the value of the second parameter. Otherwise returns the value of the third parameter. Always evaluates only either the second or the third parameter, but never both. Examples: If(Now.Second % 2 == 0, "Even second", "Odd second") Returns: "Event second" or "Odd second" depending on the time of the evaluation. For("i", 0, i < 10, i + 1, i).If(_ % 2 == 0, _, _remove) Returns: [0, 2, 4, 6, 8] NOTE: Is equivalent to: For("i", 0, i < 10, i + 1, i).Where(_ % 2 == 0)
IsNull (Boolean)	Value to test (Object)	Return true if the provided value is null, otherwise returns false.
RemoveLeaves	Hierarchical object	Removes leaves from a hierarchical object.
ReplaceLeafValues	Array or hierarchical object Variable name used in the iteration (String) Expression to get the result of each iteration Number of levels up from the leaf level to operate (Integer)	Replace all leaf values of given array or hierarchical object at given levels up from the leaf level with results of given expression. Examples: ReplaceLeafValues([1,2, null], "x", If(IsNull(x), null, x+1), 0) Result: [2, 4, null] ReplaceLeafValues([[[1,2],[2,3]],[[3,4],[4,5]]], "x", Flatten(x), 0) Result: [[[[1],[2]],[[2],[3]]],[[[3],[4]],[[4],[5]]]] ReplaceLeafValues([[[1,2],[2,3]],[[3,4],[4,5]]], "x", Flatten(x), 1) Result: [[[1,2],[2,3]],[[3,4],[4,5]]] ReplaceLeafValues([[[1,2],[2,3]],[[3,4],[4,5]]], "x", Flatten(x), 2) Result: [[1,2,2,3],[3,4,4,5]] ReplaceLeafValues([[[1,2],[2,3]],[[3,4],[4,5]]], "x", Flatten(x), 3) Result: [1,2,2,3,3,4,4,5]
SliceMiddle	Start index for the range to extract (Integer) End index for the range to extract (Integer) Levels up in the hierarchy (Integer) Array to slice	Extracts a continuous range of an array or hierarchical object. If given a hierarchical object, applies the function at the level that is specified levels level up from the leaf level. Start index: Negative value means that the index is counting from the end of the array. If array does not have element at this given index, empty array is returned. End index: not included into the extracted range. Negative value means that the index is counting from the end of the array. If array does not have element at this given index, all the elements to the end from the start index will be extracted. Levels up: At which level of the hierarchical object are we operating (number of levels up from the leaf level). Should be at least 1 (since 0 level does not contain arrays). Examples: SliceMiddle(1, 2, 1, [[0, 1, 2, 3], [4, 5, 6, 7]]) Returns: [[1], [5]] SliceMiddle(2, 4, 1, [[0, 1, 2, 3], [4, 5, 6, 7]]) Returns: [[2, 3], [6, 7]] SliceMiddle(0, 1, 2, [[0, 1, 2, 3], [4, 5, 6, 7]]) Returns: [0, 1, 2, 3] SliceMiddle(3, 5, 1, [0, 1, 2, 3, 4, 5, 6, 7]) Returns: [3, 4] SliceMiddle(-3, -1, 1, [0, 1, 2, 3, 4, 5, 6, 7]) Returns: [5, 6] SliceMiddle(3, -1, 1, [0, 1, 2, 3, 4, 5, 6, 7]) Returns: [3, 4, 5, 6]
Where	Condition expression False expression	Returns the context object if the given expression evaluates to true. Otherwise returns the second parameter. The second parameter is optional and it's by default EMPTY. Examples: [1,2,3,4].Where(_>2) Returns: [3,4] [1,2,3,4].Where(_>2, _+100) Returns: [101, 102, 3,4] [1,2,3].[_,_+1] Returns: [[1, 2], [2, 3], [3, 4]] [1,2,3].[_,_+1].Where(_>=3) Returns: [[], [3], [3, 4]] [1,2,3].[_,_+1].Where(_>=3, _remove) Returns: [[3], [3, 4]]
GetValueOfContext	Context object Hierarchical array from which the value is searched	Returns the value of specified context object in given hierarchical array. Returns the the first value of specified context object in the given hierarchical array. If a match is found, the result will be an array. Returns _empty if the given key was not found. Examples: GetValueOfContext("bar", ["foo":1, "bar":2]) Returns: [2] GetValueOfContext("bar", ["foo":1, "bar":2, "bar":"second"]) Returns: [2] GetValueOfContext("test", ["foo":1, "bar":2]) Returns: _empty