Skip to main content



All Functions

All functions listed alphabetically.

All FunctionDescription
AbsReturns the absolute value of a numeric expression.
AddDaysThe AddDays function adds a specified number of days to a DateTime value.
AddHoursThe AddHours function adds a specified number of hours to a DateTime value.
AddMillisecondsThe AddMilliseconds function adds a specified number of milliseconds to a DateTime value.
AddMinutesThe AddMinutes function adds a specified number of minutes to a DateTime value.
AddMonthsThe AddMonths function adds a specified number of months to a DateTime value.
AddSecondsThe AddSeconds function adds a specified number of seconds to a DateTime value.
AddWeekdaysThe AddWeekdays function adds a specified number of weekdays to a DateTime value.
AddYearsThe AddYears function adds a specified number of years to a DateTime value.
AllAreFalseThe AllAreFalse function returns true if all of the provided conditions is false. Otherwise false.
AllAreTrueReturns true if all of the provided conditions are true. Otherwise false.
AnyAreFalseThe AnyAreFalse function returns true if any of the provided conditions is false. Otherwise false.
AnyAreTrueReturns true if any of the provided conditions are true. Otherwise false.
AverageReturns the average of a specified field or expression across a collection.
AvgReturns the average of a specified field or expression across a collection.
BankRoundReturns the number rounded to the number of decimal places using the rules of bankers rounding.
BuildDateThe BuildDate function returns a date from a specified year, month, and day.
ChrReturns the character associated with the specified character code.
CollectionLookupThe CollectionLooup function returns the value of a field or expression for the first collection member that satisfies a given filter expression.
ConcatGenerates a string concatenation of two or more expressions.
ConcatGenerates a string concatenation of two or more expressions.
ContainsDetermines if a text string or expression contains another text string or expression.
CountThe Count function returns the number of members in a collection.
CurrentReturns the value of a field within the context of current expression.
CurrentContextReturns the value of a field within the context of current expression.
DayReturns the day of the month for a given Date or DateTime.
DayDiffThe DayDiff function returns the number of days between two Date values.
DayOfWeekReturns the day of the week with 0 = Sunday and 6 = Saturday.
DayOfYearReturns the day of the year, 1 = 1/1 and 365(366) = 12/31.
DaysInMonthThe DaysInMonth function returns the number of days in the month.
DaysInYearReturns the number of days in the year.
DivideDivides the value of one numeric expression by another.
EndsWithDetermines if a text string or expression ends with another text string or expression.
EqualToReturns true if two expressions are equal.
EscapeJsonThe EscapeJson function replaces invalid JSON characters (backspace, form feed, newline, carriage return, tab, double quote, and backslash) in a string with their valid equivalent.
EscapeXmlThe EscapeXml function replaces invalid XML characters (ampersand, less than, greater than, quote, and apostrophe) in a string with their valid XML equivalent.
EvalReturns the value of evaluating the specified value as an expression.
ExpThe Exp function returns e raised to a given power.
FormatThe Format function formats a numeric or date expression.
FVReturns the end-of-period future value for a series of payments given the interest rate, number of periods, payment amount, and initial principal
GetAttributeReturns the attribute value for an element as specified by the engine attribute for it.
GetDefaultReturns the default value of the element.
GetElementIdReturns the element id of the element.
GetEntityIdReturns the EntitiyID for the element.
GetEntityNameReturns the name of the entity.
GetFieldValueListGets specified value list by field name.
GetFirstThe GetFirst function returns the first collection member that satisfies a given filter expression.
GetFirstValueReturns the specified field value of first member of collection which can be sorted and filtered. In case of failed lookup, a default value must be specified.
GetIndexReturns the current index of a collection member in its parent collection. If it exists in multiple collections, only its index in the first authored collection is returned.
GetLastThe GetLast function returns the last collection member that satisfies a given filter expression.
GetLastValueReturns the specified field value of last member of collection which can be sorted and filtered. In case of failed lookup, a default value must be specified.
GetLocalDateTimeReturns a datetime value having Local kind.
GetMemberReturns the first member that matches the filter criteria.
GetMemberByIndexReturns the member at an index in a collection which can be ordered and filtered using filter expression.
GetMemberValueThe GetMemberValue function returns the specified field value of the first collection member that satisfies a given filter criteria.
GetMemberValueByIndexReturns the specified field value of member at an index in collection which can be ordered and filtered using filter expression.
GetNameReturns the name of the element.
GetUnspecifiedDateTimeReturns a datetime value having an Unspecified kind.
GetUtcDateTimeReturns a datetime value having UTC kind.
GetValueListGets specified value list by DataElement name.
GetXPathReturns xpath of the element.
GreaterThanReturns true if the first expression is greater than the second expression.
GreaterThanOrEqualReturns true if the first expression is greater than or equal to the second expression.
HasWhitespaceThe HasWhitespace function returns true if a given string starts with, ends with, or contains duplicate whitespace.
HourThe Hour function returns the hour of the day for a given DateTime (0 to 23).
HourDiffThe HourDiff function returns the number of hours between two DateTime values.
IfThe If function returns one of two values, depending on a given condition.
IfCaseThe IfCase function compares a test value against a list of values, returning the result from the first matching pair.
IfChainThe IfChain function returns the return value from the first true condition in a list.
InstrThe Instr function returns the position of the first occurrence of one string within another string.
InvokeEntityMethodReturns the value (if any) of an instance method call on (an defined by) an entity.
IPMTReturns the end-of-period interest payment for given present value at specified rate for specified period.
IsBetweenReturns true if a value is equal to or between two boundary values.
IsClassificationReturns true the given field meets the criteria to belong to the given classification.
IsDateThe IsDate function determines if an expression is a valid Date (or a DateTime with a zero time offset).
IsDateTimeThe IsDateTime function determines if an expression is a valid DateTime.
IsInvalidReturns true if the element is invalid.
IsInValueListReturns true if the given value is contained in the specified value list, otherwise returns false.
IsLeapYearThe IsLeapYear function returns true if the year is a leap year.
IsLocalDateTimeReturns true if the expression is a valid Local kind datetime.
IsMatchDetermines if a given value is found in a list of values.
IsNotNullOrEmptyThe IsNotNullOrEmpty function returns true if a field is not null or empty.
IsNullThe IsNull function returns true if a field is null.
IsNullOrEmptyThe IsNullOrEmpty function returns true if a field is null or empty.
IsNumericReturns true if a value is or can be converted to a number without error.
IsRegexMatchDetermines if an expression matches a Regular Expression pattern.
IsUnspecifiedDateTimeReturns true if the expression is a valid unspecified kind datetime.
IsUtcDateTimeReturns true if the expression is a valid UTC kind datetime.
IsValidReturns true if the element is valid.
IsWeekdayThe IsWeekday function returns true if a given DateTime is not a Saturday or Sunday.
IsWeekendReturns true if the given date is a Saturday or Sunday.
IsWildcardMatchDetermines if an expression matches an DOS-style wildcard expression.
JsonLookupThe JsonLookup function returns the JSON of the first property or array that matches a given search path. Does not support retrieving an array of primitive values.
LargestReturns the largest value in a list of values.
LeftThe Left function returns a string containing a specified number of characters from the left side of a string.
LenReturns the length of a string.
LengthReturns the length of a string.
LessThanReturns true if the first expression is less than the second expression.
LessThanOrEqualReturns true if the first expression is less than or equal to the second expression.
LogReturns the natural (base e) logarithm of a specified number.
LookupReturns the value from a table for the first row that satisfies the filter.
MaxReturns largest value of a member field or expression across a collection.
MidThe Mid function returns a substring of a string.
MillisecondThe Millisecond function returns the milliseconds for a given DateTime (0 to 999).
MillisecondDiffThe MillisecondDiff function returns the number of milliseconds between two DateTime values.
MinReturns smallest value of a member field or expression across a collection.
MinusSubtracts the value of one numeric expression from another.
MinuteThe Minute function returns the minute of the hour for a given DateTime (0 to 59).
MinuteDiffThe MinuteDiff function returns the number of minutes between two DateTime values.
ModDivides two numbers and returns only the remainder.
MonthReturns the month for a given Date or DateTime.
MonthDiffThe MonthDiff function returns the number of months between two Date values.
MultiplyMultiplies the value of one numeric expression by another.
NoneAreFalseThe NoneAreFalse function returns true if none of the provided conditions is false. Otherwise false.
NoneAreTrueThe NoneAreTrue function returns true if none of the provided conditions is true. Otherwise false.
NotThe Not function performs logical negation.
NotEqualToReturn true if two expressions are not equal.
NotEqualToReturn true if two expressions are not equal.
NowThe Now function returns the current date and time in the local time zone, as of the start of rule processing.
NumberOfFalseThe NumberOfFalse function returns the number of provided conditions that evaluate as false.
NumberOfTrueThe NumberOfTrue function returns the number of provided conditions that evaluate as true.
NumDigitsReturns the number of digits in a given number, not counting trailing zeros to the right of the decimal point nor any leading zeros.
NumFracDigitsReturns the number of digits in a given number that appear to the right of the decimal point, not counting trailing zeros.
NumIntDigitsReturns the number of digits in a given number that appear to the left of the decimal point, not counting preceding zeros.
OuterReturns the value of a field within the outer context of an aggregate expression.
OuterContextReturns the value of a field within the outer context of an aggregate expression.
PercentThe Percent function returns (value * percent) / 100.0.
PlusAdds the value of one numeric expression to another.
PMTReturns the end-of-period payment for given present value at specified rate for specified period. Note: The result is not negated as a debt. (e.g. PMT(0, 10, 10000) = 1000.00 not -1000.00)
PowerTakes the value of one numeric expression to the power of the exponent value.
PPMTReturns the end-of-period principal payment for given present value at specified rate for specified period.
ProperCaseThe ProperCase function returns a copy of a string with the first letter of every word capitalized and the rest of the letters in lower case.
PVReturns the end-of-period present value for a series of future payments given, the interest rate, the number of periods, the payment amount, and the future value remaining after all payments are made
QueryToListGets value list from Query.
RandomReturns a random integer between the specified minimum and maximum values.
RateReturns the end-of-period interest rate which must be applied to the present value in order to arrive at the future value when compounded over the given number of periods
RegexReplaceReplaces all occurrences of a Regular Expression pattern with a string.
RegexSelectReturns first match of regular expression pattern going left to right.
ReplaceThe Replace function replaces all occurrences of a substring with another string.
RightThe Right function returns a string containing a specified number of characters from the right side of a string.
RoundThe Round function rounds a number to a specified number of decimal places.
RoundDownThe RoundDown function rounds a number down to a specified number of decimal places.
RoundUpThe RoundUp function rounds a number up to a specified number of decimal places.
SafeReturns the value of the supplied expression or returns the default value if the expression produces an error.
SecondThe Second function returns the seconds for a given DateTime (0 to 59).
SecondDiffThe SecondDiff function returns the number of seconds between two DateTime values.
SmallestReturns the smallest value from a list of values.
SqrtThe Sqrt function returns the square root of a number.
StartsWithDetermines if a text string or expression starts with another text string or expression.
SumReturns the sum of a specified member or expression across a collection.
TableLookupReturns the value from a table for the first row that satisfies the field matching criteria.
ToBoolThe ToBool function converts an expression to a boolean value.
ToDateThe ToDate function converts an expression to a Date value.
ToDateTimeThe ToDateTime function converts an expression to a DateTime value.
TodayReturns the current date as of the start of rule processing.
ToInnerXmlReturns the inner xml (does not include the outer element) for an Entity or Entity Field.
ToIntThe ToInt function converts an expression to an integer value.
ToJsonReturns the JSON for an Entity or Entity Field.
ToListReturns a list object from a collection.
ToLowerThe ToLower function returns a copy of a string, converted to all lower case.
ToNumberThe ToNumber function converts an expression to a numeric value.
ToStringThe ToString function converts an expression to a string value.
ToTimeThe ToTime function returns a time based on source parameters. The date portion is 1/2/0001.
ToUpperThe ToUpper function returns a copy of a string, converted to all upper case.
ToValueListConstructs value list inline from args.
ToXmlReturns the xml for an Entity or Entity Field.
TrimThe Trim function returns a copy of a string with all leading and trailing spaces removed.
TrimWhitespaceThe TrimWhitespace function removes leading, trailing, and duplicate whitespace from a string.
ValueListLookupLooks up a display name by value from a value list. If the value is not in the value list, null is returned unless a default value is specified.
WeekdayDiffThe WeekdayDiff function returns the number of weekdays between two Date values.
XmlLookupThe XmlLookup function returns the value referenced by an XPath from an XML document or string.
YearReturns the year for a given Date or DateTime.
YearDiffThe YearDiff function returns the number of years between two Date values.