Tries to match a value in a given array with a value at the same index in a replacement array and returns either the value at the same index or a default value if the value is not found.
displayvalue( value, inArray, replacement, default )
value: (Any Type) The value to search for in the array. Will cast to the type of inArray.
inArray: (Any Type Array) The array to be searched.
replacement: (Any Type Array) The array of replacement values.
default: (Any Type) The default value to be returned if the search value is not found.
This function supports expressions or process variables for arrays.
It is typically used to return a text display value that corresponds to an ID value stored in a process variable and makes it easier to generate reports that show human-readable values instead of numeric IDs in process data.
You can also use it to search a CDT array and return the CDT that has a field value matching a process variable value. Do this by creating an expression similar to the following:
displayvalue(pv!departmentID, pv!departments.departmentID, pv!departments, "none")
The type of the argument passed to value must match the types in the replacement array, otherwise the default value will be returned.
If the length of the replacement array is shorter than the inArray array, the replacement array will be repeatedly extended until it is the same length as the longer inArray array.
You can experiment with this function in the test box below.
Return a Priority Level Based on the Number in an Array:
Use with the
resource() Function to Display Internationalized Text:
custom_locale_en_US.properties file located in the
<INSTALL_HOME>/server/_conf directory, define the following key value pairs:
1 2 3 low=Low medium=Medium high=High
!priority process variable of type Number and set the current locale to
2 because the
resource() function looked up the value corresponding to the key
resource(): Use this function to look up key values when using
displayvalue() for the internationalization of display values in place of literal values for the
On This Page