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