Map item

Type conversion for simple values (String, Long, Double usw.)

automatic

automatic

Look up an enumeration value in the enumeration selected as Class, starting from a text key passed as value, which is compared with a key field defined for each enumeration (usually name, for Units alias)

automatic

automatic

Look up an entity of the selected Class (specific entity type), starting from a numeric value for the ID (id) of the entity

supported in server context not supported in Client Workflow

not supported

Type check against the selected Class to check the class membership of a value or all values of a list (if Is collection of is selected):→ Return value if passed: checked value (list if applicable)→ Return value if failed: "no value" ($null)

automatic

automatic

NOTE The Check type always takes place after the other functions that may be applicable. Therefore, if the look-up or type conversion is successful, the check is always passed. If an applicable function fails, the return value is "no value" ($null), because after that the selected Class is not present.

Key

In the Key parameter, value resolvers must be configured whose evaluation at runtime addresses a key (in a map) or field name (in a "client object").

In the example on the right, the value myKey is defined as a static text (see Static values) for the Key parameter, which would be suitable both as the key of a map and as the field name of a "client object".

IMPORTANT While the field name of a "client object" must always be a String , any data types can be used as keys in a map. For example, the same map could simultaneously contain a Long key 1234, an Integer key with the same value (1234), and a String key with the same digits ("1234").

NOTE When accessing existing keys in a map via the All map keys value resolver, the subset of keys for a given "key type" can be requested as the return value. To retrieve all field names in the context of a "client object", even the only supported String " key type" must be explicitly selected.

Class

The optional Item type parameter supports a static single selection for a class via a Combobox. Its search function (see image on the right) considers matches for the applicable localization as well as the internal name of the class.

A selection for Item type value implies a Check type for the read or assigned value, and may – if automatic conversions are provided – also cause a type conversion or lookup of enumeration values or entities with respect to the return value.

Example:

For example, if the text value 0815 (in JSON notation "0815") was assigned to the key myKey, then this can be "read" during a read access either as a String value (0815) or as a Long value (815) depending on the selection for the Item type.

If the Item type Long was already specified in the context of assigning the 0815 text value to the myKey key, then the Long value 0815 is assigned. The information that the original string contained a "leading zero" is lost in the process.

However, the stored long value (815) can be used to "look up" an entity with ID (id) 815 on read access by selecting its entity type as Item type if the context supports it (see table above).

NOTE The lang character string entered here as a search term could also be confirmed as free text input for a class (not listed in the dropdown) using the [+] symbol or the enter key, although this is rarely intended.

Is collection of

The Is collection of option (unchecked by default) specifies that the read or written value should be a list. If the value is not a list, the Map item value resolver returns/writes "no value" ($null).

If a Class is explicitly specified (see image on the right), selecting the option Is collection of implies a Check type of all existing entries against this Class, so that the return value is $null if at least one entry does not match the selected Class.

Example:

The selection of the Item type Long and the option Is collection of implies a Check type for the value in the Key myKey. If this does not contain a list (but e.g. only a single Long value) or a list containing entries with data types that are not Long values, the return value of the value resolver is $null.

NOTE As noted above, a write access is aborted on failure of a type check for the value on the target side of the assignment. If the configuration on the right defines the target of an assignment and a list is assigned at runtime that contains at least one value that is not a Long value, the Key myKey is not assigned "no value" ($null). Instead, an existing value for the Key myKey remains unchanged or the Key is not created (if it does not already exist).

Notification with data from a provided map

Notification with default values(without map)

The notification can be configured within an event handling as shown on the right:

• The Object Resolver within the Execute with event action primarily accesses a map present in the author variable. If the variable returns a map, this map will be the reference object for the output of the notification via a Show alert (Popup) in the action block below.

• If the author variable is empty or contains a data type other than a map, the Variable value resolver returns "no value". Then the concatenated Default value resolver becomes active and evaluates the configuration for its Default value parameter:

  • A "client object" is created from the static string {name:NN,id:0} (see Static values) by the concatenated JSON to object value resolver.

  • The "client object" replaces the missing map as a reference object in the output of the notification via Show alert (Popup) in the action block below.

Within the Show alert (Popup) event action, the Message combines values from the reference object in a Concat strings value resolver with literal text characters:

• The first text component reads the Key or the name field. Its name is assigned as static text.

• The second text component defines literal formatting characters as static text.

• The third text component reads the Key or the id field. Its name is assigned as static text.

NOTE We assume that the type of all "keys" relevant to the notification is in the map String. Only then does the smooth switch between "client object" and map as input value for the Map item resolver work as demonstrated here.

NOTE Creating a "client object" in the Default value resolver is more efficient than defining a separate Default value for each read access. However, the "default" only applies if the map is completely missing. If the map is available, but does not contain values for all relevant "keys", then the notification appears incomplete, if "individual default values" are waived as here.

The configuration on the right shows how the evaluation of combinatorics can be solved within an event handling:

• Details of the initial Search (Event action) are not important here. What is important is that it provides a list of users accounts in the variable users.

• The following Execute with event action sets a map created by Create instance with the Type "Map" (java.util.Map) as the reference object for the further event actions. As long as all actions concerning the map can be performed in this context (e.g. Show alert (Popup) at the bottom), the created map does not need to be explicitly assigned to a variable.

• For the context within the following For each loop, the locales variable for accessing the map is defined via the Save map in variable parameter. The Resolver for entities parameter defines an iteration over unique values for the "Locale" (locale) field within the list of all Users of the "user group" (in the users variable):

  • The Variable value resolver first returns all user accounts listed in the users variable.

  • The concatenated Collect values resolver reads the Object property "Locale" (locale) from these and returns a list as return value via the Unique values option, which contains each relevant "Locale" exactly once.

• The Execute with event action within the loop does not define a Object Resolver, so retains the Locale as a reference object. The Save Locale in variable parameter additionally writes the decisive Locale for the respective iteration into the locale variable. This is particularly necessary in order to access the Locale in the Rule list resolver (see below), which here refers to a user as a reference object.

  • The Set value event action defines a write access to the map (locales), which on the one hand creates a Key for the current Locale and on the other assigns the desired "country list" for the locale as a value.

    • On the left side of the assignment, a Variable value resolver establishes the reference to the map locales, which is needed as an input value for the concatenated Map item resolver. This defines the current Locale as the Key (per Variable value resolver for locale).

      NOTE A specification of Item type and Is collection of is omitted here.

    • On the right-hand side of the assignment, a Variable value resolver accesses the list of Users (users) at the beginning of the value resolver chain, which is processed as follows:

      • The concatenated Rule list resolver returns all Resolve all as list for which the Entity property rule is fulfilled that the Object property "locale" (locale) matches the current Locale (locale variable) in the iteration.

      • The concatenated Collect values resolver determines from this fraction within the "user group" a list of unique values for the "country" (address.countryCode) address field, provided that there is an entry for it

        NOTE $null values are simply skipped by Collect values in the given configuration.

• After iterating over all the languages used, here we perform a Show alert (Popup) event action to output the string image of the map for demonstration purposes.

  NOTE In a real use case the map can be processed otherwise.

Runtime example: (String image of the map)

{en=[US, DE], de=[DE, IT, AT], fr=[MU]}

NOTE Values of the dynamic enumeration Locale serve as a Key in the map and not just the internal names of these values (as a String) that the string image outputs. Also, the list in the associated value refers to dynamic enumeration values for the Country and not only to the text values output above.

For clarification, the server XML image of a map with the same data is also shown below