Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleWhat is it for?
Excerpt
A value list is used for predefining possible values that an Attribute can have and it's corresponding display values. 

What is it?

A value list, sometimes misspelled as valuelist, limits the base Types of an Attribute. It contains a set of possible values an attribute can have. After the value list is specified it can be chosen within the attribute. When you attempt to set a value that is not in the value list, a run-time exception is thrown. However, it is possible to keep deprecated values in a value list, by using a conditional value list, and setting a False condition for those values.

What does it do?

It offers the user a list of values the user can choose from.

Properties

Property

Description

Base typeShould match with the data type of the attribute the value list is linked with. The options are: Boolean, String, Number, Date, DateTime, Percentage, Currency and Integer. See also Attribute types.
ExternalTick this box if you want to use an external source for the value list items. An external value list does not have fixed values, but gets its values from an external source, e.g., a data base or a service. How the value list gets its data is configured in the configuration of Interactions. It requires Java code to supply the values.
Items - valueA value that matches the value lists base type. This value can be used in expressions.
Items - display value

A text that describes the matching value. This text is used in your applications user interface. The display value is multilingual

Info

Note

UI Text Box
typenote

Please note that value lists do not support Text Substitution Language: TSL. If more dynamic texts are required, please consider the Container type: AQ_InstanceLinker.

Tip

To show display values on pages and in documents using (inline) text items, solely add the reference to the attribute to the field. Any addition other than comments to the expression will result in the (technical) value to be shown.

Presentation stylesSelect one or more presentation styles. Presentation styles in a value list can for example be used to apply icons such as different country flags. 

How to – create a conditional value list

A conditional value list means that under a certain condition only a subset of all possible values is available. When you use a conditional value list, the subset of available values is determined at run-time.

  1. Create a new value list

  2. Add at lease one item in the Items tab

  3. Select the Conditions tab

  4. Toggle the Conditional toggle. A table appears (like a decision table) summing up the values you just created on the Items tab. 

  5. Define in the table:

    • Which conditions apply to the value list

    • Which value is shown when the condition is true by ticking the checkboxes

...

Info
iconfalse
titleChanging conditions

If your user can change the available values (the outcome of the decision table), but already selected a value that is no longer available, the selected value will remain selected. This value will only disappear after the user changes their selection. If the now unavailable value shouldn't be possible to select, consider adding a validation rule.

How to – work with an external value list

An external value list means that the list is filled with values by an external source, i.e., a piece of code that supplies the values. As studio does Encore does not connect during design time to this external source, you cannot use the values for validating expressions or using drop downs. If you are sure that some values are present in this external source, you can define them in studioEncore, so that you can validate on them in expressions, and use these values in drop downs. These values defined values defined in studio are Encore are not exported to the runtime, and the runtime completely bases the values from the list on the external source.