External search (dynamic enumeration)

Die vordefinierte Aufzählung External search (dynamic enumeration) (ExternalSearchType) definiert Zugriffsmöglichkeiten auf Views Inhalte von Lobster Data Platform / Orchestration über ein URL-Fragment mit (Details s. External search) mit den nachfolgend beschriebenen Schema.

Die Aufzählung lässt Anpassungen zu.
Für die Konfiguration von Aufzählungswerten steht ein spezifischer Konfigurationstyp "Externe Suche (Konfiguration)" (ExternalSearchTypeConfiguration) zur Verfügung, der neben dem Feld "Icon-URI" (iconUri) die unten beschriebenen spezifischen Felder vorsieht.

Eine External search kann über den Namen (name) des Aufzählungswerts mit folgender Syntax adressiert werden:

Schema einer URL mit Fragment für eine

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

Die typische Verwendung für eine External search ist der Aufruf einer Übersicht für einen bestimmten Entitätstyp in Verbindung mit spezifischen Suchkriterien, die im URL-Fragment optional angehängte Wertzuweisungen für "Parameter" (<param>, <param2>, usw.) als Variable eingebunden werden können.

Das folgende Beispiel zeigt den Aufruf für eine External search mit den Namen users, für die dem Parameter hasRole der Textwert 1 zugewiesen wird. Das Ziel ist es, eine Übersicht für Users zu öffnen, die nur Konten auflistet, die Zugriff auf die Rolle mit der "ID" (id) 1 ("Super user") haben.

Einfaches Beispiel (relativer Pfad = nur Fragment)

#open=users&hasRole=1

Die Konfiguration für den zugehörigen External search-Typ zeigt die Spalte "Beispiel" in der folgenden Tabelle.

Konfigurationsparameter	Beschreibung	Beispiel
Objekt (`entity`)	Im Combobox sollte der der Entitätstyp ausgewählt werden, den die Zu öffnende View un Berücksichtigung der Suche anzeigen soll.
Zu öffnende View (`viewName`)	Die Zu öffnende View kann wahlweise direkt eingegeben oder nach einem Klich auf das Menüsymbol (rechts) aus der durchsuchbaren Menüstruktur ausgewählt werden. Im ersten Beispiel (rechts oben) wurde der Viewname für die generische "Benutzerübersicht" (`User\|listDetailsWindow`) direkt eingegeben. In der zweiten Variante ist ein als Benutzer lokalisierter Menüpunkt für eine "Eigene Übersicht" ausgewählt, sodass im Textfeld der (interne) Menüknotenname ohne Lokalisierungen (`admin/accounts/XFLOW_USER_DOCU`) erscheint, während in der Hinweiszeile unterhalb der "lokalisierte" Pfad angegeben wird (Verwaltung > Konten > Benutzer). ►HINWEIS◄ Weitere Infos zum Adressieren von Views sind für die Ereignisaktion Open view (Action) dokumentiert.
Zu öffnende View (`viewName`)
Suche (`search`)	Das Suche-Feld definiert eine Suche für den als Objekt ausgewählten Entitätstyp, die zusätzlich zu ggf. für die Zu öffnende View definierten Einschränkungen (im Rahmen einer UND-Junction) angewendet wird. ►HINWEIS◄ Die Erläuterungen zum Öffnen einer Übersicht mit einem `Search`-Objekt (s. Open view (Action)) als "Formulardaten" betreffen auch die Berücksichtigung der Suche für eine External search. Im konkreten Anwendungsfall (rechts) steuert die Suche effektiv nur ihre Bedingung als (zusätzliche) Einschränkung für die View bei: Das einzige Kriterium in der Bedingung ist eine Field restriction, die eine Übereinstimmung zwischen der Property projection für das Listenfeld "Rollen" (`roles`) der prüfenden Users und dem Wert für den "Parameter" `hasRole` aus dem URL-Fragment verlangt, der für den Kontext der Suche als Variable `hasRole` adressiert werden kann. ►HINWEIS◄ Die Konfigurationsoberfläche für die Search beinhaltet einige Parameter, die für eine External search keinen Effekt haben. Neben der Bedingung können nur restriktive Joins eine External search beeinflussen. Sind Joins konfiguriert, wird die gesamte Suche als Sub search-Einschränkung mit der View verknüpft.