Functions are are predefined formulas that can be used to perform simple or complex data calculations and logic validation etc.
Functions are predefined formulas that perform calculations by using specific values, called arguments, in a particular order, or structure. A expression support multiple predefined functions. A function support multiple functions between it, called nested functions.
Function Structure
Nested functions
Functions by Category
String functions
Logical functions
Date functions
Mathematical functions
Other (Advanced) functions
Function Structure
The structure of a function begins with the function name ①, followed by an opening parenthesis, the arguments ③ for the function separated by commas, and a closing parenthesis.
When you select any function name, you will see the instruction of how to use this function ②.
① Function Name
Yeeflow offer the available functions in listed based on your scenarios.
② Argument(s)
Arguments, or called parameters, can be numbers, strings, datetimes, logical values such as TRUE or FALSE, arrays, lookup references, or any applicable expressions. The argument you designate must produce a valid value for that argument. Arguments can also be constants, formulas, or other functions.
③ Formula Tooltip
A tooltip will appears as you select this function.
Nested Functions
In certain cases, you may need to use a function as one of the arguments of another function. For example, the following formula uses a nested isNullOrEmpty function as an argument to return the value. The isNullOrEmpty is nested within the iif
function.
Please Note: When a nested function is used as an argument, the nested function must return the same type of value that the argument uses. For example, if the argument returns a TRUE or FALSE value, the nested function must return a TRUE or FALSE value. If the function doesn't, it displays an error value.
<Return to Top>
Functions by Category
Functions are categorized by their functionality. Click a category header to quick browse its functions.
Based on scenarios, Yeeflow offers different functions under categories.
String Functions
String functions perform various character manipulations. They operate on character strings. A string expression evaluates to a sequence of characters or text.
Function | Description | Example |
concat | Concatenates multiple text values into a single string. | - example formula: |
formatNumber | Formats a number to a specified number of decimal places. | - example formula: |
JSONParse | Parses a JSON string into an object. | - example formula: |
JSONStringify | Converts an object to a JSON string. | - example formula: |
left | Returns the specified number of characters from the start of a string. | - example formula: |
len | Returns the number of characters in a string. | - example formula: |
lower | Converts text to lowercase. | - example formula: |
regExpTest | Tests a regular expression match against a specified string, returning true or false. | - example formula: |
repeat | Repeats a string a specified number of times. | - example formula: |
replace | Replaces the first occurrence of a specified substring with another string. | - example formula: |
replaceAll | Replaces all occurrences of a specified substring with another string. | - example formula: |
right | Returns the specified number of characters from the end of a string. | - example formula: |
strIndex | Searches for a substring within a string and returns the starting position if found. | - example formula: |
subString | Extracts a substring from a specified position in a string for a given length. | - example formula: |
text | Converts various data types to text format. | - example formula: |
trim | Removes whitespace from both ends of a string. | - example formula: |
UniqueID | Generates a unique identifier. | - example formula: |
upper | Converts text to uppercase. | - example formula: |
Logical Functions
Logical functions can create expressions that convert values from one to another.
Function | Description | Example |
iif | Evaluates each WHEN condition. If it is met, executes the corresponding THEN expression. If none of the WHEN conditions are met, the ELSE expression or specified alternative value is executed. If no ELSE expression is provided, the system automatically adds ELSE NULL. | - example formula: |
isFalse | Determines if an expression is false. | - example formula: |
isNullOrEmpty | Returns True if the specified string or object is NULL or an empty string; otherwise, returns False. | - example formula: |
isTrue | Determines if an expression is true. The expression is considered “true” in the following cases: boolean type is “true”; string “True”; non-zero number, all considered true. | - example formula: |
not | Inverts the expression to true or false. | - example formula: |
Date Functions
Date functions conduct the data of DATE and DATETIME based on a calendar year.
Function | Description | Example |
addWorkDays | Adds or subtracts a specified number of workdays to a date. | - example formula: |
addWorkHours | Adds or subtracts a specified number of work hours to a date. | - example formula: |
dateAdd | Adds or subtracts a specified interval from a date. | - example formula: |
dateDiff | Calculates the interval between two dates. Returns a negative value if the first date is later than the second. | - example formula: |
dateFormat | Formats a date and time according to specified patterns. | - example formula: |
datePart | Extracts a specific part of a date. | - example formula: |
datePicker | Selects a date and time. | - example formula: |
day | Extracts the day from a date. | - example formula: |
getWorkHours | Calculates the number of work hours between two dates. | - example formula: |
hour | Extracts the hour from a date. | - example formula: |
minute | Extracts the minute from a date. | - example formula: |
month | Extracts the month from a date. | - example formula: |
now | Returns the current date and time. | - example formula: |
second | Extracts the seconds from a date. | - example formula: |
toServerTime | Converts a date to server time. | - example formula: |
toUserTime | Converts a date to user local time. | - example formula: |
weekNum | Retrieves the week number from a date. | - example formula: |
year | Extracts the year from a date. | - example formula: |
Mathematical Functions
Mathematical functions perform mathematical operations on the data of NUMBER.
Function | Description | Example |
abs | Retrieve the absolute value of a number. You can use this function to make sure that a number is positive. | - example formula: |
ceil | Returns the smallest integer value not less than the parameter. | - example formula: |
fixed | Formats a number with a fixed number of decimal places. | - example formula: |
floor | Returns the largest integer value not greater than the parameter. | - example formula: |
log | Returns the natural logarithm (base e) of a number. | - example formula: |
max | Returns the maximum value among the provided values. | - example formula: |
min | Returns the minimum value among the provided values. | - example formula: |
number | Converts a value to a number. | - example formula: |
pow | Raises a number to the power of another number. | - example formula: |
rand | Returns a random number between 0 (inclusive) and 1 (exclusive). | - example formula: |
round | Rounds a value to the nearest integer or to the specified number of fractional digits. | - example formula: |
sqrt | Returns the square root of a number. | - example formula: |
This format follows your requested style for the examples and outputs. Let me know if any other changes are needed!
Other Functions - Advanced functions
The other functions contain some advanced functions as:
Lookup functions, such as "listLookup"
System reference functions, such as "getUserAttr"
Statistical functions, such as "arrayConcat”
Engineer Functions. such as "getAttr"
It returns the values from your lookup source, system data, or some complex variables.
Function | Description | Example |
arrayConcat | Returns a new array that contains the elements of each of the given sequence of two arrays. | - example formula: |
arrIndex | Locates the position of a value in an array; returns -1 if not found. | - example formula: |
clientType | Retrieves the client type information, such as "web" or "mobile". | - example formula: |
currentUser | Returns information about the current user. | - example formula: |
getAttr | Returns the attribute value from an object by the given attribute. | - example formula: |
getCostCenterAttr | Retrieves Cost Center attribute. Attributes will be separated by commas if expression is an array. | - example formula: |
getDirectReports | Pass in the user ID, returning an array of its immediate subordinate user IDs. | - example formula: |
getLocAttr | Retrieves location attribute. Attributes will be separated by commas if location expression is an array. | - example formula: |
getMetadataAttr | Retrieves metadata attribute, separated by commas if the expression is more than one ID. | - example formula: |
getDeptAttr | Retrieves department attribute. Attributes will be separated by commas if department expression is an array. | - example formula: |
getDeptByParent | Gets ID array of departments by parent department. | - example formula: |
getQueryString | Retrieves the value of the specified query parameter from the URL. | - example formula: |
getUserAttr | Retrieves user attribute. Attributes will be separated by commas if the user expression is an array. | - example formula: |
getWindowMode | Retrieves the mode information of the current window and returns the corresponding numeric identifier. If no mode is set, it returns a default value. Syntax: Applied: All | - example formula: - example output: "1" |
isInGroup | Determines if a user is in the specified group. | - example formula: |
len | Returns the length of a string or array. | - example formula: |
listLookup | Retrieves field value from a data list. | - example formula: |
positionLookup | Finds user(s) by position. | - example formula: |
vLookup | Searches for rows that contain a specific value in a column or in an array, and returns either the entire row object or data from a specified column within the row. The result can be a single record or an array of all matching objects. | - example formula: |