Message & Signal Channels
Auf dieser Seite wird anhand eines Beispiels erklärt, was Message & Signal Channels sind und wie man diese verwendet.
Einführung
Channels werden verwendet, um den durch Message Events und Signal Events erzeugten Message/Signal Traffic über Engine Extensions steuern zu können.
Eine Extension, die ein Message/Signal Event empfängt, kann anhand des Channels bestimmen, wohin eine Message/Signal weitergeleitet werden soll. Das kann beispielsweise ein Messagebus System bzw. ein Signalbus System sein, oder aber auch einfach die Engine, von der das Event kam.
Ein passender Name für einen externen Channel könnte beispielsweise ein Message Broker wie RabbitMQ sein.
Sobald ein Channel gesetzt ist, wird die Message/das Signal nicht mehr automatisch von der Engine selbst verarbeitet. Die Verantwortung der korrekten Zustellung liegt damit ausschließlich bei den Extensions.
Um ein Message/Signal Event automatisch innerhalb der sendenden Engine zu verarbeiten, kann der Channel internal verwendet werden.
In diesem Falle erfolgt lediglich eine zusätzliche Ausleitung der Message/des Signals an die angeschlossenen Extensions.
Die Extensions, die auf diese Message/Signal warten, können selbst entscheiden, an welche Empfänger die Message/das Signal weitergereicht wird.
Beispiele
Beispiel mit Messages
Gegeben seien zwei BPMNs mit jeweils zwei sendenden und zwei empfangenden Message Events:
Intermediate Throw Events mit jeweils Message Channel internal und RabbitMQ:

Intermediate Catch Events mit jeweils Message Channel internal und RabbitMQ:

Der erste Prozess verschickt jeweils eine Message an interne und externe Kanäle. Die interne Message wird innerhalb der Engine, die externe Message hingegen nur von der Extension verarbeitet.
Mehr zu Engine-Extensionsfindest du hier (opens in a new tab)
Installation des Beispielprojekts
Das Beispielprojekt für Messages kann unter Download heruntergeladen werden.
Das Beispiel enthält folgende Dateien:
- .gitignore
- docker-compose.yml
- package.json
- README.md
Zum Installieren des Beispiels, navigiert man zum Root-Folder des Beispiels namens message_channels und führt folgenden Befehl aus:
npm installZum Starten des Beispiels führt man folgendem Befehl aus:
docker compose up -dSobald der Docker-Container gestartet ist, kann die Engine unter der Adresse localhost:8000 erreicht werden.
Nun können die im Beispiel enthaltenen Prozesse beliebig getestet werden - beispielsweise über das Studio.
Verschickende Extension
Eine Message wird dann an die Extension message_channel_throwing_extension ausgeleitet (Die jeweiligen Extensions und BPMNs befinden sich unter Download), wenn man im MessageThrowProcess eine externe Message verschickt.
Diese Extension kann nun entscheiden, an welche Empfänger die Message weitergereicht werden soll. In der Praxis kann das beispielsweise ein Message Broker wie RabbitMQ sein.
Mittels der Funktion sendMessageToExternalBus kann hier nun die Logik für das ansteuern eines externen Messagebus implementiert werden.
Im Falle der internen Message, wie im Beispielprozess modelliert, wird die Extension
message_channel_throwing_extension nicht getriggert.
Die Extension dafür könnte so aussehen:
1import { Engine, EngineEvent, EngineEventType, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = (engine: Engine) => {
4 engine.registerEventMiddleware((engineEvent: EngineEvent) => onEvent(engineEvent));
5};
6
7function onEvent(engineEvent: EngineEvent) {
8 // Nur extern konfigurierte Messages sollen an externe Message Broker verschickt werden.
9 let isExternal = false;
10
11 if (engineEvent.currentFlowNode) {
12 isExternal =
13 Object.hasOwn(engineEvent.currentFlowNode, 'messageChannel') &&
14 (engineEvent.currentFlowNode as any).messageChannel === 'RabbitMQ';
15 }
16
17 // Es werden nur Messages ausgeleitet.
18 const isOnMessageTriggeredevent = engineEvent.eventType === EngineEventType.OnMessageTriggered;
19
20 if (isOnMessageTriggeredevent && isExternal) {
21 // Externe Messages werden an den externen Bus weitergeleitet.
22 sendMessageToExternalBus();
23 }
24}
25
26function sendMessageToExternalBus() {
27 /**
28 * In dieser Funktion ist es nun möglich, einen externen Bus anzusteuern.
29 * Die interne Engine, aus der die Message kommt, wird ausgeschlossen.
30 */
31}
321import { Engine, EngineEvent, EngineEventType, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = (engine: Engine) => {
4 engine.registerEventMiddleware((engineEvent: EngineEvent) => onEvent(engineEvent));
5};
6
7function onEvent(engineEvent: EngineEvent) {
8 // Nur extern konfigurierte Messages sollen an externe Message Broker verschickt werden.
9 let isExternal = false;
10
11 if (engineEvent.currentFlowNode) {
12 isExternal =
13 Object.hasOwn(engineEvent.currentFlowNode, 'messageChannel') &&
14 (engineEvent.currentFlowNode as any).messageChannel === 'RabbitMQ';
15 }
16
17 // Es werden nur Messages ausgeleitet.
18 const isOnMessageTriggeredevent = engineEvent.eventType === EngineEventType.OnMessageTriggered;
19
20 if (isOnMessageTriggeredevent && isExternal) {
21 // Externe Messages werden an den externen Bus weitergeleitet.
22 sendMessageToExternalBus();
23 }
24}
25
26function sendMessageToExternalBus() {
27 /**
28 * In dieser Funktion ist es nun möglich, einen externen Bus anzusteuern.
29 * Die interne Engine, aus der die Message kommt, wird ausgeschlossen.
30 */
31}
32Wird beim Auslösen der Message kein Channel-Typ angegeben, wird die Message von allen wartenden Message Events entgegen genommen, die auf eine Message mit passendem Namen warten.
Empfangende Extension
Falls eine Message von einem externen Messagebus von einer Engine Extension empfangen wird, wird in diesem Beispiel die message_channel_receiving_extension verwendet,
um ein Message Event innerhalb der internen Engine zu triggern.
Dafür wird eine Event Middleware mittels der Funktion registerEventMiddleware registriert, die die Schnittstelle, welche auf eine Message von einem externen Messagebus wartet, verwendet.
Wenn dann eine Message empfangen wird, wird die Funktion triggerMessageEvent ausgelöst. Da die Message aus einer externen Quelle kommt, wird der optionale Parameter messageChannel auf RabbitMQ gesetzt.
Dies führt dazu, dass im Beispielprozess MessageReceiveProcess das externe Message Catch Event ausgelöst wird und das interne Message Catch Event nicht ausgelöst wird.
Die Extension dafür könnte so aussehen:
1import { Engine, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = async (engine: Engine) => {
4 /**
5 * Hier wird die unten definierte Funktion `receiveMessageFromExternalBus` asynchron aufgerufen, damit man auf externe Messages warten kann.
6 */
7 await receiveMessageFromExternalBus(engine);
8};
9
10async function receiveMessageFromExternalBus(engine: Engine) {
11 /**
12 * Die Funktion ist ein Platzhalter für das Warten auf einer Message aus einem externen Message Broker.
13 *
14 * Der erste parameter gibt hier den Message Namen an, mit der ein Message Event getriggert werden soll.
15 *
16 * Wenn gewünscht kann mit dem zweiten Parameter eine Payload definiert werden, mit der die Message getriggert werden soll.
17 *
18 * Die restlichen Parameter, außer dem letzten, sind für dieses Beispiel irrelevant und deswegen mit undefined übergeben.
19 * Der letzte Parameter gibt an, welche Art von Message Event getriggert werden soll, also ein Message Event mit bestimmter Message Channel Konfiguration.
20 *
21 * Für dieses Beispiel ist ein externer Trigger vorgesehen. Verwendet wird hierbei das Enum `MessageChannel`.
22 */
23
24 // Nach einer Minute wird das externe Event simuliert
25 await new Promise((resolve) => setTimeout(resolve, 60000));
26
27 engine.triggerMessageEvent(
28 'TriggerMessage',
29 {
30 // myData
31 },
32 undefined,
33 undefined,
34 undefined,
35 'RabbitMQ',
36 );
37}
381import { Engine, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = async (engine: Engine) => {
4 /**
5 * Hier wird die unten definierte Funktion `receiveMessageFromExternalBus` asynchron aufgerufen, damit man auf externe Messages warten kann.
6 */
7 await receiveMessageFromExternalBus(engine);
8};
9
10async function receiveMessageFromExternalBus(engine: Engine) {
11 /**
12 * Die Funktion ist ein Platzhalter für das Warten auf einer Message aus einem externen Message Broker.
13 *
14 * Der erste parameter gibt hier den Message Namen an, mit der ein Message Event getriggert werden soll.
15 *
16 * Wenn gewünscht kann mit dem zweiten Parameter eine Payload definiert werden, mit der die Message getriggert werden soll.
17 *
18 * Die restlichen Parameter, außer dem letzten, sind für dieses Beispiel irrelevant und deswegen mit undefined übergeben.
19 * Der letzte Parameter gibt an, welche Art von Message Event getriggert werden soll, also ein Message Event mit bestimmter Message Channel Konfiguration.
20 *
21 * Für dieses Beispiel ist ein externer Trigger vorgesehen. Verwendet wird hierbei das Enum `MessageChannel`.
22 */
23
24 // Nach einer Minute wird das externe Event simuliert
25 await new Promise((resolve) => setTimeout(resolve, 60000));
26
27 engine.triggerMessageEvent(
28 'TriggerMessage',
29 {
30 // myData
31 },
32 undefined,
33 undefined,
34 undefined,
35 'RabbitMQ',
36 );
37}
38Beispiel mit Signalen
Gegeben seien zwei BPMNs mit jeweils zwei sendenden und zwei empfangenden Signal Events:
Intermediate Throw Events mit jeweils Signal Channel internal und ExternalSignalBroker:

Intermediate Catch Events mit jeweils Signal Channel internal und ExternalSignalBroker:

Der erste Prozess verschickt jeweils ein Signal an interne und externe Kanäle. Das interne Signal wird innerhalb der Engine, das externe Signal hingegen nur von der Extension verarbeitet.
Mehr zu Engine-Extensionsfindest du hier (opens in a new tab)
Installation des Beispielprojekts
Analog zum Beispiel für Message Channels gibt es noch einmal ein vollständiges Beispiel für Signal Channels.
Das Beispielprojekt für Signals kann unter Download heruntergeladen werden.
Das Beispiel enthält folgende Dateien:
- .gitignore
- docker-compose.yml
- package.json
- README.md
Zum Installieren des Beispiels, navigiert man zum Root-Folder des Beispiels namens signal_channels und führt folgenden Befehl aus:
npm installZum Starten des Beispiels führt man folgendem Befehl aus:
docker compose up -dSobald der Docker-Container gestartet ist, kann die Engine unter der Adresse localhost:8000 erreicht werden.
Nun können die im Beispiel enthaltenen Prozesse beliebig getestet werden - beispielsweise über das Studio.
Verschickende Extension
Ein Signal wird dann an die Extension signal_channel_throwing_extension ausgeleitet (Die jeweiligen Extensions und BPMNs befinden sich unter Download), wenn man im SignalThrowProcess ein externes Signal verschickt.
Diese Extension kann nun entscheiden, an welche Empfänger das Signal weitergereicht werden soll. In der Praxis kann das beispielsweise ein Signal Broker sein.
Mittels der Funktion sendSignalToExternalBus kann hier nun die Logik für das ansteuern eines externen Signalbus implementiert werden.
Im Falle des internen Signals, wie im Beispielprozess modelliert, wird die Extension
signal_channel_throwing_extension nicht getriggert.
Die Extension dafür könnte so aussehen:
1import { Engine, EngineEvent, EngineEventType, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = (engine: Engine) => {
4 engine.registerEventMiddleware((engineEvent: EngineEvent) => onEvent(engineEvent));
5};
6
7function onEvent(engineEvent: EngineEvent) {
8 // Nur extern konfigurierte Signals sollen an externe Signal Broker verschickt werden.
9 let isExternal = false;
10
11 if (engineEvent.currentFlowNode) {
12 isExternal =
13 Object.hasOwn(engineEvent.currentFlowNode, 'signalChannel') &&
14 (engineEvent.currentFlowNode as any).signalChannel === 'ExternalSignalBroker';
15 }
16
17 // Es werden nur Signals ausgeleitet.
18 const isOnSignalTriggeredevent = engineEvent.eventType === EngineEventType.OnSignalTriggered;
19
20 if (isOnSignalTriggeredevent && isExternal) {
21 // Externe Signals werden an den externen Bus weitergeleitet.
22 sendSignalToExternalBus();
23 }
24}
25
26function sendSignalToExternalBus() {
27 /**
28 * In dieser Funktion ist es nun möglich, einen externen Bus anzusteuern.
29 * Die interne Engine, aus der das Signal kommt, wird ausgeschlossen.
30 */
31}
321import { Engine, EngineEvent, EngineEventType, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = (engine: Engine) => {
4 engine.registerEventMiddleware((engineEvent: EngineEvent) => onEvent(engineEvent));
5};
6
7function onEvent(engineEvent: EngineEvent) {
8 // Nur extern konfigurierte Signals sollen an externe Signal Broker verschickt werden.
9 let isExternal = false;
10
11 if (engineEvent.currentFlowNode) {
12 isExternal =
13 Object.hasOwn(engineEvent.currentFlowNode, 'signalChannel') &&
14 (engineEvent.currentFlowNode as any).signalChannel === 'ExternalSignalBroker';
15 }
16
17 // Es werden nur Signals ausgeleitet.
18 const isOnSignalTriggeredevent = engineEvent.eventType === EngineEventType.OnSignalTriggered;
19
20 if (isOnSignalTriggeredevent && isExternal) {
21 // Externe Signals werden an den externen Bus weitergeleitet.
22 sendSignalToExternalBus();
23 }
24}
25
26function sendSignalToExternalBus() {
27 /**
28 * In dieser Funktion ist es nun möglich, einen externen Bus anzusteuern.
29 * Die interne Engine, aus der das Signal kommt, wird ausgeschlossen.
30 */
31}
32Wird beim Auslösen des Signals kein Channel-Typ angegeben, wird das Signal von allen wartenden Signal Events entgegen genommen, die auf ein Signal mit passendem Namen warten.
Empfangende Extension
Falls ein Signal von einem externen Signalbus von einer Engine Extension empfangen wird, wird in diesem Beispiel die signal_channel_receiving_extension verwendet,
um ein Signal Event innerhalb der internen Engine zu triggern.
Dafür wird eine Event Middleware mittels der Funktion registerEventMiddleware registriert, die die Schnittstelle, welche auf ein Signal von einem externen Signalbus wartet, verwendet.
Wenn dann ein Signal empfangen wird, wird die Funktion triggerSignalEvent ausgelöst. Da das Signal aus einer externen Quelle kommt, wird der optionale Parameter signalChannel auf ExternalSignalBroker gesetzt.
Dies führt dazu, dass im Beispielprozess SignalReceiveProcess das externe Signal Catch Event ausgelöst wird und das interne Signal Catch Event nicht ausgelöst wird.
Die Extension dafür könnte so aussehen:
1import { Engine, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = async (engine: Engine) => {
4 /**
5 * Hier wird die unten definierte Funktion `receiveSignalFromExternalBus` asynchron aufgerufen, damit man auf externe Signale warten kann.
6 */
7 await receiveSignalFromExternalBus(engine);
8};
9
10async function receiveSignalFromExternalBus(engine: Engine) {
11 /**
12 * Die Funktion ist ein Platzhalter für das Warten auf ein Signal aus einem externen Signal Broker.
13 *
14 * Der erste parameter gibt hier den Signal Namen an, mit der ein Signal Event getriggert werden soll.
15 *
16 * Wenn gewünscht kann mit dem zweiten Parameter eine Payload definiert werden, mit der das Signal getriggert werden soll.
17 *
18 * Die restlichen Parameter, außer dem letzten, sind für dieses Beispiel irrelevant und deswegen mit undefined übergeben.
19 * Der letzte Parameter gibt an, welche Art von Signal Event getriggert werden soll, also ein Signal Event mit bestimmter Signal Channel Konfiguration.
20 *
21 * Für dieses Beispiel ist ein externer Trigger vorgesehen.
22 */
23
24 // Nach einer Minute wird das externe Event simuliert
25 await new Promise((resolve) => setTimeout(resolve, 60000));
26
27 engine.triggerSignalEvent(
28 'TriggerSignal',
29 {
30 // myData
31 },
32 undefined,
33 undefined,
34 undefined,
35 'ExternalSignalBroker',
36 );
37}
381import { Engine, OnLoad } from '@5minds/processcube_engine_sdk';
2
3export const onLoad: OnLoad = async (engine: Engine) => {
4 /**
5 * Hier wird die unten definierte Funktion `receiveSignalFromExternalBus` asynchron aufgerufen, damit man auf externe Signale warten kann.
6 */
7 await receiveSignalFromExternalBus(engine);
8};
9
10async function receiveSignalFromExternalBus(engine: Engine) {
11 /**
12 * Die Funktion ist ein Platzhalter für das Warten auf ein Signal aus einem externen Signal Broker.
13 *
14 * Der erste parameter gibt hier den Signal Namen an, mit der ein Signal Event getriggert werden soll.
15 *
16 * Wenn gewünscht kann mit dem zweiten Parameter eine Payload definiert werden, mit der das Signal getriggert werden soll.
17 *
18 * Die restlichen Parameter, außer dem letzten, sind für dieses Beispiel irrelevant und deswegen mit undefined übergeben.
19 * Der letzte Parameter gibt an, welche Art von Signal Event getriggert werden soll, also ein Signal Event mit bestimmter Signal Channel Konfiguration.
20 *
21 * Für dieses Beispiel ist ein externer Trigger vorgesehen.
22 */
23
24 // Nach einer Minute wird das externe Event simuliert
25 await new Promise((resolve) => setTimeout(resolve, 60000));
26
27 engine.triggerSignalEvent(
28 'TriggerSignal',
29 {
30 // myData
31 },
32 undefined,
33 undefined,
34 undefined,
35 'ExternalSignalBroker',
36 );
37}
38