Functions

For a given currency, converts currency to a different type according to new date, and recalculates the functional currency values. Use syntax such as:

CURRCONVERT($<currencyField>$, $<currencyField2>$.TYPE$, $TIMESTAMP$)

Use other values for the type and timestamp, such as a character field and a date field, for example:

CURRCONVERT($<currencyField>$, $<characterField>$, $<dateField>$)

For information about data conversion rules for currency fields, see Workflow considerations for currency fields.

This function is not supported in a progressive view.

For a given currency, sets a new date of currency and recalculates the functional currency values. Use syntax such as:

CURRSETDATE($<currencyField>$, $TIMESTAMP$)

Use other values for the timestamp, such as a date field or integer. For example:

CURRSETDATE($<currencyField>$, 1026779689)

For information about data conversion rules for currency fields, see Workflow considerations for currency fields.

This function is not supported in a progressive view.

For a given currency, sets new type of currency and recalculates the functional currency values. Use syntax such as:

CURRSETDATE($<currencyField>$, $<currencyField2>$.TYPE$)

Use other values for the type, such as a character field. For example:

CURRSETTYPE($<currencyField>$, $<characterField>$)

For information about data conversion rules for currency fields, see Workflow considerations for currency fields.

This function is not supported in a progressive view.

For a given currency, sets new value of currency and recalculates the functional currency values. Use syntax such as:

CURRSETVALUE($<currencyField>$, $<currencyField2>$.VALUE$)

Use another field to set the currency value, such as a decimal field. For example:

CURRSETVALUE($<currencyField$, $decimalField>$)

For information about data conversion rules for currency fields, see Workflow considerations for currency fields.

This function is not supported in a progressive view.

Adds a specified number of days, weeks, months, or years to the date and returns the new date. Specify datepart using one of the following quoted values:

• Year—"year ", "yy ", or "yyyy "
• Month—"month ", "mm ", or "m "
• Day—"day ", "dd ", or "md "
• Week—"week ", "wk ", or "ww "

The date parameter is the date value to add to. For example, to add 10 weeks to the 05/20/02 date, enter:

DATEADD("ww", 10, "05/20/08")

Depending on the value of datepart (day or week), returns the number of days or weeks between the start date and the end date. Specify datepart using one of the following quoted values:

• Day—"day ", "dd ", or "md "
• Week—"week ", "wk ", or "ww "

For example, to find the number of days between date1 and date2, enter:

DATEDIFF("dd", $date1$, $date2$)

Used in Set Fields filter and escalation actions only. Returns the unencrypted text value of the encrypted text (cyphertext), using the encryption key (key). The return value is smaller than the size of the encrypted string. When decrypting, you must use the same key that you used when encrypting. For example, to decrypt the string in Field1 using the key my_key, enter:

DECRYPT($Field1$, "my_key")

To decrypt a string using a key in KeyField, enter:

DECRYPT("<stringToDecrypt>", $KeyField$)

Use this function with character fields only. See information about the Encrypted String field in Reserved fields.

Used in Set Fields filter and escalation actions only. Returns the encrypted value of a text string (plaintext), using the encryption key (key). The return value is larger than the size of the unencrypted string. For example, to encrypt the string in Field1 using the key my_key, enter:

ENCRYPT($Field1$, "my_key")

To encrypt a string using a key in KeyField, enter:

ENCRYPT("<wordToEncrypt>", $KeyField$)

Use this function with character fields only. See information about the Encrypted String field in Reserved fields.

For more information about the algorithm used for encryption, see Workflow-Encryption-Algorithm.

For a column in a list view, tree view, a results list table field, or a cell-based table, the string value of the column in the row being hovered over is returned. For a table itself, the row number of the hovered over row is returned. For a given attachment pool, a string value containing the file name (if any) of the hovered attachment is returned. For example, to get the HOVER value for a table column with ID 536880913, enter:

HOVER(536880913)

When the field being referenced for the HOVER function is not being hovered over, an empty string is returned.

This function should be used in conjunction with an On Hover active link execution option.

Use this function to extract specific values from JSON data.

JSONMAP(value, string)

Where value is JSON data and string is a JSON expression.

Example:

JSONMAP($jSONFieldID$, $expressionField$)

In this function, jSONFieldID is the ID of the field that contains the JSON data. The expression in expressionField is applied to the JSON data and the resulting output value is returned by this function. If no data matches the JSON expression, this function returns NULL.

For a working example, see Creating dynamic selection lists for Progressive Web Applications by using JSON data.

Use this function when the Length Units property of a field is characters.
Returns the value that results from padding the first parameter (char) to the left with the value of the third parameter (char), so that the resulting value is the length (in characters) of the second parameter (int) or the length of the original string, whichever is longer.

For example, if you want the results of a Set Fields operation to be a 15-character value with the prefix LEAD, followed by zeros, and ending in the contents of the integer field Call #, enter:

LPADC($Call #$,15,"LEAD00000000000").

If the Call # field contains the number 947, the result of the Set Fields action is LEAD00000000947.

Returns the maximum value of the set specified. The data type of all values must match for the result to be meaningful. For example, to check the current time and the escalation time, and return the greater (latest) value of the two, enter:

MAX ($Escalate Date$, $TIMESTAMP$).

MAX returns $NULL$ only if all arguments in the function evaluate to $NULL$.

Returns the minimum value of the specified set. The data type of all values must match for the result to be meaningful. For example, to check the current time and the escalation time, and return the lower (earliest) value of the two, enter:

MIN ($Escalate Date$, $TIMESTAMP$).

If any argument evaluates to $NULL$, the argument is not considered in the evaluation of the function. For example, if MyField is empty (has a value of $NULL$ ), but the field HasValue has a value of 10, then MIN($MyField$, $HasValue$) returns 10. MIN returns $NULL$ only if all arguments in the function evaluate to $NULL$.

Use this function when the Length Units property of a field is characters.

Returns the right-most characters of the first parameter (char) up to the number of characters indicated by the second parameter (int).

For example, to set the value of a field to the last four characters of an account code, enter:

RIGHTC($Account#$,4).

Use this function when the value of the Length Units property of a field is characters.
Returns the value that results from padding the first parameter (char) on the right with the value of the third parameter (char), so that the resulting value is the length (in characters) of the second parameter (int) or the length of the original string, whichever is longer.

For example, to add blank spaces after a submitter's name to make the entry 20 characters long, enter:

RPADC($Submitter$,20," ")

SUBSTR

Returns a string from the specified template formatted with values substituted for template parameters. The first parameter is the template name. The template parameters and their values follow in pairs, for example:

TEMPLATE("Simple Template", "First Name", $Short Description$, "Last Name", $Submitter$, "City", "Sunnyvale")