Generic Objects in Expression Language

Generic Properties

Functions available in the generic context are available here. Properties available in the generic context are listed in the following table.

Property	Description
_	Refers to the current context. See more information about expression context.
null	Returns a special null value. Usually null represents non-existing or missing value. Null value is similar to EMPTY value, except null values can also be recursed.
_empty	Returns an object which represent a non-existent value. Textual representation of this value is "EMPTY".
_remove	A special value which, when traversing through a hierarchical object, means that an item in the hierarchical object should be removed. Examples: [1, 2, 3, 4].(2 * _) Returns: [2, 4, 6, 8] [1, 2, 3, 4].if(_ == 2,_remove,_) Returns: [1, 3, 4] 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]
Now (DateTime)	DateTime object representing the current date and time.
Users (User*)	Returns an array of users visible for the current user as User objects.
UserGroups (User*)	Returns an array of user groups visible for the current user as User objects.
CurrentUser (User)	Returns the current user as User object.
Models (Model*)	All Model objects in the QPR ProcessAnalyzer server (that the user have rights).
Projects (Project*)	All Projects in the QPR ProcessAnalyzer server (that the user have rights).
EventLog (EventLog)	Returns the EventLog in which context the expression is being evaluated.
AllBuiltInFunctions	Returns all the built in functions as FunctionDefinition objects (as an array) no matter what their calculation context is.
AllBuiltInProperties	Returns all the built in properties as FunctionDefinition objects (as an array) no matter what their calculation context is.
BuiltInFunctions	Returns all the built in functions as FunctionDefinition objects (as an array) valid for the current calculation context.
BuiltInProperties	Returns all the built in properties as FunctionDefinition objects (as an array) valid for the current calculation context.
CachedItems (String*)	Returns a string array of all keys of the items currently stored in the in the memory cache. Global ManageOperations permission is needed.
CalcId (String)	Returns an id that is unique among all QPR ProcessAnalyzer objects in the server. CalcId 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.
CalculationContextTypeName (String)	Returns the type of the current calculation context. Examples: CalculationContextTypeName Returns: "Generic" [1, "a", [1, 2], TimeSpan(1, 2, 3, 4), DateTime(2016,1,1), Def("", _ + 1)].CalculationContextTypeName Returns: ["Generic", "String", "Generic", "TimeSpan", "DateTime", "FunctionDefinition"] EventLogById(<event log id>).CalculationContextTypeName Returns: EventLog
AvailablePhysicalMemory (Integer)	Returns the available (free) physical memory (in bytes) of the computer where QPR ProcessAnalyzer server is running.
AvailableVirtualMemory (Integer)	Returns the available (free) virtual memory (in bytes) of the computer where QPR ProcessAnalyzer server is running.
ComparisonEventLog (EventLog)	Returns the current comparison EventLog in which context the expression is being evaluated. Comparison EventLog is available only when the KPI analysis request has been initialized with RuntimeComparison parameter set to 1.
InternalTypeName	Returns the .NET type name of the context object.
PerformanceCounterCpu (Float)	Returns processor usage of the computer where QPR ProcessAnalyzer server is running. Processor usage is calculated as a sum of the cores where each core value is between 0 and 100. In the web.config, EnableProcessPerformanceCounter=True needs to be set for this setting to work, otherwise it returns null.
PerformanceCounterMemory (Float)	Returns the current number of bytes in working set of the process memory in the computer where QPR ProcessAnalyzer server is running. In the web.config, EnableProcessPerformanceCounter=True needs to be set for this setting to work, otherwise it returns null.
TotalPhysicalMemory (Integer)	Returns the total physical memory (in bytes) of the computer where QPR ProcessAnalyzer server is running.
TotalVirtualMemory (Integer)	Returns the total virtual memory (in bytes) of the computer where QPR ProcessAnalyzer server is running.
UsedProcessMemory (Integer)	Current memory consumption by the QPR ProcessAnalyzer Server in bytes.

Array

See introduction to arrays. Following list contains all array related 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.
Concat (Array)	Hierarchical object	Concatenate multiple arrays together into one. Returns a single array which contains all the arrays given as parameter concatenated together in the same order they were given. If a parameter is not an array, it will be converted into an array having only the given element. Examples: Concat(1, [DateTime(2017), 3], [4, "foo"], "bar") Returns: [1, DateTime(2017), 3, 4, "foo", "bar"]
ConcatTop (Hierarchical object)	Hierarchical object	Concatenate the topmost arrays in a given hierarchical object. Returns a new hierarchical object with the contents of the topmost level concatenated and removed. Examples: ConcatTop([ 0, [1,2], [3], [4,[6,7]] ]) Returns: [1, 2, 3, 4, [6, 7]] ConcatTop([ [1,[2,3]], [4,[6,7]] ]) Returns: [1, [2, 3], 4, [6, 7]]
CountTop (Integer)	Hierarchical object	Get the number of elements in the topmost level array of a given array or hierarchical object. If the parameter is not an array, zero is returned. Examples: CountTop([ 0, [1,2], [3], [4,[6,7]] ]) Returns: 4 CountTop([[1,[2,3]],[4,[6,7]]]) Returns: 2 CountTop(0) Returns: 0
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)]
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"]
First (Object)	Array	Gets the first item in the array. If array has no items, returns _empty. Examples: First([1,2,3,4]) returns 1. First([]) returns _empty.
GetAt (Object)	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 (Object)	Index (Integer) Array	Same as the GetAt function, except that the index is calculated from the end of the array.
In (Boolean)	Array where to search the object	Function checks whether the current context object is in given array, and returns either true or false. Note that the searched object is not given as a parameter, but it's the context object for the function (see the examples). Examples: 1.In([1,2,3]) Returns: true [1].In([[1],2,3]) Returns: false DateTime(2017).In([DateTime(2016), DateTime(2017)]) Returns: true Count(eventLog.Events.TimeStamp.DateTime(_.Year).In([DateTime(2012)]).Where(_==true)) Returns: The number of events there are in the given event log that have time stamp for year 2012.
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)]
IndexOf (Integer)	array item (Object) startFrom (Integer)	Gets the index of the first occurrence of the item in the array. If the item is not found, -1 is returned. Parameters: array: Array to search the item in. item: Object to search in the array. startFrom (optional): Index in the array to start the search from. Examples: IndexOf(["the", "fox", "jumps", "over", "the", "dog"], "the") returns 0. IndexOf(["the", "fox", "jumps", "over", "the", "dog"], "the", 1) returns 4. IndexOf(["the", "fox", "jumps", "over", "the", "dog"], "the", 5) returns -1. IndexOf(["the", "fox", "jumps", "over", "the", "dog"], "a") returns -1.
IndexOfSubArray (Integer*)	Sub-array to search Main-array from where to search	Returns indexes of the given sub-array (1. parameter) within the given main-array (2. parameter). The function returns starting indexes of all the occurrences of given sub-array within given main-array. If only the first parameter is given, the array in the current context object is used as the main-array. Examples: IndexOfSubArray([4], [1,2,3,4,1,2,5]) Return: 3 IndexOfSubArray([1,2], [1,2,3,4,1,2,5]) Return: [0, 4] IndexOfSubArray([1,2,4], [1,2,3,4,1,2,5]) Returns: [] [[1,2,3,4,1,2,5]].IndexOfSubArray([1,2]) Return: [0, 4]
IsArray (Boolean)	Object to check	Tests whether given object is an array or hierarchical object. Returns true if it is. Examples: ForEach("item", [1, "a", null, [1,2,3], ["foo":[null,"a"], "bar":[2,null]]], IsArray(item)) Returns: [false, false, false, true, true]
Last (Object)	Array	Gets the last item in the array. If array has no items, returns _empty. Examples: First([1,2,3,4]) returns 4. First([]) returns _empty.
LastIndexOf (Integer)	array item (Object) startFrom (Integer)	Gets the index of the last occurrence of the item in the array. If the item is not found, -1 is returned. Parameters: array: Array to search the item in. item: Object to search in the array. startFrom (optional): Index in the array to start the search from. Examples: LastIndexOf(["the", "fox", "jumps", "over", "the", "dog"], "the") returns 4. LastIndexOf(["the", "fox", "jumps", "over", "the", "dog"], "the", 3) returns 0. LastIndexOf(["the", "fox", "jumps", "over", "the", "dog"], "a") returns -1.
Suffle (Array)	Array to be shuffled	Shuffles the given array into a random order. Returns an array with the same items as in the input array, but in random order. Examples: Shuffle([1, 2]) Returns: Either [1, 2] or [2, 1] both in about 50% of the calls. Shuffle(NumberRange(0, 99))[NumberRange(0, 9)] Returns: An array containing 10 random unique values between 0 and 99 ("Random sample of size 10").
StringJoin (String)	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"]
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"]
Zip (Array)	Arrays to be combined	Combines multiple arrays into a single array. All the input arrays must be of the same length. Returns an array where the number of elements equal to the number of elements in each of the input arrays. All elements in the Nth position of the array are the concatenated values of Nth elements of each of the input arrays. Examples: Zip([1,2,3,4], [5,6,7,8], [9,10,11,12]) Returns: [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]] Zip([1,2], [3,4], [5,6]) Returns: [[1, 3, 5], [2, 4, 6]] Zip([1,2,3]) Returns: [[1], [2], [3]] Zip([[1],[2],[3]]) Returns: [[1,2,3]] Zip([]) Returns: [] Zip([1], [4,5], [7,8,9]) Gives an error

DateTime

DateTime represents a timestamp.

DateTime properties	Description
Day (Integer)	The day of the calendar month represented by the DateTime. Number between 1 and 31. Based on QPR ProcessAnalyzer server local time.
Hour (Integer)	The hour component of the date represented by the DateTime. Number between 0 and 23. Based on QPR ProcessAnalyzer server local time.
Millisecond (Integer)	The millisecond component of the date represented by the DateTime. Number between 0 and 999. Based on QPR ProcessAnalyzer server local time.
Minute (Integer)	The minute component of the date represented by the DateTime. Number between 0 and 59. Based on QPR ProcessAnalyzer server local time.
Month (Integer)	The calendar month component of the date represented by the DateTime. Number between 1 and 12. Based on QPR ProcessAnalyzer server local time.
Second (Integer)	The second component of the date represented by the DateTime. Number between 0 and 59. Based on QPR ProcessAnalyzer server local time.
Ticks (Integer)	Number of ticks represented by the DateTime. The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001 (0:00:00 UTC on January 1, 0001, in the Gregorian calendar). A single tick represents one hundred nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond, or 10 million ticks in a second.
Year (Integer)	The year component of the date represented by the DateTime. Number between 1 and 9999. Based on QPR ProcessAnalyzer server local time.

DateTime functions	Parameters	Description
Round (DateTime)	TimeSpan or Integer	Rounds given date time by given TimeSpan or given number of seconds. Example: Round to the nearest hour: Round(DateTime(2017, 1, 1, 14, 48), TimeSpan(0, 1)) DateTime(2017, 1, 2, 3, 4, 5).Round(10) Returns: DateTime(2017, 1, 2, 3, 4, 10) DateTime(2017, 1, 2, 3, 4, 5).Round(TimeSpan(1)) Returns: DateTime(2017, 1, 2)
Truncate (DateTime)	Period (String)	Truncates given DateTime value to given precision. Truncating means that the provided DateTime (i.e. timestamp) is converted into a timestamp representing the beginning of the period. For example, if period is year, the Truncate function returns the first date of the year where the input DateTime is belonging. Truncate function is useful e.g. when dimensioning data into different periods. Supported precision values are: year, quarter, month, week, day, hour, minute and second. Examples: DateTime(2018, 5, 14, 3, 4, 5).Truncate("year") Returns: DateTime(2018) DateTime(2018, 5, 20, 3, 4, 5).Truncate("quarter") Returns: DateTime(2018, 4, 1) DateTime(2019, 8, 14, 3, 4, 5).Truncate("day") Returns: DateTime(2019, 8, 14) DateTime(2019, 8, 14, 3, 4, 5).Truncate("hour") Returns: DateTime(2019, 8, 14, 3)

The following functions can be used to initialize DateTime objects:

Function	Parameters	Description
DateTime	Year (1-9999) (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.
DateTimeFromTicks	Number of ticks (Integer)	Creates a new DateTime object from an integer representing ticks. A single tick represents one hundred nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond, or 10 million ticks in a second. Examples: DateTimeFromTicks(DateTime(2018, 5, 6, 13, 34, 56, 123).Ticks) Returns: A date time object for 6th May 2018 at 13:34:56.123.

String

String properties	Description
Length	Return the number of characters in the input string. Example: "Test".Length Returns: 4. "".Length Returns: 0.

String functions	Parameters	Description
CharAt	Index number (Integer)	Return a character (as a String) in the index number position in the input string. The indexing starts from zero. Negative index numbers are not allowed. Examples: "test".CharAt(1) Returns: "e" "test".For("i", 0, i < Length, i + 1, CharAt(i)) Returns: ["t", "e", "s", "t"]
Contains	searched string	Returns true if the input string contains the searched string; otherwise false. String comparison is case sensitive. Example: "test".Contains("st") Returns: true
EndsWith	searched string	Return true if the input string ends with the searched string; otherwise false. String comparison is case sensitive. "test".EndsWith("st") Returns: true
IndexOf	searched string start index (Integer) (optional)	Return the index number of the first occurrence of the searched string in the input string. Indexing starts from zero. If the start index is provided, the search is started from that index. The function returns -1 if match is not found. The start index is optional. Invalid start index is negative or more than input string length. Examples: "test".IndexOf("t") Returns: 0 "test".IndexOf("t", 1) Returns: 3
LastIndexOf	searched string start index (Integer)	Return the index number of the last occurrence of the searched string in the input string. Indexing starts from zero. If the start index is provided, the search is started from that index (calculated from the start of the string) towards the beginning of the string. Return -1 if match not found. Invalid start index is negative or more than input string length.
Replace	first string second string	Replaces all occurrences of the first string with the second string in the input string. String comparison is case sensitive. Example: "abcd".Replace("b", "e") Returns: "aecd"
Split	Split character (string or string array) Remove empties (Boolean) (optional)	Splits input string into array of substrings. The string is splitted based on a character or array of characters (that are provided as strings). String comparison is case sensitive. When remove empties parameter is true, empty strings are excluded (by default false). Examples: "1,2,3".Split([","]).ToInteger(_) Returns: [1,2,3] "a,b,,c".Split(",", true) Returns: ["a","b","c"] "a,b,,c".Split(",") Returns: ["a","b","","c"]
StartsWith	searched string	Return true if the input string starts with the searched string; otherwise false. String comparison is case sensitive. "test".StartsWith("t") Returns: true
Substring	start index (Integer) length (Integer) (optional)	Returns a substring of the input string starting from the start index. If the length is provided, the returned string contains maximum of that number of characters. Invalid start index is negative or more than input string length. Invalid length is negative or start index plus length is more then input string length. "Test123".Substring(4) Returns: "123" "Test123".Substring(4, 2) Returns: "12"
ToLower	[none]	Return a string where all the characters of the input string have been converted to lower case characters. "Test".ToLower() Returns: "test"
ToUpper	[none]	Return a string where all the characters of the input string have been converted to upper case characters.
Trim	string or arrays of strings (optional)	Removes spaces from the start and end of the input string (if array of strings is not provided). If the array of strings is provided, all leading and trailing characters in the array of strings are removed from the input string. Accepts also a single string in which case it is treated as if an array containing only that string was given as parameter. Examples: " Test".Trim() Returns: "Test" "Test".Trim(["T", "t"]) Returns: "es" "Test".Trim("t") Returns: "Tes"

TimeSpan

TimeSpan represents a time interval (duration of time or elapsed time) that is measured as a positive or negative number of days, hours, minutes, seconds, and fractions of a second. The TimeSpan is not bound to calendar time, so a TimeSpan can be used to represent the time of day, but only if the time is unrelated to a particular date.

Difference between two TimeStamps is TimeSpan. TimeStamp added by TimeSpan is TimeStamp.

Minimum possible value of a TimeSpan is -10 675 199 days 2 hours 48 minutes 5.4775808 seconds and maximum possible value is 10 675 199 days 2 hour 48 minutes 5.4775807 seconds.

TimeSpan properties	Description
Ticks (Integer)	Number of ticks represented by the TimeSpan. A single tick represents one hundred nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond, or 10 million ticks in a second.
TotalDays (Float)	TimeSpan value in days (one day is 24 hours) (both whole and fractional).
TotalHours (Float)	TimeSpan value in hours (both whole and fractional).
TotalMilliseconds (Float)	TimeSpan value in milliseconds (both whole and fractional).
TotalMinutes (Float)	TimeSpan value in minutes (both whole and fractional).
TotalSeconds (Float)	TimeSpan value in seconds (both whole and fractional).

The following functions can be used to initialize Timespan objects.

Function	Parameters	Description
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.
TimeSpanFromTicks	Number of ticks (Integer)	Creates a new TimeSpan object from an integer representing ticks. A single tick represents one hundred nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond, or 10 million ticks in a second. Examples: TimeSpanFromTicks(TimeSpan(12,3,4,5,6).Ticks) Returns: A time span object representing 12 days, 3 hours, 4 minutes, 5 seconds and 6 milliseconds.

Dictionary

Dictionary represents a collection of key-value pairs, where the keys are unique within a dictionary. See also the dictionary literal syntax and the lookup operator for dictionaries.

Expression language is able to handle JSON by converting JSON strings into objects and objects into JSON strings. In the expression language, the object created from JSON strings, are dictionaries.

Dictionary properties	Description
Count (Integer)	Returns the number of elements stored into this dictionary.
Keys	Returns the array of all the keys in this dictionary.
Values	Returns the array of all the values in this dictionary.

Dictionary Functions	Parameters	Description
Add		Adds possibly multiple values into the dictionary. Takes even number of parameters, where every odd parameter represents key. Every even parameter represents the value to be added for the preceding key. Returns the dictionary itself. Will throw an exception if a value with the same key already exists in the dictionary. Examples: ToDictionary().Add("a", 1, "b", 2).(Get("a") + Get("b")) Returns: 3 ToDictionary().Add("a", 1, "a", 2).Get("a") Throws an exception.
ContainsKey	Key to search for (String)	Check whether given key exists in the dictionary. Returns true only if there is a stored value for given key. Examples: ToDictionary().Set("a", 1).ContainsKey("a") Returns: True ToDictionary().Set("a", 1).ContainsKey("b") Returns: False
Get	Key to search for (String)	Get the value associated with the given key from the dictionary. Returns the value associated with the key in the dictionary. Will throw an exception if there is no value associated with the given key in the dictionary. Examples: ToDictionary().Set("a", 1, "b", 2).Get("b") Returns: 2 ToDictionary().Set("a", 1, "b", 2).Get("c") Throws an exception.
Extend (Dictionary)	Dictionary	Adds the values from another dictionary (or array of dictionaries) to this dictionary, and returns the dictionary itself. The function overwrites any possible earlier values in the dictionary. If the dictionary provided as a parameter, is not an array and the item is a dictionary, all the values of its keys will be added to the context dictionary. If the dictionary provided as a parameter is not an array and the item is an hierarchical array, all the values will be added to the context dictionary so that the last value in the array is used when duplicates exist. If the other dictionary is an array, all the items are added one-by-one using the procedure described earlier. Examples: #{}.Extend(#{"a": 1, "b": 2, "c": 5}) Returns: #{ "a": 1, "b": 2, "c": 5 } #{}.Extend(["a": 1, "b": 2, "a": 5]) Returns: #{ "a": 5, "b": 2 } #{"a": 1, "c": 3}.Extend(["a": 5, "b": 2]) Returns: #{ "a": 5, "b": 2, "c": 3 } #{}.Extend(EventLogById(1).Cases:Name) Returns: A dictionary containing all the cases in event log so that the case itself is a key and its name is the value. #{}.Extend(EventLogById(1).Cases.#{_: Name}) Returns: The same as above.
Remove	Key to remove (String)	Removes value of given key from the dictionary. Returns true only if the a value associated with given key was found and successfully removed from the dictionary. Examples: ToDictionary().Set("a", 1, "b", 2).Remove("b") Returns: True ToDictionary().Set("a", 1, "b", 2).Remove("c") Returns: False Let("dictionary", ToDictionary().Set("a", 1, "b", 2)); dictionary.Remove("b"); dictionary.Keys Returns: ["a"]
Set		Sets possibly multiple values into the dictionary. Will overwrite any possible earlier values the key had in the dictionary. Takes even number of parameters, where every odd parameter represents key. Every even parameter represents the value to be set for the preceding key. Returns the dictionary itself. Examples: ToDictionary().Set("a", 1, "b", 2).(Get("a") + Get("b")) Returns: 3 ToDictionary().Set("a", 1, "a", 2).Get("a") Returns: 2
ToArray		Converts dictionary object into a hierarchical array. Returns the dictionary object converted into a hierarchical array. Examples: ToDictionary().ToArray() Returls: [] ToDictionary().Add("a", 1, "b", 2).ToArray() Returns: [ "a": [1], "b": [2] ]
TryGetValue	Key to search for (String)	Tries to get the value associated with the given key from the dictionary. If the key was found in the dictionary, returns the value associated with the key in the dictionary. Otherwise, returns _empty. Examples: ToDictionary().Set("a", 1, "b", 2).TryGetValue("b") Returns: 2 ToDictionary().Set("a", 1, "b", 2).TryGetValue("c") Returns: _empty

JSON conversion functions:

Function	Parameters	Description
ParseJson	json data (String)	Converts given JSON string into an object. JSON objects are represented as Dictionary objects in the expression language. Examples: ParseJson("{\"a\": 1, \"b\": 2}")["b"] Returns: 2 Sum(ParseJson("[1, 2, 3, 4]")) Returns: 10 ToJson(ParseJson("{\"a\": 1, \"b\": 2}")) Returns: #{"a":1,"b":2}
ToJson	Object	Converts given object into JSON. It is recommended that hierarchical arrays and objects are first converted to dictionaries before converting to JSON since JSON does not have exactly identical construct and thus converting JSON back to expression object will not result object similar to the original. Examples: ToJson(ParseJson("{\"a\": 1, \"b\": 2}")) Returns: #{"a":1,"b":2} ToJson(ToDictionary().Set("a", 1, "b", 2)) Returns: #{"a":1,"b":2} ToJson([1,[[2,ToDictionary().Set("a", 1)],4]]) Returns: [1,[[2,#{"a":1}],4]] ToJson(null) Returns: null ToJson(_empty) Returns: #{} ToJson(["a": 1, "b": 2]) Returns: [#{"Root":"a","Array":[1]},#{"Root":"b","Array":[2]}]

Function	Parameters	Description
ToDictionary	Hierarchical object to convert	Converts given hierarchical array into a Dictionary object. Returns a dictionary object where each hierarchical array element has corresponding key+value pair. Throws an exception if the obj parameter is specified but is not an array. All the elements in the obj array that don't have context specified will be ignored. Parameters: Hierarchical array to convert. If not defined, an empty array is used. convertArrayOfLength1ToScalar: Optional boolean value to configure how to interpret hierarchical array values having array length of 1. If enabled (=true, default value), the generated dictionary will have all its values initialized as arrays of values, except if the array is of length, in which case the value of that single array item will be used as dictionary value. If disabled, all the values will be stored as arrays in the dictionary. Examples: ToDictionary() Returns: <empty dictionary object> ToDictionary(["a": 1, "b": 2]).Get("b") Returns: 2 ToDictionary(["a": [1, 2], "b": [2, 3]]).Get("b") Returns: [2, 3] ToDictionary(["a": 1, "b": 2], false).Get("b") Returns: [2] ToDictionary(["a": [1], "b": [2]], false).Get("b") Returns: [2] ToDictionary(["a": [1, 2], "b": [2, 3]], false).Get("b") Returns: [2, 3] ToDictionary("abcd") Throws an exception ToDictionary(["a": 1, 2]).ToArray() Returns: ["a": 1]

Function

FunctionDefinition is a type that encapsulates a function. The function defintion consist of followin parts:

• function body (expression)
• function parameters (optional)
• function name.

FunctionDefinition objects can be created in the following ways:

• Using function <function name>(<function arguments>)<function body> syntax
• Using (<function arguments>) => <function body> syntax
• Using Def function
• In Def function, use &-prefix is for an attribute

Functions defined by a FunctionDefinition object can be called as follows: <function name>(<function arguments>). Functions are evaluated in a new scope, i.e. variables defined in the function are only available within that function.

Examples:

Def(null, "a", "b", a+b)._(1,2)
((a, b)=>a+b)._(1,2)
((a, b)=>a+b)(1,2)
Returns: 3

[Def("", "a", "b", a+b), Def("", "a", "b", a*b)].(_(1,2))
[(a, b)=>a+b, (a, b)=>a*b].(_(1,2))
Returns: [3, 2]

Def("FirstOrNull", "arr", CountTop(arr) > 0 ? arr[0] : null)
function FirstOrNull(arr) { CountTop(arr) > 0 ? arr[0] : null }
Result: Are all equivalent and create a function FirstOrNull into the current evaluation scope. Returns also the created FunctionDefinition object.

The FunctionDefinition objects have the following properties:

• Arguments: Returns an array containing names of all arguments of the function.
• Body: Expression body of the function as string.
• Name: Name of the function if this is a named function.