Editable Lists

This section describes editable lists.

Up until now UIM only supported read only lists, where FIELD elements within a list could only have SOURCE connections. UIM now supports FIELD elements within a list that have SOURCE and TARGET connections, otherwise known as editable lists. FIELD elements that have only a TARGET connection with no SOURCE connection are not supported. The reason for this is that only Clusters that have input fields should be used for creating business data within the application.

There are essentially two distinct types of editable lists:
  1. Editable Lists controlled by checkbox

    If the first field within a list has both connections and it has SVR_BOOLEAN as it's underlying domain, the first column in the list will be displayed as a check box. When a user selects the check box on a particular row, the other editable columns within that row can be edited (their value updated).

    If a user does not select a check box, then the other editable columns within that row are disabled and cannot be edited. The key point, is that within a Check Box Controlled Editable List, all the editable columns are controlled by the first column - the check box column.

  2. Editable Lists

    If the first field within a list has both connections and it does not have SVR_BOOLEAN as it's underlying domain then it will be treated as a normal editable list, where all of the editable columns are decoupled from one another. Even if there is a check box column within the list (not the first column), it cannot control whether the other editable lists are editable or not.

A mixture of read-only fields and editable fields are permitted within a list.

Within editable lists it is possible to submit hidden values (per list row) to the server that are not visible within the list with the LIST_CONNECT child element. For example, in the context of a person object, if there was an editable list on a page that displayed details about the person, there may be the need to submit the persons ID (unique identifier) to the server as a hidden field without displaying it to the user. A single LIST_CONNECT element can be configured within the list to pass the unique id for each person (each row represents a single person).

Only the following data types are supported on fields within editable lists:
  • CURAM_BOOLEAN,
  • THREE_FIELD_DATE,
  • SVR_DOUBLE,
  • SVR_FLOAT,
  • SVR_INT8,
  • SVR_INT16,
  • SVR_INT32,
  • SVR_INT64,
  • SVR_CHAR, and
  • SVR_STRING.