Rule specification assets > Rule statement configuration > Function descriptions
  

Function descriptions

A function expression is a logical element in a condition or an action. A function expression reads the input data that you specify, performs a calculation on the input data, and returns a result.
When you add a function expression to a condition, the function expression performs the calculation and returns the result to the condition. The condition uses the rule statement operator to determine the next step. When you add a function expression to an action, the action performs the calculation and returns the result as the rule statement output.
To add a function expression to a condition, use the Function options in the Define Condition dialog box. To add a function expression to an action, use the Function options in the Define Action dialog box.
You can add the following function expressions to a condition or an action:
Add to Date
Reads a date value and adds a numeric value to an element in the date. Enter the value to add to the element, or select an input that contains the value to add. Select the function expression in a condition or an action.
Choose
Reads input data that contains multiple values and selects the value at the position that you specify. Select the function expression in a condition or an action.
For example, the following string contains values at four positions:
Q1, Q2, Q3, Q4
You can enter a position, or you can select an input to specify a position.
Concatenate
Reads two inputs that you select and concatenates the values from the inputs. Select the function expression in a condition or an action.
Convert to Date
Converts a value in a string data type to a date/time data type. You identify the input data format when you configure the function expression. Select the function expression in a condition or an action.
Convert to Float
Converts a value in a string data type to a float data type. Select the function expression in a condition or an action.
Convert to Integer
Converts a string or numeric value to an integer data type. Select the function expression in a condition or an action.
You can set the function expression to truncate an input value at the decimal point or to round an input value to the nearest integer.
The function expression treats an alphanumeric value that begins with an alphabetical character as a null value and returns 0 as the output. The function expression treats an alphanumeric string that begins with a digit as a numeric value and truncates the value at the first alphabetical character.
Date Difference
Reads date values from two inputs that you select and calculates the numeric difference between the dates. You select the date element that the function expression uses to measure the difference. Enter the date element, or select an input that contains the date element. Select the function expression in a condition or an action.
Date Part
Reads a date from an input and identifies the numeric value of a date element that you specify. Enter the date element, or select an input that contains the date element. Select the function expression in a condition or an action.
Date Time
Uses multiple values to specify a date and time. Enter a value for each date element, or select an input to add a value to each element. Select the function expression in a condition or an action.
Greatest
Reads two or more values and identifies the highest value. Enter the values, or select rule set inputs to add each value. You can specify numeric values, alphabetic values, or date values. Select the function expression in a condition or an action.
When you specify numeric values, the function expression identifies the highest number.
When you specify alphabetic values, the function expression identifies the value that is last in alphabetic order.
When you specify date values, the function expression identifies the latest date.
Is Date
Returns a value that indicates whether the input string is valid date. Select the function expression in a condition or an action.
Is Number
Returns a value that indicates whether the input string is valid number. Select the function expression in a condition or an action.
Is Spaces
Returns a value that indicates whether the input string contains character spaces only. Select the function expression in a condition or an action.
Last Day
Reads a date value from an input and identifies the last day in the month that the date specifies. The function expression identifies the last day as a numeric value. Select the function expression in a condition or an action.
Least
Reads two or more values and identifies the lowest value. Enter the values, or select rule set inputs to add each value. You can specify numeric values, alphabetic values, or date values. Select the function expression in a condition or an action.
When you specify numeric values, the function expression identifies the lowest number.
When you specify alphabetic values, the function expression identifies the value that is first in alphabetic order.
When you specify date values, the function expression identifies the earliest date.
Length
Reads an input value and calculates the number of characters in the value. Select the function expression in a condition or an action.
Lower
Reads an input string and returns the lowercase version of the characters in the string. Select the function expression in a condition.
Mod
Returns the remainder of a division operation. Select the function expression in a condition or an action.
Null
Reads an input value and determines if the value is null. Select the function expression in a condition or an action.
Replace Character
Reads an input value and replaces a sequence of characters in the value with a sequence that you specify. Select the function expression in a condition.
Replace String
Reads an input value and replaces the value with a value that you specify. Select the function expression in a condition.
Reverse
Reads an input value and reverses the order of the characters in the value. Select the function expression in a condition or an action.
Substring
Returns a substring from an input value of a length that you specify, beginning at a position that you specify. Select a string or numeric data type as an input. Select the function expression in a condition or an action.
To Char
Converts a numeric value or a date value to a string value. Select the function expression in a condition or an action.
Truncate
Reads an input value and truncates the value to the number of places that you specify. The function expression reads a numeric value. Enter the value, or select an input to add the value. Select the function expression in a condition or an action.
Upper
Reads an input string and returns the uppercase version of the characters in the string. Select the function expression in a condition.