All Functions
All functions listed alphabetically.
| All Function | Description |
|---|---|
| Abs | Returns the absolute value of a numeric expression. |
| AddDays | The AddDays function adds a specified number of days to a DateTime value. |
| AddHours | The AddHours function adds a specified number of hours to a DateTime value. |
| AddMilliseconds | The AddMilliseconds function adds a specified number of milliseconds to a DateTime value. |
| AddMinutes | The AddMinutes function adds a specified number of minutes to a DateTime value. |
| AddMonths | The AddMonths function adds a specified number of months to a DateTime value. |
| AddSeconds | The AddSeconds function adds a specified number of seconds to a DateTime value. |
| AddWeekdays | The AddWeekdays function adds a specified number of weekdays to a DateTime value. |
| AddYears | The AddYears function adds a specified number of years to a DateTime value. |
| AllAreFalse | The AllAreFalse function returns true if all of the provided conditions is false. Otherwise false. |
| AllAreTrue | Returns true if all of the provided conditions are true. Otherwise false. |
| AnyAreFalse | The AnyAreFalse function returns true if any of the provided conditions is false. Otherwise false. |
| AnyAreTrue | Returns true if any of the provided conditions are true. Otherwise false. |
| Average | Returns the average of a specified field or expression across a collection. |
| Avg | Returns the average of a specified field or expression across a collection. |
| BankRound | Returns the number rounded to the number of decimal places using the rules of bankers rounding. |
| BuildDate | The BuildDate function returns a date from a specified year, month, and day. |
| Chr | Returns the character associated with the specified character code. |
| CollectionLookup | The CollectionLooup function returns the value of a field or expression for the first collection member that satisfies a given filter expression. |
| Concat | Generates a string concatenation of two or more expressions. |
| Concat | Generates a string concatenation of two or more expressions. |
| Contains | Determines if a text string or expression contains another text string or expression. |
| Count | The Count function returns the number of members in a collection. |
| Current | Returns the value of a field within the context of current expression. |
| CurrentContext | Returns the value of a field within the context of current expression. |
| Day | Returns the day of the month for a given Date or DateTime. |
| DayDiff | The DayDiff function returns the number of days between two Date values. |
| DayOfWeek | Returns the day of the week with 0 = Sunday and 6 = Saturday. |
| DayOfYear | Returns the day of the year, 1 = 1/1 and 365(366) = 12/31. |
| DaysInMonth | The DaysInMonth function returns the number of days in the month. |
| DaysInYear | Returns the number of days in the year. |
| Divide | Divides the value of one numeric expression by another. |
| EndsWith | Determines if a text string or expression ends with another text string or expression. |
| EqualTo | Returns true if two expressions are equal. |
| EscapeJson | The EscapeJson function replaces invalid JSON characters (backspace, form feed, newline, carriage return, tab, double quote, and backslash) in a string with their valid equivalent. |
| EscapeXml | The EscapeXml function replaces invalid XML characters (ampersand, less than, greater than, quote, and apostrophe) in a string with their valid XML equivalent. |
| Eval | Returns the value of evaluating the specified value as an expression. |
| Exp | The Exp function returns e raised to a given power. |
| Format | The Format function formats a numeric or date expression. |
| FV | Returns the end-of-period future value for a series of payments given the interest rate, number of periods, payment amount, and initial principal |
| GetAttribute | Returns the attribute value for an element as specified by the engine attribute for it. |
| GetDefault | Returns the default value of the element. |
| GetElementId | Returns the element id of the element. |
| GetEntityId | Returns the EntitiyID for the element. |
| GetEntityName | Returns the name of the entity. |
| GetFieldValueList | Gets specified value list by field name. |
| GetFirst | The GetFirst function returns the first collection member that satisfies a given filter expression. |
| GetFirstValue | Returns 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. |
| GetIndex | Returns 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. |
| GetLast | The GetLast function returns the last collection member that satisfies a given filter expression. |
| GetLastValue | Returns 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. |
| GetLocalDateTime | Returns a datetime value having Local kind. |
| GetMember | Returns the first member that matches the filter criteria. |
| GetMemberByIndex | Returns the member at an index in a collection which can be ordered and filtered using filter expression. |
| GetMemberValue | The GetMemberValue function returns the specified field value of the first collection member that satisfies a given filter criteria. |
| GetMemberValueByIndex | Returns the specified field value of member at an index in collection which can be ordered and filtered using filter expression. |
| GetName | Returns the name of the element. |
| GetUnspecifiedDateTime | Returns a datetime value having an Unspecified kind. |
| GetUtcDateTime | Returns a datetime value having UTC kind. |
| GetValueList | Gets specified value list by DataElement name. |
| GetXPath | Returns xpath of the element. |
| GreaterThan | Returns true if the first expression is greater than the second expression. |
| GreaterThanOrEqual | Returns true if the first expression is greater than or equal to the second expression. |
| HasWhitespace | The HasWhitespace function returns true if a given string starts with, ends with, or contains duplicate whitespace. |
| Hour | The Hour function returns the hour of the day for a given DateTime (0 to 23). |
| HourDiff | The HourDiff function returns the number of hours between two DateTime values. |
| If | The If function returns one of two values, depending on a given condition. |
| IfCase | The IfCase function compares a test value against a list of values, returning the result from the first matching pair. |
| IfChain | The IfChain function returns the return value from the first true condition in a list. |
| Instr | The Instr function returns the position of the first occurrence of one string within another string. |
| InvokeEntityMethod | Returns the value (if any) of an instance method call on (an defined by) an entity. |
| IPMT | Returns the end-of-period interest payment for given present value at specified rate for specified period. |
| IsBetween | Returns true if a value is equal to or between two boundary values. |
| IsClassification | Returns true the given field meets the criteria to belong to the given classification. |
| IsDate | The IsDate function determines if an expression is a valid Date (or a DateTime with a zero time offset). |
| IsDateTime | The IsDateTime function determines if an expression is a valid DateTime. |
| IsInvalid | Returns true if the element is invalid. |
| IsInValueList | Returns true if the given value is contained in the specified value list, otherwise returns false. |
| IsLeapYear | The IsLeapYear function returns true if the year is a leap year. |
| IsLocalDateTime | Returns true if the expression is a valid Local kind datetime. |
| IsMatch | Determines if a given value is found in a list of values. |
| IsNotNullOrEmpty | The IsNotNullOrEmpty function returns true if a field is not null or empty. |
| IsNull | The IsNull function returns true if a field is null. |
| IsNullOrEmpty | The IsNullOrEmpty function returns true if a field is null or empty. |
| IsNumeric | Returns true if a value is or can be converted to a number without error. |
| IsRegexMatch | Determines if an expression matches a Regular Expression pattern. |
| IsUnspecifiedDateTime | Returns true if the expression is a valid unspecified kind datetime. |
| IsUtcDateTime | Returns true if the expression is a valid UTC kind datetime. |
| IsValid | Returns true if the element is valid. |
| IsWeekday | The IsWeekday function returns true if a given DateTime is not a Saturday or Sunday. |
| IsWeekend | Returns true if the given date is a Saturday or Sunday. |
| IsWildcardMatch | Determines if an expression matches an DOS-style wildcard expression. |
| JsonLookup | The 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. |
| Largest | Returns the largest value in a list of values. |
| Left | The Left function returns a string containing a specified number of characters from the left side of a string. |
| Len | Returns the length of a string. |
| Length | Returns the length of a string. |
| LessThan | Returns true if the first expression is less than the second expression. |
| LessThanOrEqual | Returns true if the first expression is less than or equal to the second expression. |
| Log | Returns the natural (base e) logarithm of a specified number. |
| Lookup | Returns the value from a table for the first row that satisfies the filter. |
| Max | Returns largest value of a member field or expression across a collection. |
| Mid | The Mid function returns a substring of a string. |
| Millisecond | The Millisecond function returns the milliseconds for a given DateTime (0 to 999). |
| MillisecondDiff | The MillisecondDiff function returns the number of milliseconds between two DateTime values. |
| Min | Returns smallest value of a member field or expression across a collection. |
| Minus | Subtracts the value of one numeric expression from another. |
| Minute | The Minute function returns the minute of the hour for a given DateTime (0 to 59). |
| MinuteDiff | The MinuteDiff function returns the number of minutes between two DateTime values. |
| Mod | Divides two numbers and returns only the remainder. |
| Month | Returns the month for a given Date or DateTime. |
| MonthDiff | The MonthDiff function returns the number of months between two Date values. |
| Multiply | Multiplies the value of one numeric expression by another. |
| NoneAreFalse | The NoneAreFalse function returns true if none of the provided conditions is false. Otherwise false. |
| NoneAreTrue | The NoneAreTrue function returns true if none of the provided conditions is true. Otherwise false. |
| Not | The Not function performs logical negation. |
| NotEqualTo | Return true if two expressions are not equal. |
| NotEqualTo | Return true if two expressions are not equal. |
| Now | The Now function returns the current date and time in the local time zone, as of the start of rule processing. |
| NumberOfFalse | The NumberOfFalse function returns the number of provided conditions that evaluate as false. |
| NumberOfTrue | The NumberOfTrue function returns the number of provided conditions that evaluate as true. |
| NumDigits | Returns the number of digits in a given number, not counting trailing zeros to the right of the decimal point nor any leading zeros. |
| NumFracDigits | Returns the number of digits in a given number that appear to the right of the decimal point, not counting trailing zeros. |
| NumIntDigits | Returns the number of digits in a given number that appear to the left of the decimal point, not counting preceding zeros. |
| Outer | Returns the value of a field within the outer context of an aggregate expression. |
| OuterContext | Returns the value of a field within the outer context of an aggregate expression. |
| Percent | The Percent function returns (value * percent) / 100.0. |
| Plus | Adds the value of one numeric expression to another. |
| PMT | Returns 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) |
| Power | Takes the value of one numeric expression to the power of the exponent value. |
| PPMT | Returns the end-of-period principal payment for given present value at specified rate for specified period. |
| ProperCase | The 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. |
| PV | Returns 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 |
| QueryToList | Gets value list from Query. |
| Random | Returns a random integer between the specified minimum and maximum values. |
| Rate | Returns 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 |
| RegexReplace | Replaces all occurrences of a Regular Expression pattern with a string. |
| RegexSelect | Returns first match of regular expression pattern going left to right. |
| Replace | The Replace function replaces all occurrences of a substring with another string. |
| Right | The Right function returns a string containing a specified number of characters from the right side of a string. |
| Round | The Round function rounds a number to a specified number of decimal places. |
| RoundDown | The RoundDown function rounds a number down to a specified number of decimal places. |
| RoundUp | The RoundUp function rounds a number up to a specified number of decimal places. |
| Safe | Returns the value of the supplied expression or returns the default value if the expression produces an error. |
| Second | The Second function returns the seconds for a given DateTime (0 to 59). |
| SecondDiff | The SecondDiff function returns the number of seconds between two DateTime values. |
| Smallest | Returns the smallest value from a list of values. |
| Sqrt | The Sqrt function returns the square root of a number. |
| StartsWith | Determines if a text string or expression starts with another text string or expression. |
| Sum | Returns the sum of a specified member or expression across a collection. |
| TableLookup | Returns the value from a table for the first row that satisfies the field matching criteria. |
| ToBool | The ToBool function converts an expression to a boolean value. |
| ToDate | The ToDate function converts an expression to a Date value. |
| ToDateTime | The ToDateTime function converts an expression to a DateTime value. |
| Today | Returns the current date as of the start of rule processing. |
| ToInnerXml | Returns the inner xml (does not include the outer element) for an Entity or Entity Field. |
| ToInt | The ToInt function converts an expression to an integer value. |
| ToJson | Returns the JSON for an Entity or Entity Field. |
| ToList | Returns a list object from a collection. |
| ToLower | The ToLower function returns a copy of a string, converted to all lower case. |
| ToNumber | The ToNumber function converts an expression to a numeric value. |
| ToString | The ToString function converts an expression to a string value. |
| ToTime | The ToTime function returns a time based on source parameters. The date portion is 1/2/0001. |
| ToUpper | The ToUpper function returns a copy of a string, converted to all upper case. |
| ToValueList | Constructs value list inline from args. |
| ToXml | Returns the xml for an Entity or Entity Field. |
| Trim | The Trim function returns a copy of a string with all leading and trailing spaces removed. |
| TrimWhitespace | The TrimWhitespace function removes leading, trailing, and duplicate whitespace from a string. |
| ValueListLookup | Looks 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. |
| WeekdayDiff | The WeekdayDiff function returns the number of weekdays between two Date values. |
| XmlLookup | The XmlLookup function returns the value referenced by an XPath from an XML document or string. |
| Year | Returns the year for a given Date or DateTime. |
| YearDiff | The YearDiff function returns the number of years between two Date values. |