External search (dynamic enumeration)

The predefined enumeration External search (dynamic enumeration) (ExternalSearchType) defines access options to Lobster Data Platform / Orchestration content views via a URL fragment (see External search for details) with the following schema.

The list can be customised.
For the configuration of enumeration values, a specific configuration type ‘External search (configuration)’ (ExternalSearchTypeConfiguration) is available, which provides the specific fields described below in addition to the ‘Icon URI’ (iconUri) field.

An External search can be addressed using the name (name) of the enumeration value with the following syntax:

Schema of a URL with fragment for an ‘External search’

[<url>]#open=<name>[&<param>=<value>[&<param2>=<value2>[& ...]]]

The typical use for an External search is to open an overview for a specific entity type in conjunction with specific search criteria, which can be included in the URL fragment as optional value assignments for ‘parameters’ (<param>, <param2>, etc.) as a Variable.

The following example shows the call for an External search with the name users, for which the text value 1 is assigned to the hasRole parameter. The aim is to open an overview for Users that only lists accounts that have access to the role with the ‘ID’ (id) 1 (‘Super user’).

Simple example (relative path = fragment only)

#open=users&hasRole=1

The configuration for the associated External search type is shown in the ‘Example’ column in the following table.

Configuration parameters	Description	Example
Entity (`entity`)	The entity type that the View to open should display, taking the Search into account, should be selected in the Combobox.
View to open (`viewName`)	The View to open can either be entered directly or selected from the searchable menu structure by clicking on the menu icon (right). In the first example (top right), the view name for the generic ‘User overview’ (`User\|listDetailsWindow`) was entered directly. In the second variant, a menu item localised as a User is selected for a ‘Custom overview’, so that the (internal) menu node name without localisations (`admin/accounts/XFLOW_USER_DOCU`) appears in the text field, while the ‘localised’ path is specified in the message line below (Administration > Accounts > Users). ►NOTE◄ Further information on addressing views is documented for the Open view (Action) event action.
View to open (`viewName`)
Search (`search`)	The Search field defines a Suche for the entity type selected as the Entity, which is applied in addition to any restrictions defined for the View to open (as part of an AND Junction). ►NOTE◄ The explanations on opening an overview with a `Search` entity (see Open view (Action)) as 'Form data' also apply to the consideration of the Search for an External search. In the specific use case (right), the search effectively only contributes its Where condition as an (additional) restriction for the view: The only criterion in the Where condition is a Field restriction that requires a match between the Property projection for the ‘roles’ list field of the checking users and the value for the ‘parameter’ (`roles`) `hasRole` from the URL fragment, which can be addressed as the Variable `hasRole` for the context of the search. ►NOTE◄ The configuration interface for the Search contains some parameters that have no effect on an External search. In addition to the Where condition, only restrictive Joins can influence an External search. If joins are configured, the entire Search is linked to the view as a Sub search restriction.