Öffne Portal

Aktionen - Kurzfassung

Die Aktion Öffne Portal öffnet das angegebene Portal.

images/download/attachments/189434918/image-2024-10-17_11-27-31-version-1-modificationdate-1729157250743-api-v2.png

Die Aktion Öffne Portal öffnet ein bestimmtes Portal unter Berücksichtigung umfangreicher Konfigurationsmöglichkeiten, die in den folgenden Abschnitten detailliert erläutert werden:

Abschnitt

Betrifft

Auswahl des zu öffnenden Portals

Zielelement und/oder Auswahl im Dropdown (unter Typ der Aktion)

Datenzuweisung an das geöffnete Portal

Verhaltensdaten ($input) oder Option Mit leeren Daten

Parameter für das Öffnen des Portals

  • Nur eine Instanz, Modal, Volle Größe / Größe veränderbar, Schließbar

Abläufe beim Schließen des Portals

  • Verhalten nach Schließen ausführen (ggf. mit Rückgabedaten aus einer Schließen anfordern-Aktion)

Konfiguration

Auswahl des zu öffnenden Portals

WICHTIG◄ Das zu öffnende Portal muss einerseits grundsätzlich existieren und mindestens einmal veröffentlicht worden sein. Andererseits muss es auch zum Zeitpunkt des Aufrufs im Kontext und mit den wirksamen Berechtigungen der aktuellen Sitzung zugeordnet sein (siehe Zuordnungskriterien, Firmenfreigaben). Anderenfalls wird die Aktion mit einem Fehler ("Portal not registered") abgebrochen, der nur in der Entwicklerkonsole des Browsers nachvollziehbar ist. Ggf. nachfolgende Aktionen werden allerdings trotzdem ausgeführt.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg ACHTUNG images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg Wird einem Portal ein neuer Portalname zugewiesen, erfolgt keine automatische Anpassung der Referenzen.

Für die Definition des zu öffnenden Portals gibt es zwei Methoden, die ggf. auch in Kombination genutzt werden können:

  • Ist für die Aktion ein Zielelement verknüpft, das zur Laufzeit einen Textwert zurückgibt, dann wird dieser als Name des zu öffnenden Portals verwendet.

    • Der Name muss unter Beachtung der Groß-/Kleinschreibung exakt einem Portalnamen entsprechen.

    • Besteht zur Laufzeit kein Zugriff auf ein Portal mit dem angegebenen Namen, dann bricht die Aktion ab (s. ►WICHTIG◄ oben).

  • Ist kein Zielelement verknüpft oder liefert das verknüpfte Zielelement zur Laufzeit keinen Wert ($null), dann wird die optionale statische Definition eines Portals in der Konfiguration der Aktion ausgewertet:

    • Die unbeschriftete Combobox unterhalb von Typ der Aktion bietet sämtliche Portale zur Auswahl an, für deren Konfiguration im Kontext der Sitzung Lesezugriff besteht.

    • Ob diesen Portalen Zuordnungskriterien zugewiesen sind und ob diese aktuell treffen, beeinflusst die Auswahlmöglichkeit per Dropdown nicht.

    • Zur Laufzeit muss das angegebene Portal allerdings "greifbar" sein, wenn es geöffnet werden soll, sonst bricht die Aktion ab (s. ►WICHTIG◄ oben).

ANMERKUNG◄ Im Unterschied zu anderen Konfigurationselementen muss jeder "Portalname" systemweit eindeutig sein. Zuordnungskriterien (und deren Sichtbarkeit im Kontext einer einer Sitzung) kontrollieren daher zwar den Zugriff auf ein eindeutig adressiertes Portal. Eine Auswahlentscheidung zwischen Alternativen, wie beim Adressieren einer View über den angegebenen Kontext (s. Öffne View (Formulardesigner)), spielt dagegen keine Rolle.

Datenzuweisung an das geöffnete Portal

Per Standard werden dem geöffneten Portal die anliegenden Verhaltensdaten ($input) zugewiesen. Sofern keine spezifischeren Mechanismen erforderlich sind, ermöglicht die Verhaltensweise Element validieren zur Vorbereitung einer "Zuweisung" von (validen) Elementdaten aus dem aktuellen Formular an das geöffnete Portal.

  • Die Option Mit leeren Daten sollte dringend gesetzt werden, wenn ein Portal zuverlässig ohne Datenzuweisung geöffnet werden soll. Wenn beispielsweise in einem Verhalten für einen Button der Auslöser Angeklickt mit einer Verhaltensweise Statisch kombiniert wird, um die Aktion Öffne Portal auszuführen, würde ohne diese Option der Standardwert true (als $input vom Button) dem geöffneten Portal als Formulardaten zugewiesen, was dort unerwünschte Effekte hervorrufen kann.

Parameter für das Öffnen des Portals

Parameter

Wirkung

Nur eine Instanz

Das Setzen der Option Nur eine Instanz bewirkt, dass die Aktion zur Laufzeit prüft, ob in der aktuellen Sitzung bereits eine Instanz des adressierten Portals geöffnet ist.

  • Ist dieser der Fall, wird keine zusätzliche Instanz desselben Portals geöffnet.

    • Stattdessen werden der bereits geöffneten Instanz abhängig von der Option Mit leeren Daten entweder "leere Daten" (Option gesetzt) oder die aktuellen Verhaltensdaten (Option nicht gesetzt) zugewiesen.

    • Sofern die Aktion den Parameter Verhalten nach Schließen ausführen (s. u.) verwendet, wird eine entsprechende "Vormerkung" für die bestehende Instanz registriert. Beim Schließen werden dann sämtliche registrierten Verhaltensaufrufe abgearbeitet, auch wenn dabei dabei dasselbe Verhalten mehrfach ausgeführt wird, etwa weil ein Button zum Öffnen des Portals mehrfach betätigt wurde.

  • Existiert noch keine Instanz des Portals, wird ein geöffnet.

Ist die Option Nur eine Instanz nicht gesetzt, wird immer eine neue eigenständige Instanz des Portals geöffnet.

Modal

Das Setzen der Option Modal aktiviert eine Reihe abhängiger Parameter (in dieser Tabelle gekennzeichnet durch das vorangestellte Symbol "└" im Spaltentitel) und wirkt ansonsten wie folgt:

  • Das adressierte Portal wird ohne Beachtung der Option Nur eine Instanz grundsätzlich als neue Instanz neu geöffnet, belegt aber nicht einen eigenständigen View Slot, sondern wird im Kontext des aktuellen "überlagert".

  • Die Instanz wird innerhalb des View Slots als "modales Fenster" behandelt, was bedeutet, das in diesem View Slot bis zum Schließen der Instanz keine Aktivitäten außerhalb des Portals mehr zulässig sind. Der View Slot kann allerdings insgesamt geschlossen werden.

  • Im Ribbon-Menü eines "modal" geöffneten Portals wird der Ribbon-Button Zurück (mit dem Symbol "<") angezeigt, über die Das Portal geschlossen werden kann, um zum aufrufenden Formular zurückzukehren.
    HINWEIS◄ Dabei wird ein über den Parameter Verhalten nach Schließen ausführen angegebenes Verhalten ausgeführt. Dieses erhält aber keine Daten aus dem Portal zugewiesen.

Ohne die Option Modal belegt jede geöffnete Instanz eines Portal einen eigenständigen View Slot.

└ Volle Größe

Die Option Volle Größe bewirkt, dass ein "modal" geöffnetes Portal beim Öffnen die gesamte Fläche des aktuellen View Slots ausnutzt und das aufrufende Formular verdeckt.
Ist diese Option abgewählt, werden zusätzliche Einstellungen für die Größe eingeblendet (Breite, Höhe, Mindestbreite und Mindesthöhe). Die Angaben sind im Pixelmaß anzugeben.

└ Schließbar

Die Option Schließbar entscheidet, ob im Fenstertitel des "modal" geöffneten Portals das Symbol "X" zum Schließen des Portals erscheint oder nicht.

  • Das "Schließen" per Klick auf dieses Symbol wird wie ein Klick auf den Ribbon-Button Zurück (mit dem Symbol "<") interpretiert.
    HINWEIS◄ Dabei wird ein über den Parameter Verhalten nach Schließen ausführen angegebenes Verhalten ausgeführt. Dieses erhält aber keine Daten aus dem Portal zugewiesen.

└ Größe veränderbar

Die Auswahl für Größe veränderbar legt fest, ob und ggf. in welcher Hinsicht (Höhe/Breite) der Benutzer die Fenstergröße eines "modal" geöffneten Portals ändern darf.

  • Ist die Option Volle Größe gesetzt, wird die Auswahl für Größe veränderbar ignoriert.

Abläufe beim Schließen des Portals

Der optionale Parameter Verhalten nach Schließen ausführen ermöglicht die Auswahl eines für das aufrufende Formularelement konfigurierten Verhaltens.

  • Dieses Verhalten wird ausgeführt, sobald das Fenster mit dem adressierten Portal geschlossen wird.

  • Abhängig von den Optionen Nur eine Instanz, Modal und Schließbar greifen die dort beschriebenen Details.

WICHTIG◄ Daten aus dem geöffneten Portal werden an das "Verhalten nach Schließen" nur weitergegeben, wenn dort per Aktion Schließen anfordern mit entsprechenden Eingabedaten ausgeführt wird.

Beispiel

Aufgabenstellung

In einem einem Portal "Meeting planen" sollen die Teilnehmer des geplanten Meetings festgelegt werden, indem die Daten existierender Benutzer von Lobster Data Platform / Orchestration einem Datengrid ("Teilnehmerliste") als neue Zeilen hinzugefügt werden:

  • Zur Auswahl der Teilnehmer wird beim Klick auf den Button "Suche" ein bestimmtes Suchportal modal geöffnet (s. roter Pfeil).

  • Per Auswahlfeld/Combobox "Suchprofil" bietet das aufrufende Portal zwei alternative Methoden ("Benutzername" oder "Benutzername ODER Name 1-3") zur Auswahl an. Jeder Auswahl entspricht ein Suchportal, dessen Portalname als statischer Schlüsselwert hinterlegt ist.

  • Das ausgewählte Suchportal bietet unter Berücksichtigung eines Suchtexts aus dem ausrufenden Portal ("... enthält ...") in einem Datengrid "passende" Benutzer zum Anklicken an (s. grüner Pfeil).

  • Beim Klick auf einen der gefundenen Benutzer im Suchportal wird dieses geschlossen und der betreffende Eintrag der "Teilnehmerliste" im aufrufenden Portal hinzugefügt (s. oranger Pfeil).

  • Die Suche soll auch ohne eine Auswahl beendet werden können, indem das "X" Symbol rechts oben im modalen Fenster geklickt wird.

images/download/attachments/189434918/image2020-5-18_13-18-54-version-1-modificationdate-1729157243901-api-v2.png

Konfiguration

Nachfolgend wird nur die Konfiguration für Komponenten ausführlich beschrieben, die direkt mit der Öffne Portal-Aktion zu tun haben.

Verhalten zum Aufruf des Suchportals:

images/download/attachments/189434918/image2020-5-18_13-50-58-version-1-modificationdate-1729157243892-api-v2.png

  • Für den Button "Suche" wird ein Verhalten "userSearch" eingerichtet, das auf den Auslöser Angeklickt reagiert (roter Pfeil).

  • Die Verhaltensweise Element validieren wird mit dem Spaltenlayout-Element (# 9) angewendet, das das Textfeld für das Suchkriterium mit der Beschriftung "... enthält ..." enthält (grüner Kasten, grüner Pfeil). Damit stehen die betreffenden Elementdaten im weiter unten per Aktion geöffneten Portal zur Verfügung. Hier wurde dem Textfeld das Datenfeld criterion zugewiesen, mit dem auch im Suchportal (s. u.) gearbeitet wird.

  • Die Aktion Öffne Portal gibt als Zielelement das Auswahlfeld/Combobox "Suchprofil" an. Dieses liefert den Namen eines der alternativ verwendbaren Suchportale (USER_SEARCH_SIMPLE oder USER_SEARCH_ADVANCED) als Textwert auf der Basis der folgenden Service-Konfiguration:

    images/download/attachments/189434918/image2020-5-18_15-31-56-version-1-modificationdate-1729157243880-api-v2.png


    Außerdem verweist das Dropdown in der Konfiguration auf das Portal USER_SEARCH_SIMPLE als Standard, falls keine Auswahl getroffen wird.

  • Die Option Mit leeren Daten ist nicht gesetzt, damit die Verhaltensdaten (mit dem Suchkriterium) an das Suchportal zugewiesen werden. Weitere Details hierzu beschreibt die Konfiguration der Suchportals (unten).

  • Das Portal soll Modal und Schließbar geöffnet werden und hinsichtlich Breite und Höhe angepasst werden können (s. Größe veränderbar).

  • Der Parameter Verhalten nach Schließen ausführen verweist auf ein weiteres Verhalten "addToList" das für denselben Button ("Suche") definiert sein muss und die Verarbeitung des Rückgabewerts vom Suchportal (orange Pfeile) definiert.

Konfiguration im Suchportal:

Hier wird nur das Suchportal USER_SEARCH_SIMPLE dargestellt. Das alternative Suchportal USER_SEARCH_ADVANCED ist analog aufgebaut, verwendet aber eine abweichende Bedingung für die Tupel Suche (Formulardesigner).

images/download/attachments/189434918/image2020-5-18_14-32-38-version-1-modificationdate-1729157243890-api-v2.png

  • Das Textfeld "Benutzername enthält" verweist auf das Datenfeld criterion (passend zum Textfeld "... enthält..." im aufrufenden Portal) und wird deshalb beim Öffnen des Portals mit demselben Text belegt.

  • Für dieses Textfeld ist das rechts abgebildete Verhalten definiert, das auf den Auslöser Geändert mit allen Änderungstypen reagiert. Effektiv ist hier nur "Formulardaten geladen" als Änderungstyp relevant, da Wertänderungen innerhalb des Formulars nicht vorgesehen sind.

  • Die Verhaltensweise Tupel Suche (Formulardesigner) verwendet eine Verknüpfung auf das im Bild grün markierte Spaltenlayout. Die im Textfeld "Benutzername enthält ..." übergebene Zeichenfolge steht damit innerhalb der Such-Konfiguration als Wert einer Variablen mit dem Namen criterion (Datenfeldname des Textfelds) zur Verfügung. Die Tupel Suche (Formulardesigner) soll nur Daten von Benutzern zurückgeben, deren Benutzername (username) diesen Wert enthält. Das wird z. B. durch die folgende Feld Einschränkung in der Bedingung der Tupel Suche (Formulardesigner) erreicht:

    images/download/attachments/189434918/image2020-5-18_14-55-15-version-1-modificationdate-1729157243888-api-v2.png
  • Das Suchergebnis der Tupel Suche (Formulardesigner), Projektionen für die Felder ID (id), Benutzername (username), Name 1 (address.name1), Name 2 (address.name2) und Name 3 (address.name3), wird per Grid: Füllen-Aktion dem Datengrid "Benutzer" zugewiesen. Dessen Spaltenkonfiguration verwendet die Datenfeldbezeichner id, username, address_name1, address_name2, address_name3 für die entsprechenden Spalten. Dabei ist wichtig, dass bei den drei Name-Feldern ein Unterstrich anstelle des Punkts verwendet werden muss, da in der Tupel-Suche automatisch ein entsprechender Alias erzeugt wird.

images/download/attachments/189434918/image-2024-10-17_11-43-37-version-1-modificationdate-1729158216893-api-v2.png

Für das Datengrid "Benutzer" wird das links abgebildete Verhalten konfiguriert:

  • Der Auslöser Eintrag Klick liefert als Verhaltensdaten den angeklickten Eintrag des Grids.


  • Daher wird hier die Verhaltensweise Statisch (mit dem Standardwert "wahr") verwendet, die diese Daten an die Aktionen bei "wahr" weitergibt.


  • Dort wird eine Schließen anfordern-Aktion ausgeführt, mit der die im Datengrid ausgewählte Zeile an das aufrufende Portal zurückgeben wird.

Verhalten nach Schließen des Suchportals:

images/download/attachments/189434918/image-2024-10-17_11-47-54-version-1-modificationdate-1729158473812-api-v2.png

Um das Suchportal zu schließen muss entweder ein Klick auf eine Zeile erfolgen, was die Schließen anfordern Aktion mit den Daten der Zeile auslöst, oder das Symbol "X" im Fenstertitel wird angeklickt, um das modale Suchportal ohne Auswahl zu beenden. Dann lautet der Rückgabewert $null. In beiden Fällen wird das im Parameter Verhalten nach Schließen ausführen angegebene Verhalten (hier: "addToList") ausgeführt, für das deshalb eine Fallunterscheidung zu empfehlen ist.

  • Hier soll die Verhaltensweise Berechnen per Prüfungsausdruck untersuchen, ob der Rückgabewert aus dem Portal "leer" ist ($null) oder nicht. Der verwendete Ausdruck
    $not($isEmpty($input)) leitet das Ergebnis aus dem Berechnungsausdruck ($input) nur dann an die Aktionen bei "wahr" weiter, falls dieser nicht $null, also "empty" (leer), liefert (s. Funktionen not (logische Negierung) und ifEmpty).


  • Unter den Aktionen bei "wahr" überträgt die Grid: Zeile(n) hinzufügen-Aktion dann anliegende Zeilendaten an das als Zielelement verknüpfte Datengrid "Teilnehmerliste".


  • Die Aktionen bei "falsch" sehen dagegen lediglich eine Hinweis anzeigen-Aktion vor, die dem Benutzer den Abbruch der Suche bestätigt.