Expression Builder
The Expression Builder is a convenient list of various pieces of information you can use in your botflow A file that stores the actions and variables designed to automate tasks..
The items contained within the Expression Builder are referred to as tokens A specific letter used by Nintex RPA to communicate with an external application when a Nintex RPA action runs..
Note: If the information you need is not available in the Expression Builder, try using the Formula action.
Using the Expression Builder
The Expression Builder provides these two means to build expressions.
Ellipses
The Ellipses button provides access to only certain tokens that can store new information, such as a variable or a data field.
Magic Wand
The Magic Wand button provides access to a list of tokens applicable to the selected action type.
In the Expression Builder window:
- Select a view from the Items list.
- Click on the desired item(s) to be added to the expression.
- Click the OK button to save the expression.
The Items list shows the items applicable for the selected action type.
Expression Builder category descriptions
Category overview
The Expression Builder provides access to a wide variety of information arranged in the following categories. Click a category link for additional information about that category.
| Category | Description |
|---|---|
|
Information about the running instance of the Foxtrot application. |
|
| Botflow | Information about the current botflow. |
|
Information about the local computer and the network environment. |
|
|
Fields in the currently loaded database. |
|
|
Various date and time information. |
|
|
Various system files and folders. |
|
| Formula |
Provides access to parsing and data manipulation tools. |
|
Information about the image open in the Image Editor. |
|
|
Insert |
Provides a way to insert an image. (Only available when creating certain targets). |
|
The various mnemonic keys that can be sent to the target emulator. (Only available when creating a Send Value action.) |
|
|
Provides access to available Lists created in the botflow. |
|
|
Loop |
Information about the current loop. (Only available when inside a loop.) |
|
Randomly generated information. |
|
| RPA Central | Information about the work sent from Nintex RPA Central. |
|
Variables found in the botflow. |
Application
| Item Name | Description | Example Value |
|---|---|---|
|
App Directory |
The directory from which this application is running. |
"C:\Program Files\Foxtrot Suite" |
|
App File |
This application's executable file name. |
"Foxtrot.exe" |
|
App Name |
The name of this application. |
"Nintex RPA" |
|
App Path |
This application's full file path. |
"C:\Program Files\Foxtrot Suite\Foxtrot.exe" |
|
App Permission Level |
The user's permission level for this application. |
"User" |
|
App Username |
The username currently logged into this application. |
"default user" |
|
App Version |
The full version number of this application. |
"v12.0.0" |
|
App Version (Major) |
The major version number of this application. |
"12" |
|
App V ersion (Minor) |
The minor version number of this application. |
"0" |
|
App Version (Revision) |
The revision number of this application. |
"0" |
|
Default Database Directory |
The user's default Database directory. |
"C:\Program Files\Foxtrot Suite" |
|
Default File Folder Action Directory |
The user's default File & Folder Action directory. |
"C:\Program Files\Foxtrot Suite" |
|
Default Botflow Directory |
The user's default Botflow directory. |
"C:\Program Files\Foxtrot Suite" |
|
Default Templates Directory |
The user's default Templates directory. |
"C:\Program Files\Foxtrot Suite" |
|
Default VBScript File Directory |
The user's default VBScript file directory. |
"C:\Program Files\Foxtrot Suite" |
|
Is Bot |
Indicates if this application is running in Bot mode. |
"False" |
|
License Directory |
The directory from which this application acquires a license. |
"C:\Program Files\Foxtrot Suite" |
|
Mode |
The current presentation mode of this application. |
"Full" |
|
Product Key |
The current product key in use. |
"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" |
|
Session ID |
The Session ID identifying this session. |
"74" |
|
Session Start Time |
The time this application session started. |
"09/13/10 11:18:10" |
|
Support Email |
The product support email address. |
|
|
Support Phone |
The product support phone number. |
|
|
Support Website |
The product support website address. |
|
Botflow
| Item Name | Description | Example Value |
|---|---|---|
|
After Task Exists |
Indicates if an After Task exists. |
"True" |
|
After Task Name |
The name of the After Task. |
"MyAfterTask" |
|
Before Task Exists |
Indicates if a Before Task exists. |
"True" |
|
Before Task Name |
The name of the Before Task. |
"MyBeforeTask" |
|
Calling Task |
The name of the calling Task. |
"New Task" |
|
Current Record Number |
The current record number in the current database. |
"40" |
|
Current Task Name |
The name of the current Task. |
"New Task" |
|
Database Directory |
The current Database's folder location. |
"C:\Program Files\Foxtrot Suite" |
|
Database File |
The current Database's file name. |
"TestData.dbf" |
|
Database Path |
The current Database's full file path. |
"C:\Program Files\Foxtrot Suite\TestData.dbf" |
|
Error Loc Line No |
The line number in the task where the last error occurred in the Botflow. |
"3" |
|
Error Loc Task Name |
The name of the task where the last error occurred in the Botflow. |
"New Task" |
|
Error Task Exists |
Indicates if an Error Task exists. |
"True" |
|
Error Task Name |
The name of the current Error Task. |
"ErrHandler" |
|
Is After Task On |
Indicates if the After Task is turned on. |
"True" |
|
Is Before Task On |
Indicates if the Before Task is turned on. |
"True" |
|
Is Current Record Off |
Indicates if the current record is turned off. |
"False" |
|
Is Current Record On |
Indicates if the current record is turned on. |
"True" |
|
Is Ignore Breakpoints |
Indicates if the botflow is ignoring breakpoints. |
"False" |
|
Is Running |
Indicates if the botflow is running. |
"False" |
|
Is Silent |
Indicates if the botflow is running in Silent mode. |
"False" |
|
Botflow Directory |
The current Botflow's folder location. |
"C:\Program Files\Foxtrot Suite" |
|
Botflow File |
The current Botflow's file name. |
"MyBotflow.rpa" |
|
Botflow Name |
The name of the current Botflow. |
"MyBotflow" |
|
Botflow Path |
The current Botflow's full file path. |
"C:\Program Files\Foxtrot Suite\MyBotflow.rpa" |
|
Records Remaining |
The number of remaining records in the current database. |
"11" |
|
Run Speed |
The current run speed setting (1-12). |
"5" |
|
Startup Task Name |
The name of the current Startup Task. |
"New Task" |
|
Total Off Records |
The total number of off records in the current database. |
"10" |
|
Total On Records |
The total number of on records in the current database. |
"40" |
|
Total Records |
The total number of records in the current database. |
"50" |
Computer
Displays information about the local computer and the network environment.
| Item Name | Description | Example Value |
|---|---|---|
|
Computer Name |
The computer name. |
"MYPC" |
|
Computer Up Time |
The computer up time in dd:hh:mm:ss format. |
"3:9:31:33" |
|
Core Count |
The total number of cores on the workstation. |
"2" |
|
Domain Name |
The domain name. |
"MYDOMAIN" |
|
IE Name |
The name of Internet Explorer installed on this computer. |
"Internet Explorer 11" |
|
IE Version |
The version of Internet Explorer installed on this computer. |
"11.0.9600.18376" |
|
Is Caps Lock On |
Indicates if the Caps Lock is turned on. |
"False" |
|
Is Local Admin |
Indicates if the user is a local administrator. |
"False" |
|
Is Muted |
Indicates if the computer speakers are muted. |
"False" |
|
Is Num Lock On |
Indicates if the Number Lock is turned on. |
"True" |
|
Is Scroll Lock On |
Indicates if the Scroll Lock is turned on. |
"False" |
|
Is Workstation Locked |
Indicates if the workstation is locked. |
"False" |
|
Local IP Address |
The IP address of the local computer. |
"192.168.10.207" |
|
Local IPv6 Address |
The IPv6 address of the local computer. |
"fe80::112a:dee3:5dd7:9eda%11" |
|
Monitor Count |
The number of monitors on the local computer. |
"2" |
|
OS Bitness |
The bitness of the operating system installed on this computer. |
"64" |
|
OS Name |
The name of the operating system installed on this computer. |
"Windows 10 Professional" |
|
OS Version |
The version of the operating system installed on this computer. |
"5.1.2600.196608" |
|
Screen Resolution |
The primary screen resolution. |
"1920x1080" |
|
Screen Resolution Height |
The primary screen resolution height. |
"1080" |
|
Screen Resolution Width |
The primary screen resolution width. |
"1920" |
|
Volume |
The current computer volume level (0-100) |
"80" |
|
Windows Clipboard Value |
The current Windows clipboard value. |
"test" |
|
Windows Username |
The current Windows username. |
"jdoe" |
Data
The Data view displays the fields in your database. If no database is loaded, this list will be blank.
Date & Time
| Item Name | Description | Example Value |
|---|---|---|
|
Date |
Current date. |
"12/6/2016" |
|
DateTime Stamp |
Current date and time. |
"12/6/2016 9:04:52 AM" |
|
Day |
Current day number. |
"2" |
|
Day (Zero-Filled) |
Current day number, zero-filled. |
"02" |
|
Day Abbreviation |
Current day abbreviation. |
"Tue" |
|
Day Name |
Current day name. |
"Tuesday" |
|
Day of Week |
Current week day number. |
"3" |
|
First Week Day Abbreviation In Month |
First week day abbreviation in the current month. |
"Mon" |
|
First Week Day Date In Month |
First week day date in the current month. |
"12/01/2016" |
|
First Week Day In Month |
First week day number in the current month. |
"1" |
|
First Week Day Name In Month |
First week day name in the current month. |
"Monday" |
|
First Weekend Day Abbreviation In Month |
First weekend day abbreviation in the current month. |
"Sat" |
|
First Weekend Day Date In Month |
First weekend day date in the current month. |
"10/04/2014" |
|
First Weekend Day In Month |
First weekend day number in the current month. |
"6" |
|
First Weekend Day Name In Month |
First weekend day name in the current month. |
"Saturday" |
|
Hour |
Current hour (1-12). |
"9" |
|
Hour (Military) |
Current military hour (0-23). |
"9" |
|
Hour (Military, Zero-Filled) |
Current military hour (0-23), zero-filled. |
"09" |
|
Hour (Zero-Filled) |
Current hour (1-12), zero-filled. |
"09" |
|
Is First Full Week In Month |
Indicates if this week is the first full week in the current month. |
"False" |
|
Is First Week Day In Month |
Indicates if today is the first week day in the current month. |
"False" |
|
Is First Week In Month |
Indicates if this week is the first week in the current month. |
"False" |
|
Is First Weekend Day In Month |
Indicates if today is the first weekend day in the current month. |
"False" |
|
Is Friday |
Indicates if the current day is Friday. |
"False" |
|
Is Full Week In Month |
Indicates if the current week is a full week in the current month. |
"True" |
|
Is Last Full Week In Month |
Indicates if this week is the last full week in the current month. |
"False" |
|
Is Last Week Day In Month |
Indicates if today is the last week day in the current month. |
"False" |
|
Is Last Week In Month |
Indicates if this week is the last week in the current month. |
"False" |
|
Is Last Weekend Day In Month |
Indicates if today is the last weekend day in the current month. |
"False" |
|
Is Leap Year |
Indicates if the current year is a leap year. |
"False" |
|
Is Monday |
Indicates if the current day is Monday. |
"True" |
|
Is Saturday |
Indicates if the current day is Saturday. |
"False" |
|
Is Sunday |
Indicates if the current day is Sunday. |
"False" |
|
Is Thursday |
Indicates if the current day is Thursday. |
"False" |
|
Is Tuesday |
Indicates if the current day is Tuesday. |
"False" |
|
Is Wednesday |
Indicates if the current day is Wednesday. |
"False" |
|
Is Week Day |
Indicates if the current day is a week day (Mon-Fri). |
"True" |
|
Is Weekend Day |
Indicates if the current day is a weekend day (Sat-Sun). |
"False" |
|
Last Week Day Abbreviation In Month |
Last week day abbreviation in the current month. |
"Tue" |
|
Last Week Day Date In Month |
Last week day date in the current month. |
"10/01/2014" |
|
Last Week Day In Month |
Last week day number in the current month. |
"30" |
|
Last Week Day Name In Month |
Last week day name in the current month. |
"Tuesday" |
|
Last Weekend Day Abbreviation In Month |
Last weekend day abbreviation in the current month. |
"Sun" |
|
Last Weekend Day Date In Month |
Last weekend day date in the current month. |
"10/26/2014" |
|
Last Weekend Day In Month |
Last weekend day number in the current month. |
"28" |
|
Last Weekend Day Name In Month |
Last weekend day name in the current month. |
"Sunday" |
|
Millisecond |
Current millisecond. |
"46" |
|
Millisecond (Zero-Filled) |
Current millisecond, zero-filled. |
"046" |
|
Minute |
Current minute. |
"4" |
|
Minute (Zero-Filled) |
Current minute, zero-filled. |
"04" |
|
Month |
Current month number. |
"2" |
|
Month (Zero-Filled) |
Current month number, zero-filled. |
"02" |
|
Month Abbreviation |
Current month abbreviation |
"Feb" |
|
Month Friday Count |
The number of Fridays in the current month. |
"4" |
|
Month Monday Count |
The number of Mondays in the current month. |
"5" |
|
Month Name |
Current month name. |
"February" |
|
Month Saturday Count |
The number of Saturdays in the current month. |
"4" |
|
Month Sunday Count |
The number of Sundays in the current month. |
"4" |
|
Month Thursday Count |
The number of Thursdays in the current month. |
"4" |
|
Month Total Days |
Total days in the current month. |
"30" |
|
Month Total Full Weeks |
Total full weeks in the current month. |
"3" |
|
Month Total Week Days |
The total number of week days in the current month. |
"22" |
|
Month Total Weekend Days |
The total number of weekend days in the current month. |
"8" |
|
Month Total Weeks |
Total weeks in the current month. |
"5" |
|
Month Tuesday Count |
The number of Tuesdays in the current month. |
"5" |
|
Month Wednesday Count |
The number of Wednesdays in the current month. |
"4" |
|
Month Week |
Current week number in the month. |
"1" |
|
Next Leap Year |
Next leap year after the current year. |
"2016" |
|
Next Leap Year Abbreviation |
Next leap year abbreviation after the current year. |
"16" |
|
Next Month |
Next month number. |
"3" |
|
Next Month (Zero-Filled) |
Next month number, zero-filled. |
"03" |
|
Next Month Abbreviation |
Next month abbreviation. |
"Mar" |
|
Next Month Name |
Next month name. |
"March" |
|
Next Month Total Days |
Total days in next month. |
"31" |
|
Next Month Total Full Weeks |
Total full weeks in next month. |
"3" |
|
Next Month Total Week Days |
The total number of week days in next month. |
"23" |
|
Next Month Total Weekend Days |
The total number of weekend days in next month. |
"8" |
|
Next Month Total Weeks |
Total weeks in next month. |
"5" |
|
Next Month Year |
Next month's year. |
"2014" |
|
Next Month Year Abbreviation |
Next month's year abbreviation. |
"14" |
|
Next Quarter |
Next quarter. |
"1" |
|
Next Week Day Abbreviation |
Next week day abbreviation. |
"Thu" |
|
Next Week Day Date |
Next week day date. |
"9/18/2014" |
|
Next Week Day Name |
Next week day name. |
"Thursday" |
|
Next Weekend Day Abbreviation |
Next weekend day abbreviation. |
"Sat" |
|
Next Weekend Day Date |
Next weekend day date. |
"9/20/2014" |
|
Next Weekend Day Name |
Next weekend day name. |
"Saturday" |
|
Next Year |
Next year. |
"2014" |
|
Next Year Abbreviation |
Next year abbreviation. |
"14" |
|
Previous Leap Year |
Previous leap year before the current year. |
"2012" |
|
Previous Leap Year Abbreviation |
Previous leap year abbreviation before the current year. |
"12" |
|
Previous Month |
Previous month number. |
"1" |
|
Previous Month (Zero-Filled) |
Previous month number, zero-filled. |
"01" |
|
Previous Month Abbreviation |
Previous month abbreviation. |
"Jan" |
|
Previous Month Name |
Previous month name. |
"January" |
|
Previous Month Total Days |
Total days in the previous month. |
"31" |
|
Previous Month Total Full Weeks |
Total full weeks in the previous month. |
"4" |
|
Previous Month Total Week Days |
The total number of week days in the previous month. |
"21" |
|
Previous Month Total Weekend Days |
The total number of weekend days in the previous month. |
"10" |
|
Previous Month Total Weeks |
Total weeks in the previous month. |
"6" |
|
Previous Month Year |
Previous month's year. |
"2013" |
|
Previous Month Year Abbreviation |
Previous month's year abbreviation. |
"13" |
|
Previous Quarter |
Previous quarter. |
"3" |
|
Previous Week Day Abbreviation |
Previous week day abbreviation. |
"Tue" |
|
Previous Week Day Date |
Previous week day date. |
"9/16/2014" |
|
Previous Week Day Name |
Previous week day name. |
"Tuesday" |
|
Previous Weekend Day Abbreviation |
Previous weekend day abbreviation. |
"Sun" |
|
Previous Weekend Day Date |
Previous weekend day date. |
"9/14/2014" |
|
Previous Weekend Day Name |
Previous weekend day name. |
"Sunday" |
|
Previous Year |
Previous year. |
"2012" |
|
Previous Year Abbreviation |
Previous year abbreviation. |
"12" |
|
Quarter |
Current quarter. |
"4" |
|
Quarter Month |
Current month number in the quarter. |
"3" |
|
Quarter Week |
Current week number in the quarter. |
"4" |
|
Second |
Current second. |
"52" |
|
Second (Zero-Filled) |
Current second, zero-filled. |
"52" |
|
Time |
Current time. |
"9:04:52 AM" |
|
Time (Military) |
Current military time. |
"09:04:52" |
|
Tomorrow |
Tomorrow's day number. |
"7" |
|
Tomorrow (Zero-Filled) |
Tomorrow's day number, zero-filled. |
"07" |
|
Tomorrow Abbreviation |
Tomorrow's day abbreviation. |
"Wed" |
|
Tomorrow Date |
Tomorrow's date. |
"9/18/2014" |
|
Tomorrow Day of Week |
Tomorrow's week day number. |
"4" |
|
Tomorrow Name |
Tomorrow's day name. |
"Wednesday" |
|
Year |
Current year. |
"2007" |
|
Year Abbreviation |
Current year abbreviation. |
"07" |
|
Year Half |
Current half of the year (1-2). |
"2" |
|
Year Total Days |
Total days in the current year. |
"365" |
|
Year Total Full Weeks |
Total full weeks in the current year. |
"41" |
|
Year Total Weeks |
Total weeks in the current year. |
"52" |
|
Year Week |
Current week number in the year. |
"47" |
|
Yesterday |
Yesterday's day number. |
"5" |
|
Yesterday (Zero-Filled) |
Yesterday's day number, zero-filled. |
"05" |
|
Yesterday Abbreviation |
Yesterday's day abbreviation. |
"Mon" |
|
Yesterday Date |
Yesterday's date. |
"9/16/2014" |
|
Yesterday Day of Week |
Yesterday's week day number. |
"3" |
| Yesterday Name | Yesterday's day name. | "Tuesday" |
Folders
Any Folders Token that returns a folder path with always end with a \ character.
| Item Name | Description | Example Value |
|---|---|---|
|
AppData Directory |
The Windows user's local AppData directory. |
"C:\Users\jdoe\AppData\Local\" |
|
Common Start Menu Directory |
The common Start Menu directory for all Windows users. |
"C:\Documents and Settings\All |
|
Common Startup Directory |
The common Startup directory for all Windows users. |
"C:\Documents and Settings\All |
|
Contacts Directory |
The Windows user's Contacts directory. |
"C:\Users\jdoe\Contacts\" |
|
Desktop Directory |
The Windows user's Desktop directory. |
"C:\Documents and Settings\jdoe\Desktop\" |
|
Downloads Directory |
The Windows user's Downloads directory. |
"C:\Users\jdoe\Downloads\" |
|
Favorites Directory |
The Windows user's Favorites directory. |
"C:\Documents and Settings\jdoe\Favorites\" |
|
Fonts Directory |
The Windows Fonts directory. |
"C:\Windows\Fonts\" |
|
Links Directory |
The Windows user's Links directory. |
"C:\Users\jdoe\Links\" |
|
My Documents Directory |
The Windows user's My Documents directory. |
"C:\Documents and Settings\jdoe\My Documents\" |
|
My Music Directory |
The Windows user's My Music directory. |
"C:\Users\jdoe\Music\" |
|
My Pictures Directory |
The Window user's My Pictures directory. |
"C:\Users\jdoe\Pictures\" |
|
My Videos Directory |
The Window user's My Videos directory. |
"C:\Users\jdoe\Videos\" |
|
Recent Directory |
The Windows user's Recent Documents directory. |
"C:\Documents and Settings\jdoe\Recent\" |
|
Start Menu Directory |
The Windows user's Start Menu directory. |
"C:\Documents and Settings\jdoe\Start Menu\" |
|
Startup Directory |
The Windows user's Startup directory. |
"C:\Documents and Settings\jdoe\Start Menu\Programs\Startup\" |
|
System Directory |
The Windows System directory. |
"C:\Windows\System32\" |
|
Temp Directory |
The Windows Temporary directory. |
"C:\Documents and Settings\jdoe\Local Settings\Temp\" |
|
Windows Directory |
The Windows directory. |
"C:\Windows\" |
Formula function descriptions
Important: All formula parameters, except for ConvertDateCulture and ConvertNumCulture, must be in US English format.
Tip: The Hold feature available in the Formula action and Formula section of the Expression Builder allows building nested formulas of up to 10 levels.
Build nested formulas using the Hold option
The Hold feature, available when building a formula using the Expression builder or the Formula action, can be used to place a formula on hold temporarily so that it can be nested within another formula. You can build up to 10 levels of nested formulas using the Hold feature.
To use the Hold feature:
-
Open the Expression Builder or the Action Builder window of the Formula action.
- Select the function you want, create a formula, and then click Hold to store the function.
- Start another formula, click the formula field you want to insert another formula in and click On Hold. The list of formulas you have placed on hold displays.
- Select the required On Hold formula you want to nest.
Convert
This is a list of conversion functions.
| Function name | Description |
|---|---|
|
CBool |
Returns an expression that has been converted to a boolean. |
|
CByte |
Returns an expression that has been converted to a byte. |
|
CCur |
Returns an expression that has been converted to currency. |
|
CDate |
Returns an expression that has been converted to a date. |
|
CDbl |
Returns an expression that has been converted to a double. |
|
CInt |
Returns an expression that has been converted to an integer. |
|
CLng |
Returns an expression that has been converted to a long. |
|
CSng |
Returns an expression that has been converted to a single. |
|
CStr |
Returns an expression that has been converted to a string. |
|
Hex |
Returns the hexadecimal value of a number. |
|
Oct |
Returns the octal value of a number. |
Date & Time
This is a list of date and time functions.
| Function name | Description |
|---|---|
|
Date |
Returns the current system date. |
|
DateAdd |
Returns a date to which a specified time interval has been added. |
|
DateDiff |
Returns the number of intervals between two dates. |
|
DatePart |
Returns the specified part of a given date. |
|
DateSerial |
Returns the date for a specified year, month, and day. |
|
DateValue |
Returns a date. |
|
Day |
Returns a number (1-31) representing the day of the month. |
|
DayZeroFilled |
Returns a zero-filled number (01-31) representing the day of the month. |
|
FormatDateTime |
Returns an expression formatted as a date or time. |
|
Hour |
Returns a number that represents the hour of the day (between 0 and 23). |
|
Minute |
Returns a whole number (between 0 and 59) representing the minute of the hour. |
|
Month |
Returns a number (1-12) representing the month of the year. |
|
MonthName |
Returns the name of a specified month. |
|
MonthZeroFilled |
Returns a zero-filled number (01-12) representing the month of the year. |
|
Now |
Returns the current system date and time. |
|
Second |
Returns a whole number (between 0 and 59) representing the second of the minute. |
|
Time |
Returns the current system time. |
|
TimeSerial |
Returns the time for a specific hour, minute, and second. |
|
Weekday |
Returns a whole number representing the day of the week (between 1 and 7). |
|
WeekdayName |
Returns the weekday name of a specified day of the week. |
|
Year |
Returns a number that represents the year. |
|
ZeroFillDate |
Returns a date in number format with each interval zero filled. |
Logic
This is a list of logic functions.
| Function name | Description |
|---|---|
|
And |
Returns True if all items evaluate as True. |
|
Contains |
Returns True if the provided value is found in the text. |
|
ContainsAlpha |
Returns True if the provided value contains an alpha character (A-Z or a-z). |
|
ContainsLCase |
Returns True if the provided value contains at least one lowercase character (a-z). |
|
ContainsNumber |
Returns True if the provided value contains at least one uppercase character (A-Z). |
|
ContainsUCase |
Returns True if the provided value contains at least one uppercase character (A-Z). |
|
False |
Returns the logical value False. |
|
If |
Checks whether a condition is met, and returns one value if True, and another value if False. |
|
IsBlank |
Returns True if the provided value is empty (no characters or spaces). |
|
IsBlankOrSpaces |
Returns True if the provided value is empty or contains only spaces. |
|
IsDate |
Returns True if the provided value is a Date. |
|
IsEqual |
Returns True if Item A and Item B are equal. |
|
IsEven |
Returns True if the provided value is an even number. |
|
IsGreater |
Returns True if Item A is greater than Item B. Non-numeric values are compared as Text. |
|
IsGreaterOrEqual |
Returns True if Item A is greater than or equal to Item B. Non-numeric values are compared as Text. |
|
IsLCase |
Returns True if all alpha characters in the provided value are lowercase. |
|
IsLess |
Returns True if Item A is less than Item B. Non-numeric values are compared as Text. |
|
IsLessOrEqual |
Returns True if Item A is less than or equal to Item B. Non-numeric values are compared as Text. |
|
IsNegative |
Returns True if the provided value is less than zero. Non-numeric values will return False. |
|
IsNotEqual |
Returns True if Item A and Item B are not equal. |
|
IsNumeric |
Returns True if the provided value is a number. |
|
IsOdd |
Returns True if the provided value is an odd number. |
|
IsPositive |
Returns True if the provided value is greater than or equal to zero. Non-numeric values will return False. |
|
IsProper |
Returns True if the provided value is proper cased. |
|
IsQuoteWrapped |
Returns True if the provided value is quote wrapped. |
|
IsSpaces |
Returns True if the provided value contains one or more space characters only. |
|
IsUCase |
Returns True if all alpha characters in the provided value are uppercase. |
|
IsWeekDay |
Returns True if the provided value is a week day (Mon-Fri). |
|
IsWeekendDay |
Returns True if the provided value is a weekend day (Sat-Sun). |
|
IsWholeNumber |
Returns True if the provided value is a whole number. |
|
IsZero |
Returns True if the provided value is zero. |
|
None |
Returns True if all items are False. |
|
Not |
Changes False to True, or True to False. |
|
Or |
Returns True if one or more items evaluate as True. |
|
True |
Returns the logical value True. |
Math
This is a list of math functions.
| Function name | Description |
|---|---|
|
Abs |
Returns the absolute value of a number. |
|
Add |
Returns the sum of 2 or more numbers. |
|
Atn |
Returns the arctangent of a specified number. |
|
Average |
Returns the average mean of the provided numbers. |
|
Cos |
Returns the cosine of an angle. |
|
Divide |
Returns the quotient of two or more numbers. |
|
Exp |
Returns e (the base of natural logarithms) raised to a power. |
|
FormatCurrency |
Returns an expression formatted as a currency value using the currency symbol defined in the system control panel. |
|
FormatNumber |
Returns an expression formatted as a number. |
|
FormatPercent |
Returns an expression formatted as a percentage. |
|
Int |
Returns the integer part of a specified number. |
|
Log |
Returns the natural logarithm of a number. |
|
Max |
Returns the largest of the provided numbers. |
|
Median |
Sorts the provided numbers from smallest to largest and returns the middle value. |
|
Min |
Returns the smallest of the provided numbers. |
|
Multiply |
Returns the product of two or more numbers. |
|
Pi |
Returns the ratio of the circumference of a circle to its diameter. |
|
Power |
Returns a number raised to the specified power. |
|
Range |
Returns the difference between the highest and lowest numbers provided. |
|
Remainder |
Returns the remainder of the quotient of two numbers. |
|
Rnd |
Returns a random number less than 1 but greater than or equal to 0. |
|
Round |
Returns a number rounded to a specified number of decimal places. |
|
RoundDown |
Returns a number rounded down to a specified number of decimal places. |
|
RoundUp |
Returns a number rounded up to a specified number of decimal places. |
|
Sgn |
Returns an integer indicating the sign of a number. |
|
Sin |
Returns the sine of an angle. |
|
Sqr |
Returns the square root of a number. |
|
Subtract |
Returns the difference of two or more numbers. |
|
Tan |
Returns the tangent of an angle. |
|
ZeroFill |
Returns a string filled with 0 to a certain length. |
Text
This is a list of text functions.
| Function name | Description |
|---|---|
|
Asc |
Returns the ANSI character code corresponding to the first letter in a string. |
|
Between |
Returns the text found between two values. |
|
BetweenRev |
Working backwards, returns the text found between two values. |
|
Chr |
Returns the character associated with the specific ANSI character code. |
|
Clean |
Removes all hidden and non-printable characters that prevent a formula from evaluating properly. |
|
Drop |
Drops a specific number of characters from the beginning or end of a string. |
|
InStr |
Returns the position of the first occurrence of one string within another. The search begins at the first character of the string. |
|
InStrRev |
Returns the position of the first occurrence of one string within another. The search begins at the last character of the string. |
|
IsAlpha |
Returns True if all characters in the provided value are alpha characters (A-Z, a-z, or space). |
|
IsAlphaNumeric |
Returns True if all characters in the provided value are alphanumeric characters (A-Z, a-z, 0-9, or space). |
|
Join |
Joins items together to form a line of text. |
|
LCase |
Converts text to lowercase. |
|
Left |
Returns a specified number of characters from the left side of a string. |
|
LeftOf |
Returns the text to the left of a specified value. |
|
Len |
Returns the number of characters in a string. |
|
LTrim |
Removes spaces on the left side of a string. |
|
Mid |
Returns a specified number of characters from a string. |
|
PadText |
Pads an expression with the specified character. |
|
Proper |
Capitalizes the first letter in each word. All other characters are converted to lowercase. |
|
QuoteWrap |
Returns the original text wrapped in quotes. |
|
Remove |
Removes all specified type of characters from a string. |
|
Replace |
Replaces a specified part of a string with another string a specified number of times. |
|
Right |
Returns a specified number of characters from the right side of a string. |
|
RightOf |
Returns the text to the right of a specified value. |
|
RTrim |
Removes spaces on the right side of a string. |
|
Space |
Returns a string consisting of the specified number of spaces. |
|
StrComp |
Returns a value indicating the result of a string comparison. |
|
String |
Returns a string of a specified length containing a repeating character. |
|
StrReverse |
Reverses a string. |
|
Trim |
Returns a copy of a string without the leading or trailing spaces. |
|
UCase |
Returns a string that has been converted to uppercase. |
|
WordCount |
Returns the number of words in a value. |
Translate
This is a list of translation functions.
| Function name | Description |
|---|---|
|
ConvertDateCulture |
Takes a date format from one country and converts it to the format used by another country. Supports:
Note: ConvertDateCulture can't be used as the parameter of another formula unless the convert to culture is in English (US). |
|
ConvertNumCulture |
Takes a number format from one country and converts it to the format used by another country. Supports:
Note: ConvertNumCulture can't be used as the parameter of another formula unless the convert to culture is in English (US). |
|
StateAbbrev |
Takes a full state name and returns the state abbreviation (USA only). |
|
StateName |
Takes a state abbreviation and returns the full state name (USA only). |
Image
1. Select the Insert view.
2. Enter the desired Image file path.
3. Press the Add to Expressionbutton to insert the token into your expression.
| Item Name | Description | Example Value |
|---|---|---|
|
Image Directory |
The folder location of the open image. |
"C:\Users\jdoe\Desktop\" |
|
Image File |
The file name of the open image. |
"example.jpg" |
|
Image File Ext |
The file extension of the open image. |
".jpg" |
|
Image Height |
The height of the open image in pixels. |
"142" |
|
Image Name |
The name of the open image. |
"example" |
|
Image Path |
The full file path of the open image. |
"C:\Users\jdoe\Desktop\example.jpg" |
|
Image Width |
The width of the open image in pixels. |
"180" |
|
Is Image Landscape |
Indicates if the width of the open image is greater than the height. |
"True" |
|
Is Image Open |
Indicates if an image is currently open. |
"True" |
|
Is Image Portrait |
Indicates if the height of the open image is greater than the width. |
"False" |
|
Is Image Saved |
Indicates if the open image is saved. |
"True" |
|
Is Image Square |
Indicates if the width and height of the open image are the same. |
"False" |
Keyboard
| Modifier Keys |
|---|
|
Windows Key |
Lists
The Lists view allows you to search Lists.
1. Select the Lists view.
2. Select the desired List from the list view.
A preview of the selected List displays.
3. Enter the value needed to locate the entry in the List.
4. Choose the Column to Search.
This is the column that contains the value previously entered.
5. Select the Column to Return.
This is the column containing the information needed from the List.
A preview of the List displays along with the result.
6. Once the expression is set up, click the Add to Expression button to add the List Lookup to the Expression.
Random
| Item Name | Description | Example Value |
|---|---|---|
|
GUID |
A random Globally Unique Identifier (GUID) |
"{F58B05A7-01F5-47AA-BC50DD39BEAB9EE2}" |
|
GUID (No Braces) |
A random Globally Unique Identifier, without braces. |
"F58B05A7-01F5-47AA-BC50DD39BEAB9EE2" |
|
GUID (No Braces or Dashes) |
A random Globally Unique Identifier, without braces or dashes. |
"F58B05A701F547AABC50DD39BEAB9EE2" |
|
Random Alphanumeric |
A random uppercase or lowercase alphanumeric character (A-Z, a-z, 0-9) |
"R" |
|
Random Alphanumeric (Lower) |
A random lowercase alphanumeric character (a-z, 0-9) |
"h" |
|
Random Alphanumeric (Upper) |
A random uppercase alphanumeric character (A-Z, 0-9) |
"E" |
|
Random First Name |
A random male or female first name. |
"Jennifer" |
|
Random First Name (Female) |
A random female first name. |
"Sandy" |
|
Random First Name (Male) |
A random male first name. |
"Joe" |
|
Random Gender |
A random gender. |
"Male" |
|
Random Gender Abbreviation |
A random gender abbreviation |
"F" |
|
Random Last Name |
A random last name. |
"Jones" |
|
Random Letter |
A random uppercase or lowercase letter (A-Z, a-z) |
"H" |
|
Random Letter (Lower) |
A random lowercase letter (a-z). |
"r" |
|
Random Letter (Upper) |
A random uppercase letter (A-Z). |
"G" |
|
Random Number (0 to 9) |
A random 1-digit number, including zero. |
"8" |
|
Random Number (0 to 99) |
A random number up to 2 digits, including zero. |
"72" |
|
Random Number (0 to 999) |
A random number up to 3 digits, including zero. |
"751" |
|
Random Number (0 to 9999) |
A random number up to 4 digits, including zero. |
"8733" |
|
Random Number (0 to 99999) |
A random number up to 5 digits, including zero. |
"56504" |
|
Random Number (1 to 9) |
A random 1-digit number, excluding zero. |
"8" |
|
Random Number (1 to 99) |
A random number up to 2 digits, excluding zero. |
"61" |
|
Random Number (1 to 999) |
A random number up to 3 digits, excluding zero. |
"918" |
|
Random Number (1 to 9999) |
A random number up to 4 digits, excluding zero. |
"1476" |
|
Random Number (1 to 99999) |
A random number up to 5 digits, excluding zero. |
"25201" |
|
Random Number (10 to 99) |
A random 2-digit number. |
"88" |
|
Random Number (100 to 999) |
A random 3-digit number. |
"933" |
|
Random Number (1000 to 9999) |
A random 4-digit number. |
"2641" |
|
Random Number (10000 to 99999) |
A random 5-digit number. |
"54081" |
|
Random SSN |
A random social security number. |
"593-57-2222" |
Variables
The Variables list displays the variables in your Botflow. This list may be blank if no variables have been created.
Variables are the only Token that are saved to a botflow.