Widget Building Function Reference#
The following table describes which functions can be applied at each widget builder stage. For more on how to use functions to set up widgets, see Advanced Setup - Widgets
const : Evaluates whether the field value matches the argument.
Example Expression
WAREHOUSE ID = const("WH5")Example Input
Result
convert : Converts a value to a specified type.
Example Expression
convert(GOAL_HOURS,“int”)Example Input
Result
dateFixed : Returns all records that have the specified date in the specified date field.
Works the same way as the Fixed date parameter option in Widget Properties. For more info, see Editing a Date Parameter - Advanced .
Example Expression
REPORT_DATE = dateFixed(REPORT_DATE, "2023-03-02T22:30:00.000Z")Example Input
Result
dateFixedRange : Returns all records that have in the specified date field a date that’s between the ‘from’ date and the ‘to’ date (inclusive).
Works the same way as the Fixed date parameter option in Widget Properties. For more info, see Editing a Date Parameter - Advanced .
Example Expression
REPORT_DATE = dateFixedRange(REPORT_DATE,"2023-03-02T00:00:00.000Z","2023-03-04T00:00:00.000Z")Example Input
Result
dateRelative : Returns all records that have in the specified date field a date that is in the dynamic date range (inclusive) counting back from today’s date.
The second argument is the number of days counting back from today’s date to get the start date and the third argument is the number of days counting back from today’s date to get the end date. Works the same way as the Days date parameter option in Widget Properties. For more info, see Editing a Date Parameter - Advanced . In the example, the dynamic date range is calculated based on May 2nd, 2023 at 12:00 AM as the current date and time.
Example Expression
REPORT_DATE = dateRelative(REPORT_DATE, -10, 0)Example Input
Result
dateRelativeRange : Returns all records that have in the specified date field a date that’s within the dynamic date range that’s’based on today’s date.
If you specify a weekly range, you have to specify in the third argument which day of the week should be considered the first day of the week.Works the same way as the Relative date parameter option in Widget Properties. For more info, see Editing a Date Parameter - Advanced. In the example, the dynamic date range is calculated based on May 2nd, 2023 at 10:00 AM as the current date and time.
Example Expression
REPORT_DATE = dateRelativeRange(REPORT_DATE, BEG_OF_WEEK,MONDAY)Example Input
Result
exists : When set to ‘true’, returns records that have the specified field even when it has only null values. If set to ‘false’, returns only records that don’t have the field.
Example Expression
USR_ID = exists(true)Example Input
Result
regexp : Lets you select records that have a field value that matches a pattern specified as a regular expression : FIELDNAME = regexp(expression(YOUR_REGEX_EXPRESSION), options(ADVANCED_REGEX_OPTIONS).
For more information, see Selecting Records based on Patterns in String Values.
Example Expression
DESCRIPTION = regexp(expression(LOAD),options(i))Example Input
Result
sysdate : Returns the system date in Coordinated Universal Time (UTC) i.e., Greenwich Mean Time.
For more info, see Building Widgets that Refer to the System Date. In the example, the function is run on April 19th, 2023.
Example Expression
TRAILER_DISPATCH_DATE >= sysdate(-1)Example Input
Result
sysdatetz : Returns the system date in the WMS’s local time zone.
For more info, see Building Widgets that Refer to the System Date. In the example, the function is run on April 19th, 2023.
Example Expression
TRAILER_DISPATCH_DATE_LOCAL >= sysdatetz(-1, America/Adak)Example Input
Result
absolute : Returns the absolute value of a number.
Example Expression
absolute(ORDER_QUANTITY)Example Input
Result
add : Adds numbers together or adds numbers and a date.
and : Evaluates one or more expression s and returns true if all of the expression s are true or if evoked with no argument expression s. Otherwise, $and returns false.
Example Expression
and(greaterThan(PICK_QUANTITY,50),lessThan(PICK_QUANTITY,100))Example Input
Result
average : Returns the average value of the numeric values.
Ignores non-numeric values.
Example Expression
average(CASES_SHIPPED,CASE_ORDERED)Example Input
Result
ceil : Returns the smallest integer greater than or equal to the specified number.
Example Expression
ceil(ORDER_WEIGHT)Example Input
Result
compare : Compares two values and returns: ‘-1’ if the first value is less than the second; ‘1’ if the first value is greater than the second; and ‘0’ if the two values are equivalent.
Example Expression
compare(CASES_SHIPPED,CASES_ORDERED)Example Input
Result
Example Expression
concatenate(ORDER_NUMBER, PO_NUMBER,"A", "WILMA")Example Input
Result
condition : Evaluates a boolean expression to return one of the two specified return expression s.
Either of the two possible return expressions can be a null value. In the example, the function will return ‘Staged’ if SHIPMENT_STATUS is D, L or S. Otherwise, it will return ‘Not Staged’.
Example Expression
condition(in(SHIPMENT_STATUS,["D","L","S"]),"Staged","Not Staged")Example Input
Result
dateDifferenceInMs : Subtracts two dates to return the difference in milliseconds, or a date and a number in milliseconds to return the resulting date.
Example Expression
dateDifferenceInMs(SHIP_DATE,LATEST_SHIP_DATE)Example Input
Result
dateToString : Converts a date object to a string according to a user-specified format.
Function format: dateToString(DATE_FIELD, “OUTPUT FORMAT”, timezone[optional], value to return if date is null or missing.) The output format “%Y-%m-%dT%H:%M:%S.%LZ” contains the maximum number of elements that can be included. You can ommit elements in reverse order to create a simpler format. For example,”%Y-%m-%d” would format the date with only the year, month, and day.
Example Expression
dateToString(ORDERED_DATE, "%Y-%m-%d", null,null)Example Input
Result
dayOfMonth : Returns the day of the month for a date as a number between 1 and 31.
Example Expression
dayOfMonth(REPORT_DATE)Example Input
Result
dayOfWeek : Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
Example Expression
dayOfWeek(REPORT_DATE)Example Input
Result
dayOfYear : Returns the day of the year for a date as a number between 1 and 366.
Example Expression
dayOfYear(REPORT_DATE)Example Input
Result
divide : Divides one number by another and returns the result.
Example Expression
divide(ORDER_QUANTITY, SHIPPED_QUANTITY)Example Input
Result
equals : Compares two values and returns: ‘true’ when the values are equivalent. Otherwise, ‘false’.
Example Expression
equals(USR_NAME,"BETTY")Example Input
Result
exp : Raises Eulers number (i.e. e ) to the specified exponent and returns the result.
Example Expression
exp(ORDER_WEIGHT)Example Input
Result
fieldType : Returns the data type (e.g, ‘string’ or ‘int’) of the field you enter as an argument.
In this example, the field entered is CUST_NAME (i.e., the customer’s name). As a result, the function will return ‘string’ as the value.
Example Expression
fieldType(CUST_NAME)Example Input
Result
findSubstring : Searches a string for a substring and returns the index (zero-based) of the first instance. If the substring is not found, returns -1.
Example Expression
findSubstring(CUST_NAME, "ABC", 0,9)Example Input
Result
floor : Returns the largest integer less than or equal to the specified number.
Example Expression
floor(ORDER_WEIGHT)Example Input
Result
getElementFromArray : Returns the element at the specified array index.
Example Expression
getElementFromArray(LOADS,2)Example Input
Result
greaterThan : Compares two values and returns: ‘true’ when the first value is greater than the second value, and ‘false’ when the first value is less than or equivalent to the second value.
Example Expression
greaterThan(UNIT_QUANTITY,55)Example Input
Result
greaterThanOrEqual : Compares two values and returns ‘true’ when the first value is greater than or equal to the second value. Otherwise it returns false.
Example Expression
greaterThanOrEqual(UNIT_QUANTITY,55)Example Input
Result
hour : Returns the hour portion of a date as a number between 0 and 23.
Example Expression
hour(REPORT_DATE)Example Input
Result
in : Returns TRUE if the record’s specified field has any of the values enclosed in the square brackets.
Each value should be enclosed in double quotes. Format: in (FIELD_VALUE_TO_TEST, [“ArrayElement1”,”ArrayElement2”]).
Example Expression
in(USR_ID,["WILMA","BETTY", "FRED", "BARNEY"])Example Input
Result
isNull : Evaluates an expression and returns the value of the expression if the expression evaluates to a non-null value.
If the expression evaluates to a null value, including instances of undefined values or missing fields, returns the value of the replacement expression.
Example Expression
isNull(CUST_NAME,"No customer name")Example Input
Result
isoDayOfWeek : Returns the weekday number in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).
Example Expression
isoDayOfWeek(REPORT_DATE)Example Input
Result
isoWeek : Returns the week number in ISO 8601 format, ranging from 1 to 53.
Week numbers start at 1 with the week (Monday through Sunday) that contains the year’s first Thursday.
Example Expression
isoWeek(REPORT_DATE)Example Input
Result
isoWeekYear : Returns the year number in ISO 8601 format.
The year starts with the Monday of week 1 and ends with the Sunday of the last week.
Example Expression
isoWeekYear(REPORT_DATE)Example Input
Result
lessThan : Compares two values and returns ‘true’ when the first value is less than the second value. Otherwise it returns false.
Example Expression
lessThan(ORDER_QUANTITY,SHIPPED_QUANTITY)Example Input
Result
lessThanOrEqual : Compares two values and returns ‘true’ when the first value is less than or equal to the second value. Otherwise it returns false.
Example Expression
lessThanOrEqual(ORDER_QUANTITY,SHIPPED_QUANTITY)Example Input
Result
literal : Returns the specified value.
Example Expression
literal(small)Result
ln : Calculates the natural logarithm ln (i.e log e) of a number and returns the result as a double.
Example Expression
ln(ORDER_WEIGHT)Example Input
Result
log : Calculates the log of a number in the specified base and returns the result as a double.
Example Expression
log(ORDER_WEIGHT,3)Example Input
Result
log10 : Calculates the log base 10 of a number and returns the result as a double.
Example Expression
log10(ORDER_WEIGHT)Example Input
Result
lowerCase : Converts a string to lowercase, returning the result.
Example Expression
lowerCase(USR_NAME)Example Input
Result
max : Returns the maximum value from the argument s.
Example Expression
max(CASES_ORDERED,CASES_SHIPPED)Example Input
Result
millisecond : Returns the millisecond portion of a date as an integer between 0 and 999.
Example Expression
millisecond(REPORT_DATE)Example Input
Result
min : Returns the minimum value from the argument s.
Example Expression
min(CASES_ORDERED,CASES_SHIPPED)Example Input
Result
minute : Returns the minute portion of a date as a number between 0 and 59.
Example Expression
minute(REPORT_DATE)Example Input
Result
modulus : Divides one number by another and returns the remainder.
Example Expression
modulus(UNIT_QUANTITY,12)Example Input
Result
month : Returns the month of a date as a number between 1 and 12.
Example Expression
month(REPORT_DATE)Example Input
Result
multiply : Multiplies numbers together and returns the result.
Example Expression
multiply(ORDER_QUANTITY, SHIPPED_QUANTITY, 332, 989)Example Input
Result
notEquals : Evaluates a boolean and returns the opposite boolean value; i.e. when passed an expression that evaluates to true, $not returns false; when passed an expression that evaluates to false, $not returns true.
Example Expression
notEquals(USR_NAME, "BETTY")Example Input
Result
or : Evaluates one or more expression s and returns true if any of the expression s are true. Otherwise, $or returns false.
Example Expression
or(greaterThan(UNIT_QUANTITY,50),lessThan(UNIT_QUANTITY,20))Example Input
Result
param : Creates a parameter (i.e., a field whose value can be modified by a user viewing the widget.).
The first argument is the parameter’s name and the second argument is its default value. For more info, see Adding Parameters through the Display Field and Group Stages .
Example Expression
multiply(TOTAL_HOURS_WORKED,param(AVG_PAY,15))Example Input
Result
power : Raises a number to the specified exponent and returns the result.
Example Expression
power(CASES_SHIPPED,2)Example Input
Result
Regexmatch : Returns ‘True’ if the field value matches regex.
Example Expression
regexMatch(UOM,PALLET)Example Input
Result
round : Rounds a number to a specified number of digits.
In the function’s syntax, Number1 is the number you want to round; it can be a fixed numerical value, or a field. Number2 is the number of decimal places to which you want to round Number1.
Example Expression
round(PERCENTAGE_FILL_RATE,0)Example Input
Result
second : Returns the second portion of a date as a number between 0 and 59, but can be 60 to account for leap seconds.
Example Expression
second(REPORT_DATE)Example Input
Result
sizeOfArray : Counts and returns the total the number of items in an array.
Example Expression
sizeOfArray(LOADS)Example Input
Result
splitString : Divides a string into an array of substrings based on a delimiter.
sqrt : Calculates the square root of a positive number and returns the result.
Example Expression
sqrt(ORDER_WEIGHT)Example Input
Result
stringLength : Looks at a string and returns the number of characters in it.
Example Expression
stringLength(USR_ID)Example Input
Result
substring : Returns a substring of a string, starting at a specified index position and including the specified number of characters.
The index is zero-based.
Example Expression
substring(USR_NAME,0,4)Example Input
Result
subtract : Subtracts two numbers to return the difference, or two dates to return the difference in milliseconds, or a date and a number in milliseconds to return the resulting date.
Example Expression
subtract(ORDER_QUANTITY,SHIPPED_QUANTITY)Example Input
Result
sum : Calculates and returns the sum of numeric values.
Ignores non-numeric values.
Example Expression
sum(ORDER_QUANTITY,SHIPPED_QUANTITY)Example Input
Result
sysdate : Returns the system date in Coordinated Universal Time (UTC) i.e., Greenwich Mean Time.
For more info, see Building Widgets that Refer to the System Date . In the example, the function is run on May 1st, 2023.
Example Expression
sysdate(0)Result
sysdatetz : Returns the system date in the WMS’s local time zone.
For more info, see Building Widgets that Refer to the System Date . In the example, the function is run on May 1st, 2023.
Example Expression
sysdatetz(-1, America/Adak)Result
toDate : Converts a value to a date.
If the value can’t be converted, an error will be returned.
Example Expression
toDate(PICKED_DATE)Example Input
Result
toDouble : Converts a value to a double.
If the value can’t be converted, an error will be returned.
Example Expression
toDouble(ORDER_NUMBER)Example Input
Result
toInteger : Converts a value to an integer.
If the value can’t be converted, an error will be returned.
Example Expression
toInteger(ORDER_NUMBER)Example Input
Result
toString : Converts a value to a string.
If the value can’t be converted, an error will be returned.
Example Expression
toString(ORDERED_DATE)Example Input
Result
truncate : Truncates a number to its integer.
Example Expression
truncate(ORDER_WEIGHT)Example Input
Result
upperCase : Converts a string to uppercase, returning the result.
Example Expression
upperCase(USR_NAME)Example Input
Result
weekOfYear : Returns the week of the year for a date as a number between 0 and 53.
Weeks begin on Sundays, and week 1 begins with the first Sunday of the year. Days preceding the first Sunday of the year are in week 0.
Example Expression
weekOfYear(REPORT_DATE)Example Input
Result
year : Returns the year portion of a date.
Example Expression
year(REPORT_DATE)Example Input
Result
Note
Group functions are divided into two categories: aggregation functions, which group data together (e.g., sum, average, min, max); and embedded functions, which must be included inside an aggregation function.
Functions that return true/false results should be embedded inside the condition function, which should be wrapped inside an aggregation function. The condition function is particularly useful for getting a count of records that meet spcified criteria.
Aggregation Functions
average : Returns the group’s mean value for the specified field.
Example Expression
average(ORDER_QUANTITY)Example Input
Result
buildArray : Selects a comma-separated set of unique values from the specified field and adds them to an array.
Example Expression
buildArray(USR_NAME )Example Input
Result
first : Returns the first value in a data set.
Note
When using ‘first’ and ‘last’ functions, be sure to add a sort stage before your grouping to ensure you are ordering the data as you want to see it.
Example Expression
first(ORDER_QUANTITY)Example Input
Result
last : Returns the last value in a data set.
Note
When using ‘first’ and ‘last’ functions, be sure to add a sort stage before your grouping to ensure you are ordering the data as you want to see it.
Example Expression
last(ORDER_QUANTITY)Example Input
Result
max : Returns the group’s maximum value for the specified field.
If the field stores string values, the function returns the maximum string value based on lexicographic order.
Example Expression
max(ORDER_QUANTITY)Example Input
Result
min : Returns the group’s minimum value for the specified field.
If the field stores string values, the function returns the minimum string value based on lexicographic order.
Example Expression
min(ORDER_QUANTITY)Example Input
Result
sum : Returns the sum of all the values in the specified field for each group.
Example Expression
sum(PICK_QUANTITY)Example Input
Result
Embedded functions
absolute : Returns the absolute value of a number.
Example Expression
average(absolute(ORDER_QUANTITY))Example Input
Result
add : Adds numbers together or adds numbers and a date.
If one of the argument s is a date, treats the other argument s as milliseconds to add to the date.
Example Expression
sum(add(ORDER_QUANTITY, SHIPPED_QUANTITY, 332,989))Example Input
Result
and : Evaluates one or more expression s and returns true if all of the expression s are true or if evoked with no argument expression s. Otherwise, $and returns false.
To aggregate the true/false results, embed the and function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if the PICK_QUANTITY value is greater than 50 and less than 100; otherwise, it returns a value of 0. The expression then sums the records that meet the specified condition.
sums the records that have PICK_QUANTITY greater than 50 and less than 100. For each record that meets the condition, the function returns a value of 1, otherwise it returns a value of 0.
Example Expression
sum(condition(and(greaterThan(PICK_QUANTITY,50),lessThan(PICK_QUANTITY,100)),1,0))Example Input
Result
The SUM_AND field stores the total number of records whose PICK_QUANTITY value is greater than 50 and less than 100.
ceil : Returns the smallest integer greater than or equal to the specified number.
Example Expression
sum(ceil(ORDER_WEIGHT))Example Input
Result
compare : Compares two values and returns: ‘-1’ if the first value is less than the second; ‘1’ if the first value is greater than the second; and ‘0’ if the two values are equivalent.
Example Expression
average(compare(CASES_ORDERED,CASES_SHIPPED))Example Input
Result
Example Expression
max(concatenate(ORDER_NUMBER, PO_NUMBER,"A", "WILMA"))Example Input
Result
condition : Evaluates a boolean expression to return one of the two specified return expression s.
Either of the two possible return expressions can be a null value. In the example, the function returns a value of 1 if SHIPMENT_STATUS is D, L, or S; otherwise, it returns a value of 0. The expression then sums the records that meet the specified condition.
Example Expression
sum(condition(in(SHIPMENT_STATUS,["D","L","S"]),1,0))Example Input
Result
The field SUM_CONDITION stores the total number of records whose SHIPMENT_STATUS is D, L, or S.
dateToString : Converts a date object to a string according to a user-specified format.
Function format: dateToString(DATE_FIELD, “OUTPUT FORMAT”, timezone[optional], value to return if date is null or missing.)
Example Expression
min(dateToString(ORDERED_DATE, "%Y-%m-%d", null,null))Example Input
Result
dayOfMonth : Returns the day of the month for a date as a number between 1 and 31.
Example Expression
min(dayOfMonth(REPORT_DATE))Example Input
Result
dayOfWeek : Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
Example Expression
min(dayOfWeek(REPORT_DATE))Example Input
Result
dayOfYear : Returns the day of the year for a date as a number between 1 and 366.
Example Expression
min(dayOfYear(REPORT_DATE))Example Input
Result
divide : Divides one number by another and returns the result.
Note
If the denominator is zero, no result will be returned. There will not be any error message. To prevent this from happening, you can nest a condition function as the argument for the denominator. e.g.,
divide(FIELD1, condition(equals(FIELD2, 0), 1, FIELD2))Example Expression
divide(ORDER_QUANTITY, SHIPPED_QUANTITY)Example Input
Result
equals : Compares two values and returns: ‘true’ when the values are equivalent. Otherwise, ‘false’.
To aggregate the true/false results, embed the equals function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if USR_ID equals “BETTY”; otherwise, it returns a value of 0. The expression then sums the records that meet the specified condition.
Example Expression
sum(condition(equals(USR_ID,"BETTY"),1,0))Example Input
Result
The SUM_EQUALS field stores the total number of records whose USR_ID equals “BETTY”.
exp : Raises Eulers number (i.e. e ) to the specified exponent and returns the result.
Example Expression
average(exp(ORDER_WEIGHT))Example Input
Result
findSubstring : Searches a string for a substring and returns the index (zero-based) of the first instance. If the substring is not found, returns -1.
Example Expression
max(findSubstring(CUST_NAME, "ABC", 0,9))Example Input
Result
getElementFromArray : Returns the element at the specified array index.
Example Expression
getElementFromArray(LOADS,2)Example Input
Result
in : Returns TRUE if the record’s specified field has any of the values enclosed in the square brackets.
Each value should be enclosed in double quotes. Format: in (FIELD_VALUE_TO_TEST, [“ArrayElement1”,”ArrayElement2”]). To aggregate the true/false results, embed the in function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if USR_ID equals either “WILMA”, “BETTY”, “FRED”, or “BARNEY”; otherwise, it returns a value of 0. The expression then sums the records that meet the specified condition.
Example Expression
sum(condition(in(USR_ID,["WILMA","BETTY", "FRED", "BARNEY"]),1,0))Example Input
Result
The SUM_IN field stores the total number of records whose USR_ID is either “WILMA”, “BETTY”, “FRED”, or “BARNEY”.
isNull : Evaluates an expression and returns the value of the expression if the expression evaluates to a non-null value.
If the expression evaluates to a null value, including instances of undefined values or missing fields, returns the value of the replacement expression. In the example, the isNull function returns the value “No customer name” if CUST_NAME of a record stores a null value. The condition function returns a value of 1 if the record has a value equal to “No customer name”; otherwise, it returns a value of 0. The expression them sums the number of records that meet the specified condition.
Example Expression
sum(condition(equals(isNull(CUST_NAME,"No customer name"),"No customer name"),1,0))Example Input
Result
The field SUM_IS_NULL stores the total number of records that have the value “No customer name”.
isoDayOfWeek : Returns the weekday number in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).
Example Expression
min(isoDayOfWeek(REPORT_DATE))Example Input
Result
isoWeek : Returns the week number in ISO 8601 format, ranging from 1 to 53.
Week numbers start at 1 with the week (Monday through Sunday) that contains the year’s first Thursday.
Example Expression
min(isoWeek(REPORT_DATE))Example Input
Result
isoWeekYear : Returns the year number in ISO 8601 format.
The year starts with the Monday of week 1 and ends with the Sunday of the last week.
Example Expression
max(isoWeekYear(REPORT_DATE))Example Input
Result
lessThan : Compares two values and returns ‘true’ when the first value is less than the second value. Otherwise it returns false.
To group the true/false results, the and function must be wrapped inside the condition function, before it’s embedded in an aggregation function. To aggregate the true/false results, embed the lessThan function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if the SHIPPED_QUANTITY value is less than the ORDER_QUANTITY value; otherwise, it returns a value of 0. The expression then sums the records that meet the specifid condition.
Example Expression
sum(condition(lessThan(SHIPPED_QUANTITY,ORDER_QUANTITY),1,0))Example Input
Result
The field SUM_LESS_THAN stores the total number of records whose SHIPPED_QUANTITY value is less than the ORDER_QUANTITY value.
lessThanOrEqual : Compares two values and returns ‘true’ when the first value is less than or equal to the second value. Otherwise it returns false.
To group the true/false results, the and function must be wrapped inside the condition function, before it’s embedded in an aggregation function. To aggregate the true/false results, embed the lessThanOrEqual function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if the ORDER_QUANTITY value is less than or equal to the SHIPPED_QUANTITY value; otherwise, it returns a value of 0. The expression then sums the records that meet the specifid condition.
Example Expression
sum(condition(lessThanOrEqual(ORDER_QUANTITY,SHIPPED_QUANTITY),1,0))Example Input
Result
The field SUM_LESS_THAN_OR_EQUAL holds the total number of records whose ORDER_QUANTITY value is less than or equal to the SHIPPED_QUANTITY value.
ln : Calculates the natural logarithm ln (i.e log e) of a number and returns the result as a double.
Example Expression
average(ln(ORDER_WEIGHT))Example Input
Result
log : Calculates the log of a number in the specified base and returns the result as a double.
Example Expression
average(log(ORDER_WEIGHT,3))Example Input
Result
log10 : Calculates the log base 10 of a number and returns the result as a double.
Example Expression
average(log10(ORDER_WEIGHT))Example Input
Result
lowerCase : Converts a string to lowercase, returning the result.
Example Expression
max(lowerCase(USR_NAME))Example Input
Result
millisecond : Returns the millisecond portion of a date as an integer between 0 and 999.
Example Expression
max(millisecond(REPORT_DATE))Example Input
Result
min : Returns the minimum value from the argument s.
Example Expression
min(min(CASES_ORDERED,CASES_SHIPPED))Example Input
Result
minute : Returns the minute portion of a date as a number between 0 and 59.
Example Expression
max(minute(REPORT_DATE))Example Input
Result
modulus : Divides one number by another and returns the remainder.
Example Expression
sum(modulus(UNIT_QUANTITY,12))Example Input
Result
month : Returns the month of a date as a number between 1 and 12.
Example Expression
max(month(REPORT_DATE))Example Input
Result
multiply : Multiplies numbers together and returns the result.
Example Expression
sum(multiply(ORDER_QUANTITY, SHIPPED_QUANTITY))Example Input
Result
notEquals : Evaluates a boolean and returns the opposite boolean value; i.e. when passed an expression that evaluates to true, $not returns false; when passed an expression that evaluates to false, $not returns true.
To aggregate the true/false results, embed the notEquals function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if USR_ID does not equal “BETTY”; otherwise, it returns a value of 0. The expression then sums the records that meet the specified condition.
Example Expression
sum(condition(notEquals(USR_NAME,"BETTY"),1,0))Example Input
Result
The field SUM_NOT_EQUALS stores the total number of records whose USR_ID does not equal “BETTY”.
or : Evaluates one or more expression s and returns true if any of the expression s are true. Otherwise, $or returns false.
To aggregate the true/false results, embed the or function inside the condition function and wrap the condition function inside the desired aggregation function. In the example, the condition function returns a value of 1 if the PICK_QUANTITY value is greater than 50 or less than 20; otherwise, it returns a value of 0. The expression then sums the records that meet the specified condition.
Example Expression
sum(condition(or(greaterThan(UNIT_QUANTITY,50),lessThan(UNIT_QUANTITY,20)),1,0))Example Input
Result
The SUM_OR field stores the total number of records whose PICK_QUANTITY value is greater than 50 or less than 20.
param : Creates a parameter (i.e., a field whose value can be modified by a user viewing the widget.).
The first argument is the parameter’s name and the second argument is its default value.
Note
This function can be used only as an argument inside another function. For more info, see Adding Parameters through the Display Field and Group Stages .
Example Expression
average(multiply(TOTAL_HOURS_WORKED,param(AVG_PAY,15)))Example Input
Result
power : Raises a number to the specified exponent and returns the result.
Example Expression
sum(power(CASES_SHIPPED,2))Example Input
Result
second : Returns the second portion of a date as a number between 0 and 59, but can be 60 to account for leap seconds.
Example Expression
max(second(REPORT_DATE))Example Input
Result
splitString : Divides a string into an array of substrings based on a delimiter.
splitString removes the delimiter and returns the resulting substrings as elements of an array. If the delimiter is not found in the string, splitString returns the original string as the only element of an array.
Example Expression
min(splitString(FULL_NAME,","))Example Input
Result
sqrt : Calculates the square root of a positive number and returns the result.
Example Expression
sqrt(ORDER_WEIGHT)Example Input
Result
stringLength : Looks at a string and returns the number of characters in it.
Example Expression
max(stringLength(USR_ID))Example Input
Result
substring : Returns a substring of a string, starting at a specified index position and including the specified number of characters.
The index is zero-based.
Example Expression
max(substring(USR_NAME,0,4))Example Input
Result
subtract : Subtracts two numbers to return the difference, or two dates to return the difference in milliseconds, or a date and a number in milliseconds to return the resulting date.
Example Expression
sum(subtract(ORDER_QUANTITY,SHIPPED_QUANTITY))Example Input
Result
sysdate : Returns the system date in Coordinated Universal Time (UTC) i.e., Greenwich Mean Time.
For more info, see Building Widgets that Refer to the System Date .
Example Expression
max(sysdate(0))Example Input
Result
sysdatetz : Returns the system date in the WMS’s local time zone.
For more info, see Building Widgets that Refer to the System Date .
Example Expression
max(sysdatetz(-1, America/Adak))Example Input
Result
toDate : Converts a value to a date.
If the value can’t be converted, an error will be returned.
Example Expression
max(toDate(PICKED_DATE))Example Input
Result
toDouble : Converts a value to a double.
If the value can’t be converted, an error will be returned.
Example Expression
max(toDouble(ORDER_NUMBER))Example Input
Result
toInteger : Converts a value to an integer.
If the value can’t be converted, an error will be returned.
Example Expression
max(toInteger(ORDER_NUMBER))Example Input
Result
toString : Converts a value to a string.
If the value can’t be converted, an error will be returned.
Example Expression
max(toString(ORDERED_DATE))Example Input
Result
truncate : Truncates a number to its integer.
Example Expression
sum(truncate(ORDER_WEIGHT))Example Input
Result
upperCase : Converts a string to uppercase, returning the result.
Example Expression
upperCase(USR_NAME)Example Input
Result
weekOfYear : Returns the week of the year for a date as a number between 0 and 53.
Weeks begin on Sundays, and week 1 begins with the first Sunday of the year. Days preceding the first Sunday of the year are in week 0.
Example Expression
max(weekOfYear(REPORT_DATE))Example Input
Result
year : Returns the year portion of a date.
Example Expression
max(year(REPORT_DATE))Example Input
Result
