Reflects the current release of Nintex for SharePoint 2016. For your version, please access assistance through the Help button in the product.
This topic describes the runtime functions.
Returns TRUE where both logical arguments are true. If either are false, returns FALSE.
and(boolean1, boolean2)
Returns the average value of a set of values.
avg([set of values])
Returns TRUE where string contains the element.
contains(string,element)
Returns the number of rows in which a control that has a value (not blank) appears within a repeating section.
count(control)
Returns the formatted currency string for the specified value.
currency(value)
Returns the row number of the Repeating Section the control is contained within.
currentRowNumber(Control)
Returns a new date contructed from the specified parameters.
date(day, month, yeah, hours, minutes)
Retuns the date with the specified number of whole days added to it.
dateAddDays(date, daysToAdd)
Returns the date with the specified number of whole hours added to it.
dateAddHours(date, hoursToAdd)
Returns the date with the specified number of whole minutes added to it.
dateAddMinutes(date, minutesToAdd)
Returns the date with the specified number of whole months added to it.
dateAddMonths(date, monthsToAdd)
Returns the number of whole days between date1 and date2.
dateDiffDays(date1, date2)
Returns the number of whole hours between date1 and date2.
dateDiffHours(date1, date2)
Returns the number of whole minutes between date1 and date2.
dateDiffMinutes(date1, date2)
Returns TRUE where element is at the end of string.
endWith(string, element)
Returns TRUE where two items are of equal value.
equals (value1, value2)
Returns the date in the specified format.
formatDate(date, format)
The specified format can incorporate structures such as "dd/MM/yyyy" or "dddd", "dd MMM". The components of these structures include:
| Element | Description | Example (in US date format) |
|---|---|---|
| "dd" | Day of month | 6/15/2009 1:45:30 PM -> 15 |
| "ddd" | Day of week (Single Letter) | 6/15/2009 1:45:30 PM -> M |
| "dddd" | Day of week (Full) | 6/15/2009 1:45:30 PM -> Monday |
| "MM" | Month (Numeric) | 6/15/2009 1:45:30 PM -> 6 |
| "MMM" | Month (Short) | 6/15/2009 1:45:30 PM -> Jun |
| "MMMM" | Month (Full) | 6/15/2009 1:45:30 PM -> June |
| "yyyy" | Year | 6/15/2009 1:45:30 PM -> 2009 |
| "hh" | Hours (12 Hour) | 6/15/2009 1:45:30 PM -> 1 |
| "HH" | Hours (24 hour) | 6/15/2009 1:45:30 PM -> 13 |
| "mm" | Minutes | 6/15/2009 1:45:30 PM -> 45 |
| "tt" | AM or PM | 6/15/2009 1:45:30 PM -> PM |
Alternatively, single character format specifiers can be used.
| Format Specifier | Description | Example (in US date format) |
|---|---|---|
| "d" | Short date pattern | 6/15/2009 1:45:30 PM -> 6/15/2009 |
| "D" | Long date pattern | 6/15/2009 1:45:30 PM -> Monday, June 15, 2009 |
| "M", "m" | Month/day pattern | 6/15/2009 1:45:30 PM -> June 15 |
| "s" | Sortable date/time pattern | 6/15/2009 1:45:30 PM -> 2009-06-15T13:45:30 |
| "t" | Short time pattern | 6/15/2009 1:45:30 PM -> 1:45PM |
| "T" | Long time pattern | 6/15/2009 1:45:30 PM -> 1:45:30PM |
| "Y", "y" | Year month pattern | 6/15/2009 1:45:30 PM -> June, 2009 |
Returns TRUE where value1 is greater than value2.
greaterThan(value1, value2)
Returns TRUE where value1 is greater than or equal to value2.
GreaterThanOrEqual(value1,value2)
if
Checks whether a condition is met, and returns one value if true, and another value if false.
if(logical_test, value_if_true, value_if_false)
Returns TRUE where the collection contains the entire specified element.
inArray(collection, element)
Returns TRUE where the value is a valid date.
isDate(value)
isNullOrEmpty
Returns TRUE where value has no data content.
isNullOrEmpty(value)
Returns TRUE where the value is a valid number.
isNumeric(value)
length
Returns the length of a string.
length(string)
Returns TRUE where value1 is less than value2.
lessThan(value1,value2)
Returns TRUE where value1 is less than or equal to value2.
LessThanOrEqual(value1,value2)
Returns a value form another list based on lookup criteria. For more information, see Lookup function.
lookup("list title","column to filter on", value to filter on, "output column". [multiple values-boolean] , [value data type])
For an explanation on how to use the Lookup function, see Lookup Function.
Returns the maximum value found in a set of values.
max([set of values])
Returns the minimum value found in a set of values.
min([set of values])
Returns the logical reverse of the argument.
not(boolean)
or
Returns TRUE where either logical arguments are true. Returns FALSE when both logical arguments are False.
or(boolean1, boolean2)
Returns the text component of the list item in the lookup control if condition evaluates to TRUE. If FALSE, returns the ID of the list item in the lookup control.
parseLookup([array or single lookup value], [optional bool showText])
Note: A lookup control returns both the ID and text for the selected items in the format "1;Australia". The first part represents the ID of the list item and the second part, the column specified to display in the lookup control as its label. Depending on what you are using the lookup control value for, you will need one part of the value.
For example,
parseLookup(Country) = "Australia"
parseLookup(Country, true) = "Australia"
parseLookup(Country, false) = "1"
Replace part of a string that matches a regular expression pattern (replacePattern) with replacement.
replace(textToModify, replacePattern, replacement)
Returns the number of rows a control appears in within a repeating section.
rows(control)
Returns a value to the nearest number based on a specific number of decimal places.
Round(number, [optional numberOfDecimalPlaces])
Returns TRUE where element is at the beginning of the string.
startsWith(string, element)
Returns a part of the string from the character position start for the specified length in characters. The first character is position 0.
subString(string, start, length)
Returns the result of all the values in a set being added together.
sum([set of values])
Converts a string to lower case.
toLower(string)
Converts a string to title case, with the first letter of each word capitalized.
toTitleCase(string)
Converts a string to upper case.
toUpper(string)
Removes any leading and trailing spaces from a string.
trim(string)
Returns TRUE if the two logins are the same, taking into account differences between the two, such as claims authentication tokens.
userEquals(single login, single login)
Note: SharePoint login names can be the same user even if they have slight differences in the name. When comparing two login names, depending on the source of the login it may be slightly different. The possible sources include a people control, an insert reference token or even the user profile function.
For example: In a claims authentication environment, one source could return "i:0#.w|nintex\kinald" while another may return "nintex\kinald". These are the same user, however one has the with claims token at the start. The userEquals function will ignore the claims prefix and return true when comparing the above logins.
Returns the lookup user profile data from SharePoint for the specified user.
userProfileLookup("domain\login","InternalPropertyName")
Note: The first parameter is a single user login for current SharePoint farm that has a user profile. It would usually be specified either through insert reference or passing the value from a control (ideally a single select people control). The second parameter is the internal name of the user profile property. An example of some of the more common ones are "FirstName", "LastName","HomePhone", "Manager", "Office", "PreferredName", "WorkEmail".