Lookup
Overview
The Lookup ViewTemplate enables integration of cross-Entity selection functionality into a View. It allows users to select a specific dataset from another Entity by displaying a LookupView that originates from the target Entity. The selected dataset's UID is then written to a defined EntityField in the current Context.
The LookupView that is displayed is configured in the Context using the lookupView property and is typically associated with the Provider side of a Consumer-Provider relationship. The selected value is written into the EntityField defined by the consumerField property, which must be connected to a Provider of the Entity supplying the selectable datasets.
Interaction Behavior
Upon selection, the UID of the chosen record is stored in the EntityField specified by consumerField. This field must belong to a Consumer, which must be logically linked to the Provider of the external Entity that contains the selectable records.
Display Modes
The LookupView can be displayed in two different modes, controlled by the consumerPresentationMode property:
| Mode | Description |
|---|---|
POPUP | (Default) Opens the LookupView in a separate popup window. |
EMBEDDED | Renders the LookupView directly within the parent View, eliminating the need for a separate interaction to open it. |
Configuration
The Lookup ViewTemplate requires the following configuration properties:
| Property | Description |
|---|---|
consumerField | Specifies the EntityField in which the UID of the selected dataset will be stored. This field must be defined as a Consumer. |
consumerPresentationMode | Defines how the LookupView is presented to the user. Accepts the values POPUP or EMBEDDED. The default value is POPUP. |
For the LookupView to function correctly, the consumerField must be part of a Consumer-Provider relationship. The Consumer must point to the Provider of the Entity that supplies the datasets shown in the LookupView.
The EMBEDDED presentation mode is particularly useful when the selection should be immediately visible within the parent View layout, such as when embedding selection components directly into detail Views.