Functions - Workflow - English - Foundation 22.1 - OnBase - Premier - external - Standard - Premier - Standard

Workflow

Platform
OnBase
Product
Workflow
Release
Foundation 22.1
License
Premier
Standard

The following functions are supported:

Function

Description

Abs

Returns the absolute of a number.

AddBusinessDays

Adds the specified number of business days to the date based on the life cycle's calendar.

AddDays

Adds the specified number of days to the date.

AddHours

Adds the specified number of hours to the date/time.

AddMinutes

Adds the specified number of minutes to the date/time.

AddSeconds

Adds the specified number of seconds to the date/time.

AddMonths

Adds the specified number of months to the date.

AddYears

Adds the specified number of years to the date.

Append

Appends specified text to the end of the input value.

Note:

This function is supported for arrays of values and single values.

ArrayValue

Returns a single value contained in an array.

The value is returned as the same data type as it is in the array. If a value does not exist, a configured default value is returned.

BusinessDaysDiff

Calculates the number of business days between two dates based on the life cycle's calendar.

Capitalize

Returns string or array of values where the first character of the value is converted to uppercase and all subsequent characters are converted to lowercase.

CapitalizeWords

Returns a string or array of values where the first character of each word is converted to uppercase and all subsequent characters are converted to lowercase.

Captures

Returns all occurrences of strings that the regular expression groups captured.

Ceil

Returns the smallest whole number greater than or equal to the specified number.

CDate

Converts the value to a date/time data type.

Note:

This function is supported for arrays of values and single values.

CDbl

Converts the value to a double data type.

If the input value is non-numeric, returns a value of 0.

Note:

This function is supported for arrays of values and single values.

CDec

Converts the value to a decimal data type.

If the input value is non-numeric, returns a value of 0.

Note:

This function is supported for arrays of values and single values.

CInt

Converts the value to an integer data type.

If the input value is non-numeric, returns a value of 0.

Note:

When converting a floating point number value, the value is rounded to its nearest whole number. If a value is non-numeric, it will evaluate to a 0 value.

Note:

This function is supported for arrays of values and single values.

CLng

Converts the value to a long data type.

If the input value is non-numeric, returns a value of 0.

Note:

When converting a floating point number value, the value is rounded to its nearest whole number. If a value is non-numeric, it will evaluate to a 0 value.

Note:

This function is supported for arrays of values and single values.

CombineArray

Joins an array of values into a single string, including a custom delimiter.

ConvWildcardToRegEx

Converts a string containing wildcard characters into a regular expression string.

Tip:

Combine this function with other functions, such as IsMatch, to use the resulting regular expression for evaluation.

Count

Returns the count of elements to determine the number of Keyword Values that exist on an item for a specified Keyword Type.

The standard formatting for this function is as follows:

Count(Value)

Optionally, the regular expression parameter can be added. When used, the function returns the number of values that matches the regular expression. The function should be formatted as follows:

Count(Value; RegularExpression)

An optional IgnoreCase parameter can also be used. The parameter can be set to TRUE to ignore the case of the regular expression or FALSE to match the case of the regular expression. The function should be formatted as follows:

Count(Value; RegularExpression; IgnoreCase)

CStr

Converts the value to a string data type.

Note:

This function is supported for arrays of values and single values.

Date

Creates a date value.

Day

Gets the day of the month of the specified date.

DaysDiff

Calculates the number of days between two dates.

EscapeRegex

Escapes special characters by replacing them with their escape codes. This function is only supported for use with string values and functions that return strings.

Note:

The following characters can be escaped using this function: \, *, +, ?, |, {, [, (, ^, $, ., #, and white space.

Eval

Evaluates the specified expression.

This function also allows you to evaluate the value stored in a property or Keyword.

Floor

Returns the largest whole number less than or equal to the specified number.

Format

Returns a string formatted according to the passed expression. For the second parameter, any valid format string that can be passed to the Visual Basic format function can be used.

Note:

This function is deprecated. The FormatEx function should be used instead.

FormatDateTime

Returns a date or time string formatted according to the instructions contained in the format string expression.

Supported format strings can be found at the following locations:

http://msdn.microsoft.com/en-us/library/az4se3k1.aspx

http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx

FormatEx

Returns a numeric string formatted according to the instructions contained in the format string expression.

Supported format strings can be found at the following locations:

http://msdn.microsoft.com/en-us/library/dwhawy9k.aspx

http://msdn.microsoft.com/en-us/library/0c899ak8.aspx

GetSegment

Returns a value in a segmented string.

Hour

Gets the hour of a specified date/time.

IIf

Returns one of two values, depending on the evaluation of an expression.

IndexOf

Returns the zero-based index of the value in the array, or -1 if the value is not in the array.

Note:

If the values in the array are strings, by default the comparison is case-sensitive. To make the comparison case-insensitive, the optional parameter ignoreCase can be appended to the function.

InStr

Returns a zero-based integer specifying the start position of the first occurrence of one string within another.

InStrRev

Returns a zero-based integer specifying the start position of the last occurrence of one string within another.

IsBusinessDay

Returns a Boolean value that indicates whether the passed date value is considered a business day according to the configured business calendar. A day is considered to be a business day if the business calendar has a work period for that day and the day is not a holiday.

Note:

The business calendar assigned to the life cycle containing the configured Action or Rule is used to determine business days.

IsGroupLoggedIn

Returns true if one or more of the members in the specified user group is logged in.

IsInDataSet

Returns a Boolean value that indicates whether the passed value is in a Data Set. This function will determine whether the specified value matches a value in the specified Keyword Type's Data Set. The Keyword Type name must be entered in double quotations marks. The value specified should be a variable configured for the current rule engine queue. If the specified Keyword Type is not configured to use Data Sets, NULL is returned and the condition will not be evaluated.

IsInDataSetEx

Returns a Boolean value that indicates whether the passed value is in the specified document key and also allows case-sensitive comparisons.

This function will determine whether the specified value matches a value in the specified Keyword Type's Data Set. The Keyword Type name must be entered in double quotations marks. The value specified should be a variable configured for the current rule engine queue. If the specified Keyword Type is not configured to use Data Sets, NULL is returned and the condition will not be evaluated.

This also allows you to make a case-sensitive or case-insensitive comparison. You can turn case sensitivity on by specifying true for the parameter. You can turn case sensitivity off by specifying false for the parameter.

Note:

When comparing alphanumeric Keyword Types and/or property values, an implicit conversion will occur during the comparison that will attempt to convert the incoming value into its representative data type in order to execute a proper comparison. This implicit conversion will attempt to infer if the incoming value represents a number, a date, or a string. In the event that the incoming value is formatted in such a way that the value can be inferred as both a numeric value or a date value, the numeric value will take precedence during the comparison.

Note:

When comparing different data types (for example, comparing alphanumeric to a currency data type), any formatting differences could impact the evaluation of the values. To ensure the accuracy of any evaluation, it is a best practice to always compared values that are of the same data type.

IsMatch

Indicates whether the regular expression finds a match in the specified string.

IsNull

Returns a Boolean indicating if the value contains no data.

IsUserLoggedIn

Returns true if the specified user is logged in.

Lcase

Converts the string value to lower case.

Left

Returns the first x characters in a string value.

Len

Returns the length of a string value.

LTrim

Removes leading spaces from a string.

Match

Returns the first occurrence of a string that matches the supplied regular expression.

Matches

Returns all occurrences of strings that match the supplied regular expression.

Max

Returns the larger of two numbers.

Mid

Returns a substring of a string value.

Min

Returns the smaller of two numbers.

Minute

Gets the minute of a specified date/time.

Month

Gets the month of the specified date.

Now

Returns the current date/time.

PadLeft

Returns a string that is left padded by the specified character for the specified length.

PadRight

Returns a string that is right padded by the specified character for the specified length.

Pow

Returns a specified number raised to the specified power.

Prepend

Prepends specified text to the beginning of the input value.

Note:

This function is supported for arrays of values and single values.

Replace

Replaces all occurrences of a string that match the regular expression with an alternate string.

The following syntax is used:

Replace( string; regex_pattern; replacement_string; ignore_case)

String is the string you want to replace. regex_pattern represents the part of the string you want to replace. replacement_string is the string of text that will replace the specified string. If you want the string to be case sensitive, enter false for the ignore_case parameter. If you want the string to not be case sensitive, enter true for the ignore_case parameter.

The following is an example:

Replace( "123abc456def"; "[0-9]+"; "xyz"; true )

The resulting text string would be: "xyzabcxyzdef"

Note:

Special characters included in the strings, such as ( and ), must be escaped.

Note:

This is not supported in the Classic Client Workflow interface.

Right

Returns the last x characters in a string value.

Rnd

Returns a random number between 0.0 and 1.0.

RndInt

Returns a random number from the minimum inclusive value to the maximum exclusive value.

Round

Returns the number with the specified precision nearest the specified value.

RTrim

Removes trailing spaces from a string.

Second

Gets the seconds of the specified date/time.

Sort

Returns a sorted list of values. If you want the results to be returned in ascending order, enter true as the parameter. If you want the results to be returned in descending order, enter false as the parameter.

Split

Splits a value into an array by specifying a custom delimiter.

Sqrt

Returns the square root of a specified number.

String

Returns a string that contains the specified character repeated at the specified length.

Sum

Returns the sum of elements. This can be used to calculate the sum of all values for a specified Keyword or property. The function must be able to convert the values to a decimal.

If the specified Keyword or property is not present on the item, the function returns a value of 0.

If the specified Keyword or property contains only a single value, that value is returned as the sum.

If there are multiple instances of the specified Keyword or if the property contains an array of values, the function will return the sum of all values.

Trim

Removes leading and trailing spaces from a string.

Truncate

Calculates the integral part of a specified number, i.e. removes all numbers after the decimal.

The following is an example:

Truncate(123.45)

This results in 123.

Ucase

Converts the string value to upper case.

Weekday

Returns a number that represents a day of the week. The following numbers represent the following days:

0 = Sunday

1 = Monday

2 = Tuesday

3 = Wednesday

4 = Thursday

5 = Friday

6 = Saturday

WeekdayName

Returns the name of a specified day of the week. The function should be formatted as follows:

WeekdayName(DayOfWeek; Abbreviate)

Replace DayOfWeek with the number that corresponds to the day of the week:

0 = Sunday

1 = Monday

2 = Tuesday

3 = Wednesday

4 = Thursday

5 = Friday

6 = Saturday

Replace Abbreviate with either true or false. True will abbreviate the name of the day of the week, and false will return the full name of the day of the week. For example:

WeekdayName(2; true) returns the value "Tue", and WeekdayName(2; false) returns the value "Tuesday".

XPath

Used for retrieving the value from an XML document currently being evaluated in the rules engine.

Year

Gets the year of the specified date.

The following constants can be used:

Constant

Description

DQuote

Represents a double quote character.

NewLine

Represents a newline character.

Note:

Function parameters are separated by semi-colons.

The following symbols can be used:

Symbol

Description

%K

Displays a configured Keyword Value.

%M

Extracts metadata values from items. This includes attribute values from WorkView objects or a field values from an Entity item.

%M must be followed by the metadata value you want to extract. For example, if you want to extract the value of a WorkView attribute called Name, it would be %MName.

The token strings can contain nested expressions. Example, a nested WorkView attribute: %MVendor.Buyer.Name.

Note:

The use of floating point numbers lower than 0.0001 is not recommended due to being subject to possible rounding errors when retrieving values.

%V###

Displays the value of a configured Workflow property. For example, to display the value for the property “Color”, this symbol would be configured %VColor.

Note:

In the Core-based interfaces, if a property contains an array of values, all property values will be used.

Note:

If a property name has spaces, using %V to display the property value will not preserve the spaces, and therefore, the property will not be correctly identified.

Note:

%M [item metadata value] is not supported in the Classic OnBase Client interface or the Core-Based OnBase Client interface.