Nachricht pushen

Siehe auch: Client Workflows, Nachricht abonnieren (Formular)

Ereignisaktion - Kurzfassung
Zweck: Versendet ein beliebige als Payload bezeichnete Nachricht an Subscriber für ein über eine eindeutige Zeichenfolge referenziertes Topic.
Tooltip
Verwendung: Die Ereignisaktion definiert über die Parameter Auf eigene Sitzung einschränken, Topic und (optional) Berechtigungen, an welche Subscriber (zugewiesene Client Workflows oder geöffnete Formulare mit Nachricht abonnieren (Formular)-Elementen in aktiven Sitzungen eine als Payload beliebig definierbare "Nutzlast" empfangen sollen. Ob/Wie das übergebene Datenobjekt vom Subscriber verarbeitet wird, regeln dortige Konfigurationen (Client Workflow, Verhalten).
Parameter:
Die Option Auf eigene Sitzung einschränken (per Standard abgewählt) kann ausgewählt werden, um nur Subscriber innerhalb derselben Sitzung zu adressieren, in der die Ereignisaktion ausgelöst wird.
Der Parameter Topic dient zur eindeutigen Bezeichnung eines "Kanals" für Push-Nachrichten durch einen statisch oder per Wert-Konfiguration bestimmten Textwert, der in Subscriber-Konfigurationen exakt übereinstimmend definiert sein muss, damit Nachrichten empfangen werden.
Die Wert-Konfiguration für den Parameter Payload definiert optional die "Nutzlast" der Nachricht: Ein beliebiges Datenobjekt, das an alle legitimen Subscriber zur spezifischen Verarbeitung übergeben wird.
Optional können Anforderungen an die Berechtigungen für relevante Subscriber analog zum Regeltyp Auf Berechtigung prüfen definiert werden.
Hinweis: Die Ereignisaktion steht ausschließlich in Ereignisbehandlungen zur Verfügung. Nachrichten werden immer vom Server zu Client-Sitzungen "gepusht".
Warnung: Umfangreiche Datenobjekte (z. B. Mediendateien) sollten mit Rücksicht auf die Performance möglichst nicht als Payload einer Nachricht gepusht werden.

images/download/attachments/177905205/image-2024-12-16_14-5-53-version-1-modificationdate-1734354352854-api-v2.png

Die Nachricht pushen-Ereignisaktion versendet ein beliebige als Payload (en,: "Nutzlast") bezeichnete Nachricht an Subscriber (engl.: "Abonnenten") für ein über eine eindeutige Zeichenfolge referenziertes Topic (engl.: "Thema").

►HINWEIS◄ Bei dem als Payload definierten Nachrichteninhalt kann es sich rein technisch um "Kein Wert" ($null), einen simplen Wert (z. B. Zeichenfolge, Zahlenwert, usw.) oder ein beliebig strukturiertes komplexes Datenobjekt handeln. Da die Payload-Daten ggf. an sehr viele Sitzungen gleichzeitig "ausgeliefert" werden müssen, sollte man mit Blick auf die Performance auf den Versand umfangreicher Datenmengen (etwa eine Mediendatei oder ein "großes" Dokument) verzichten.

Als Subscriber gelten alle Prozesse in mit dem Lobster Data Platform / Orchestration-Server verbunden Client-Sitzungen, die ...

zum Zeitpunkt des Versands der Push-Nachricht bereits ausgeführt werden, ...
sich auf das betreffende Topic beziehen und ...
von ggf. in der Nachricht pushen-Ereignisaktion parametrierten Kriterien (Option Auf eigene Sitzung einschränken und Anforderungen für Berechtigungen - s. Abschnitt "Konfiguration") betroffen sind.

Als Subscriber-Prozesse kommen einerseits Client Workflows in Frage, die aufgrund von anwendbaren Zuordnungskriterien in der Menüstruktur der betreffenden Client-Sitzung enthalten sind (ggf. auch mit dem Modus "Versteckt").

Andererseits kann sich ein "Abonnement" auf in Formularen (Erfassungsmasken, Portale, Dashboard) platzierte Serviceelemente vom Typ Nachricht abonnieren (Formular) stützen, die in der betreffenden Client-Sitzung geöffnet sind.

Ob und ggf. wie der jeweilige Subscriber auf das Eintreffen einer Push-Nachricht reagiert, entscheiden für Client Workflows die jeweils zugeordneten Ereignisaktionen und für Formulare die über den Auslöser "Nachricht empfangen" ausgelösten Verhalten.

►WICHTIG◄ Solange für einen Subscriber kein Prozess (Client Workflow bzw. Verhalten) definiert ist, ist auch keine Wirkung für die Nachricht pushen-Ereignisaktion in der betreffenden Client-Sitzung zu erwarten.

Konfiguration

Die Nachricht pushen-Ereignisaktion erwartet kein spezifisches Bezugsobjekt. Ein vorliegendes Bezugsobjekt steht allerdings als Eingabewert für Wert-Konfigurationen in Parametern zur Verfügung.

Parameter	Beschreibung	Beispiel
Auf eigene Sitzung einschränken Option	Die Option Auf eigene Sitzung einschränken ist in der Benutzeroberfläche als Checkbox-Element mit genau zwei Zuständen definiert: Ist die Option abgewählt (Standard), dann wird die Payload an relevante Subscriber in allen aktiven Sitzungen übertragen. Wird die Option ausgewählt, dann erhalten ausschließlich relevante Subscriber innerhalb der Sitzung die Payload, in der die Nachricht pushen-Ereignisaktion ausgeführt wird.
Topic Textfeld / Wert-Konfiguration	Der Parameter Topic dient zur eindeutigen Bezeichnung eines "Kanals" für Push-Nachrichten durch einen Textwert: Per Standard erscheint ein Textfeld-Element, das zur Direkteingabe von statischem Text verwendet werden kann. Alternativ kann (nach einem Klick auf den kleinen grauen Pfeil links unten im Textfeld) eine Wert-Konfiguration definiert werden, deren Rückgabewert ein String ist oder in einen String umgewandelt wird. Der als Topic definierte Textwert muss mit der Zeichenfolge in Konfigurationen für Subscriber exakt übereinstimmen (unter Beachtung der Groß-/Kleinschreibung), damit ein Subscriber auf die Nachricht reagiert.
Topic Textfeld / Wert-Konfiguration	►WICHTIG◄ Falls vom Rückgabewert der Wert-Konfiguration für das Topic ein String-Abbild erstellt werden muss geschieht dies nach den serverseitigen Standards, weil dies dem Ausführungskontext der Ereignisbehandlung entspricht. Anstelle eines Dynamischen Aufzählungswerts wird z. B. der interne Name (`name`) zurückgegeben. Innerhalb von Client Workflows, die als Subscriber für dasselbe Topic qualifiziert werden sollen, liefert dieselbe Wert-Konfiguration abhängig vom Datentyp des Rückgabewerts eventuell ein abweichendes String-Abbild. Für einen Dynamischen Aufzählungswert wird z. B. die im Client anwendbare Lokalisierung zurückgegeben, die im Allgemeinen nicht identisch mit dem internen Namen ist. Das Risiko von "Missverständnissen" bei der Zuordnung von Push-Nachrichten zu Subscribern kann minimiert werden, indem man beim Versender und beim Subscriber explizit Wert-Konfigurationen einrichtet, die zuverlässig übereinstimmende Strings liefern. Für das Beispiel im Bild stellt der Objekt-Feld-Wertauflöser klar, dass der interne Name (`name`) für das Land aus dem Adressfeld "Land" (`countryCode`) der Firma der Session als Topic verwendet wird. Für eine Firmenadresse in der Schweiz würde als Topic die Zeichenfolge `CH` zugewiesen.
Payload Wert-Konfiguration	Die Payload für die Push-Nachricht kann optional über eine Wert-Konfiguration definiert werden, deren Rückgabewert direkt (und nicht etwa als String-Abbild) an alle relevanten Subscriber übergeben wird. Im Beispiel rechts wird eine Liste von Textwerten (`String[]`) aus einer Variable als Payload zugewiesen, die unterschiedliche Subscriber in spezifischer Form verarbeiten können.
Berechtigungen Aufklappbar-Element	Innerhalb des Aufklappbar (Expandable)-Elements für den Parameter Berechtigungen können optional die Parameter für den Regeltyp Auf Berechtigung prüfen (Details s. dort) verwendet werden, um die Zustellung einer Push-Nachricht an Berechtigungen innerhalb einer Subscriber-Sitzung für das Topic zu binden. Im Beispiel rechts wurden über den Auswählen-Button die Berechtigungen zum Ansehen und Erstellen für Dokumente ausgewählt, die mit ausgewählter Option Alle müssen zutreffen beide im Subscriber-Sitzung vorliegen müssen, damit die Push-Nachricht dort empfangen werden kann.