The Behaviour type Select from overview opens a specific overview where the user can select elements to transfer their data.

images/download/attachments/177905056/image-2024-10-2_15-47-49-version-1-modificationdate-1727876869322-api-v2.png

In the main category Common from the ribbon in the opened overview, a specific subcategory called Select appears (among other contents) with the two buttons Commit and Close:

images/download/attachments/177905056/image2020-6-2_23-57-29-version-1-modificationdate-1721209200657-api-v2.png

The Commit button exits the view and transfers the selected data as $input to the Actions on 'true'.
The Close button exits the view without accepting the selection. Instead, the text 'View closed' is transferred as $input to the Actions on 'false'.

Configuration parameters

The name of the view to be opened must be specified as the Viewname parameter. This can be determined from the open view, as described under Open view (Form designer).
►IMPORTANT◄ In contrast to Open view (Form designer), 'Menu node names' (e.g. shipment/shipmentOverview) are not applicable for the Viewname within the Select from overview behaviour type, but only the view names (i.e. de.lobster.scm.shipment.bto::Shipment|listSearchWindow).

The selection for the Result type parameter determines which data is to be returned from the overview when you click on Commit:

Selection	Return value type (as a single value or list of such values)
id	Internal ID of the selected entity
tuple	Tuple with the data (projections) of the selected row of the overview
entity	Complete object of the selected entity

The Min. number and Max. number parameters define limit values for the number of elements to be selected in the overview. The Commit button in the ribbon of the overview only appears active if the number of selected elements lies between these limits.

The value for the Min. number must be a positive integer. The minimum value for the Min. number is therefore 1.
The Max. number can be the value 0 in addition to positive integers. This is interpreted as 'no upper limit'.

►IMPORTANT◄ The setting for the Max. number parameter also influences the data format of the return value:

Single values (of the type selected by Result type) are only returned directly as behaviour data if the Max. number is set to 1.
If the selection allows multiple values (Max. number <> 1), single selected elements are returned as a list with exactly one element.

►NOTE◄ There is no mechanism that ensures compliance with the Min. number $images/wikimedia.org/api/rest_v1/media/math/render/svg/440568a09c3bfdf0e1278bfa79eb137c04e94035.png$ Max. number logical requirement within the behaviour type configuration. As long as the entries for both limit values are positive integers (>0), the decisive criterion is always that the selection contains at least as many entries as the lower of the two limit values, and at most, as many as the higher limit value. In case of an 'illogical' configuration of the parameters with Min. number > Max. number, the value assignments are simply swapped internally.

If the option Hide ribbons is set (default), almost all the menus and buttons usually offered in the open overview do not appear, so that only the specific buttons Commit and Close (under Common/Select) and Reset and Search (under Common/List, see Working with the graphical user interface) are available. Without this option, Commit and Close appear in addition to all other applicable menus.

Additional settings can also be made for the open view:

Parameter name	Description
Only one instance	If this option is checked, no new overview is opened if an instance of it is already open. This is merely brought to the foreground.
Modal	Specifies whether the open overview should be opened as an embedded dialog and not as a separate window.
Full size	Only available if the 'Modal' option is checked and active. If this option is activated, the modal dialog is embedded in full size in the current window.
Width/Height	Only available if the 'Modal' option is checked and active and 'Full size' is unchecked. Defines a static width and/or height for the modal dialog (pixels)
Min. width/Min. height	Only available if the 'Modal' option is checked and active and “Full size” is unchecked. Defines a static minimum width and/or minimum height for the modal dialog (pixels).
Resizable	Only available if the 'Modal' option is checked and active and “Full size” is unchecked. Defines whether and how the user can change the size of the modal dialog. It is possible to specify whether the size should only be changed in its width or height, both or not at all.
Closable	Only available if the 'Modal' option is checked and active. Determines whether the modal dialog may be closed without the user having made a valid selection.
Show “back button”	Only available if the 'Closable' option is checked and active. If checked, a back button is displayed which closes the dialog without a valid selection.

Example

In a portal a 'route' should be compiled as a list of waypoints by selecting them from the list of City.

Runtime example:

The following screenshot shows the interaction of the portal with the City overview in two view slots arranged side by side:

images/download/attachments/177905056/image2020-6-4_9-45-58-version-1-modificationdate-1721209200630-api-v2.png

(1) The City search is started with the Select cities Button in the portal.
(2) In the opened City overview, a filter is applied to the column 'Place name' to find possible matches for the searched places.
(3) Two specific entries are selected by clicking in the list.
(4) With the selection in the list, the button Commit in the ribbon becomes active. Clicking on Commit transfers the data of the selected City to the Repeatable element container in the portal (see screenshot above) and closes the City overview (right view slot).

Configuration:

images/download/attachments/177905056/image2020-6-4_9-47-59-version-1-modificationdate-1721209200610-api-v2.png

For the Select cities Button in the 'Routing' portal, a behaviour is configured as shown on the left:

The behaviour reacts to the Triggering event Click, as is typical for a Button.
For the Behaviour type Select from overview, the Viewname is entered, which by default refers to the City overview (a combined view with list and detail area). Custom overviews cannot be created for the master entity City. In this respect, there is no alternative to the default. However, specific data grid settings are possible for the default overview.
Tuple was selected here as the Result type, so that the possibly adjusted datagrid settings for the context influence the returned data.
The standard value 1 was retained for the Min. number, the Max. number was set to 1. Number was set to 0 ('unlimited').
Since the user should not deviate from the portal into data maintenance for cities, but should primarily make a decision, the Hide ribbons option was set (default).
Under the Actions on 'true', the Target element (Repeatable element 'waypoints' in the portal) is first emptied by the Populate empty element data action. Then, Populate element data assigns the City selection list by the behaviour to the same Repeatable element container.

►NOTE◄ The selected City (or the respective 'tuples') appear in the order of their selection in the City overview. The multiple 'approach' of the same City input is not supported.