External Task Worker programmieren
Erklärung
In der prozessorientierten Softwareentwicklung gibt es häufig Szenarien, in denen bestimmte Aufgaben innerhalb eines Prozesses von einem externen System übernommen und bearbeitet werden sollen. Ein typisches Beispiel ist die Abwicklung einer Bestellung durch ein Warenwirtschaftssystem, wie es in unserem Fallbeispiel der Fall ist. In unserem Prozess wird die Bestellung in einem solchen System verbucht.
Dies ist besonders sinnvoll, wenn vorhandene Infrastruktur weiter genutzt werden soll.
Die Integration solcher Systeme kann auf verschiedene Weise erfolgen. Eine gängige Methode ist die Verwendung von External Service Tasks, oder abkürzend auch External Tasks genannt. Dabei wird Programmcode einer Anwendung ausgeführt, die außerhalb des Prozesses liegt (in diesem Fall unsere Next.js-Applikation), der dann auf das externe System zugreift. Der Vorteil von External Tasks liegt darin, dass handgeschriebener Code mit allen benötigten Funktionalitäten eingesetzt werden kann – ähnlich wie bei einem "Microservice". Die Engine wartet, bis der External Task abgeschlossen ist, bevor der Prozess fortgeführt wird.
"Bestellung verbuchen"-External Task Worker erstellen
Die Einbindung von External Task Workern ist unkompliziert, da das 5Minds-App.SDK bereits viel Arbeit abnimmt. Auch hier verwenden wir eine sinnvolle Ordnerstruktur, um die Übersichtlichkeit zu wahren.
Der External Task Worker wird innerhalb unserer Next.js App in einem neuen Ordner Bestellung-verbuchen/Bestellungen_verbuchen abgelegt, also nach dem Schema Prozessname/Taskname.
In diesem Fall ist eine Spezifizierung für die jeweilige Instanz auf der Anwendungsseite nicht erforderlich, da der Ablauf des External Tasks immer gleich ist. Die Engine stellt eine Aufgabe bereit, die erledigt werden muss, und eine Anwendung übernimmt diese Aufgabe, bearbeitet sie und gibt das Ergebnis zurück. Es ist daher nicht notwendig, spezielle Seiten anzuzeigen oder die Prozessinstanz-ID in einer URL zu berücksichtigen.
export default async function (payload: Record<string, any>): Promise<Record<string, any>> {
console.log('Verbuche Bestellungen...');
console.log('Payload:', payload);
// Hier würde die eigentliche Verbuchung der Bestellung stattfinden.
console.log('Bestellungen verbucht.');
return {
verbuchteBestellungen: payload,
};
}External Task Worker registrieren
Dieser Part ist nur notwendig, wenn anfangs beim Erstellen des Projekts die Frage "Would you like to use External
Tasks?" mit No beantwortet wurde. Andernfalls kann mit dem nächsten Abschnitt Topic fortgefahren werden.
Damit sich die Anwendung mit der Engine verbinden und auf External Tasks subscriben kann, muss in der next.config.js die entsprechende Funktionalität aus dem App.SDK integriert werden.
Die Datei sollte danach wie folgt aussehen:
const { withApplicationSdk, NextConfigWithApplicationSdkConfig } = require('@5minds/processcube_app_sdk/server');
/** @type {import('next').NextConfig} */
const nextConfig = {};
/** @type {NextConfigWithApplicationSdkConfig} */
const nextConfigWithApplicationSdkConfig = {
...nextConfig,
applicationSdk: {
useExternalTasks: true,
},
};
module.exports = withApplicationSdk(nextConfigWithApplicationSdkConfig);Topic
Die Art eines External Tasks wird über ein so genanntes Topic bestimmt. Dieses beschreibt, welche fachliche Aufgabe der External Task innerhalb des Prozesses zu erfüllen hat.
Entsprechend wird das Topic auch verwendet um zu bestimmen, wie der zuständige External Task Worker implementiert werden muss, um den External Task korrekt abarbeiten zu können.
Ein External Task Worker muss sich auf ein Topic subscriben, um Aufgaben zu erhalten. Dieses Topic wird in der Anwendung automatisch anhand der Ordnerstruktur generiert (in diesem Fall Bestellung-verbuchen/Bestellungen_verbuchen).
Im Prozessmodell muss dies noch konfiguriert werden. Dazu wählt man den passenden Service Task im Prozessmodell aus und wählt im Property Panel rechts unter Type den Typen External Task. Anschließend erscheinen diverse Optionen, um den External Task zu konfigurieren. Nun trägt man im Feld Topic den Wert Bestellung-verbuchen/Bestellungen_verbuchen ein.
Man sieht hier anschaulich, dass das am External Service Task eingetragene Topic identisch zur Ordnerstruktur in
unserer Next.js App ist. Durch diese identische Benennung ist die korrekte Zuordnung von External Task zu External Task Worker gewährleistet.
Payload
Damit der External Task Worker die Aufgabe bearbeiten kann, benötigt er bestimmte Informationen aus dem laufenden Prozess. In diesem Fall sind das die zu verbuchenden Bestellungen, die in unserem Data Object hinterlegt sind. Diese lassen sich über eine so genannte Payload übermitteln, die am External Task konfiguriert werden kann.
Dazu tragen wir folgenden Ausdruck in das Payload Feld ein:
dataObjects.gebuchteBestellungenEin erster Test
Wenn nun Bestellungen verarbeitet werden, sollten in der Konsole der Anwendung die entsprechenden Log-Ausgaben erscheinen.