Explorer Select

Article • 02.08.2022 • 6 minute(s) to read

Explorer Select

The Explorer Select provides a configurable view of the Entities of a given Entity Type. Users can select one, or if configured, more Entities. This selection is stored by the content of the configured value Attribute in the the Attribute or Variable backing the Explorer Select.

Control properties

  • Id / Name - Identifier of the Form Control. Id / Name needs to be unique for all Form Controls on the same Form. Id / Name also binds the Form Control to an Attribute with the same name of the Variable backing the From. This means that the Form Control will load and show the value from said Attribute when the Form is entered, and that the value of the Form Control is stored in the Attribute when the Form is left by a Save or Sign and Save action. The Form Control can also be bound to an Attribute of a Variable other than the one backing the From by using the fully qualified name as Id / Name:

    A detailed explanation of the different linking mechanisms between a Form Control and an Attribute is given in the Variable and Variable Type configuration of the From Activity.

  • Label text - Caption rendered above the Form Control thus identifying it to the Users.

  • Button style - Color of the button opening the Explorer Select view

  • Button icon or text - Sets if the button is labeled with a Text or an Icon:

    • Button text - Text on the button
    • Button icon - Icon in the button
  • Help text - Explanation of the Form Control shown below the Form Control.

  • Default value - Default value loaded when the Form is entered and no value is available from the linked Attribute.

  • Enable conditional mandatory validation? - This property is similar to the Is field mandatory? property, but allows you to specify a condition determining when the Form Control becomes mandatory. If Enable conditional mandatory validation? is set to No this property is disabled. If set to Yes, a condition can be entered determining when the Form Control becomes mandatory. When the condition evaluates to true, the Form Control cannot be left empty or unspecified in case a Save or Sign and Save Action is triggered. Dismiss and Sign Actions do not enforce the mandatory condition. However, it does not matter if the value was entered by the User or did already existed in the Attributes backing this Form Control, but it just has to exists. When List of values? is set to Yes, this property is ignored.

    • Condition for is mandatory - When this Form Control Expression evaluates to true, the Form Control becomes mandatory. An asterisk in front of its label indicates if the Form Control is currently mandatory.
  • Is field mandatory? - When set to No, the Form Control can be left empty or unspecified. When set to Yes, the Form Control cannot be left empty or unspecified. The Actions Save or Sign and Save enforce this condition, while Dismiss and Sign Actions do not enforce it. If set to Yes, it does not matter if the record is entered by the User or did already existed in the Attribute backing this Form Control. Mandatory Form Controls are indicated by an asterisk in front of their label. This property is only available if Enable conditional mandatory validation? is set to to No. When List of values? is set to Yes, Is field mandatory? is ignored and the Require at least one record? property of the LIST CONFIGURATION has to be used instead.

  • Disable control? - Makes the Form Control editable (No) or read-only (Yes). Be aware that the content of read-only Form Controls is not stored by Save and Sign and Save Actions in the linked Attribute.

  • Hide control? - Hides (Yes) or shows (No) the Form Control in the Form. Be aware that the content of hidden Form Controls is stored by Save and Sign and Save Actions in the linked Attribute.

  • Condition type - Allows you to hide or disable the Form Control based on a Form Control Expression evaluating to true or false:

    • Display - Hides the Form Control when the Form Control Expression evaluates to false and shows it when the Form Control Expression evaluates to true. Be aware that the content of hidden Form Controls is stored by Save and Sign and Save Actions in the linked Attribute.
    • Disable - Makes the Form Control editable when the Form Control Expression evaluates to false and makes it read-only when the Form Control Expression evaluates to true. Be aware that the content of read-only Form Controls is not stored by Save and Sign and Save Actions in the linked Attribute.
    • Display condition or Disable condition - The Form Control Expression behind the condition
  • List of values? - Form Control represents an array (Yes) or a single value (No). Form Controls of arrays have two additional properties:

    • Require at least one record? - Specifies if the array can be empty (No) or must have at least one record (Yes). This property is equal to the Is field mandatory? property of non-array values. The Actions Save or Sign and Save enforce this condition, while Dismiss and Sign Actions do not enforce it. If set to Yes, it does not matter if the record is entered by the User in the current session or did already exist in the array backing this Form Control. An asterisk next to the title indicates to the Users, that this property is set to Yes and at least one record is required.
    • Disable delete? - When set to No, all entries in the array backing the Form Control can be deleted. If set to Yes, only new entries entered by the User in the current session can be deleted but entries already in the array cannot not be deleted.
  • Time zone - Selects if any date and time values should be shown in UTC (UTC) or the local time zone of the User (Local).

  • Source - The Entities of this Entity Type are loaded into the Form Control.

  • Value attribute - Attribute of the selected Entity Type used as the result value of the Form Control.

  • Filters - Only those Entities of the selected Entity Type matching these filters are shown on the Form Control. If no filters are set, all Entities are shown.

    • Add filter - Creates a new filter
    • Attribute - Selects the Attribute this filter is applied on.
    • Value - Only Entities with a matching value in the selected Attribute will pass the filter. The value can be entered directly or as a Form Control Expression.
    • - Delete filter
  • Columns - All Attributes of the Entities that should be shown in the Form Control have to be configures as column:

    • Add column - Adds a new column to show an Attribute
    • Attribute - Select what Attribute this column shows
    • - Configure the shown Attribute and the order:
      • Attribute - Select what Attribute this column shows
      • Display Order - Numerical display order of the columns. I.e., columns with a lower display order are to the left of columns with higher display orders.
    • - Deletes the column