Entwickler Tutorial (Legacy)
Multi-Instanz- und Standard-Schleifen

Multi-Instanz- und Standard-Schleifen

Einführung

Im Rahmen des BPMN 2.0-Standards bieten Schleifenkonstrukte eine flexible Möglichkeit, Geschäftsprozesse durch wiederholte Ausführung von Aktivitäten zu modellieren. Schleifen können in BPMN 2.0 in zwei Haupttypen unterteilt werden: Standard-Schleifen (Standard Loop) und Multi-Instanz-Schleifen (sowohl parallele als auch sequentielle).

  • Standard-Schleifen wiederholen eine Aktivität basierend auf einer voreingestellten Bedingung.

Standard-Schleife Standard-Schleife

Standard-Schleife bzw. Loop

  • Multi-Instanz-Schleifen erzeugen mehrere Instanzen einer Aktivität, die parallel oder sequentiell ausgeführt werden können, um eine Sammlung von Elementen zu verarbeiten.

Sequentielle Multi-Instance Sequentielle Multi-Instance

Sequentielle Multi-Instance

Parallele Multi-Instance Parallele Multi-Instance

Parallele Multi-Instance

Das Feature Multi-Instanz- und Standard-Schleifen erfordert die Engine-Version v17.0.0 oder höher.

Parallele Multi-Instanzen

Parallele Multi-Instanzen erlauben die simultane Ausführung mehrerer Instanzen eines Prozessschrittes, um eine Liste von Objekten parallel zu verarbeiten. Dadurch ist es möglich BPMNs, die auf eine parallele Verarbeitung von Datensätzen angewiesen sind, übersichtlicher zu gestalten und mit dynamischen Größen der Datenmengen zu arbeiten. Beispielsweise würde dieser Prozess ohne parallele Multi-Instanz

diesem Prozess mit paralleler Multi-Instanz entsprechen.

Konfiguration

Start-Token

Als Eingabewert wird ein Array erwartet, dass mindestens einen und bis zu beliebig vielen Tokens enthält.

[{ "myValue": 0 }, { "myValue": 1 }, { "myValue": 2 }]

Zu jedem Token wird eine Instanz der Aktivität gestartet.

Gestartete parallele Multi-InstanceGestartete parallele Multi-Instance
Hier wird gerade der zweite der drei gestarteten Tasks angezeigt.

Runtime Expressions

Aktivitäten, die mit Runtime Expressions konfiguriert werden können (z.B. External Tasks, Script Tasks), haben Zugriff auf weitere Parameter, wenn sie als Parallele Multi-Instanz ausgeführt werden:

currentLoopIndex

Der 0-basierte-Index der Instanzen, die durch die Aktivität innerhalb der Multi-Instanz-Ausführung gestartet wurden wird als currentLoopIndex angegeben.

⚠️

Achtung: Aufgrund der zugrundeliegenden Nebenläufigkeit, ist die Reihenfolge bei parallelen Multi-Instanzen nicht zwingend synchron zur Eingabe-Menge. Für eine garantierte Reihenfolge müssen sequentielle Multi-Instanzen verwendet werden.

// Einem ExternalTaskWorker wird der Index des Elements mitgegeben
{
  data: token.current,
  index: currentLoopIndex
}

totalLoopElements

Die absolute Menge der Eingabe-Elemente (gleich der Länge des Eingabe-Arrays) lässt sich mit totalLoopElements ermitteln.

// Die Position innerhalb des Eingabe-Arrays wird bestimmt
{
  data: token.current,
  position: `${currentLoopIndex + 1} of ${totalLoopElements}`
}

Besonderheiten

  • Start-Token: Muss ein Array sein, wobei jede Instanz des Arrays parallel verarbeitet wird.
  • Pre- und Post-Skripte: Werden global einmalig ausgeführt – das Pre-Skript vor dem Start der parallelen Verarbeitung und das Post-Skript nach deren Abschluss. Dabei operieren die Skripte auf den Ein- und Ausgabe-Arrays.
  • Datenobjekte: Schreibzugriffe auf Datenobjekte erfolgen einmalig nach Beendigung aller parallelen Instanzen.

Sequentielle Multi-Instanzen

Im Gegensatz zu den parallelen Multi-Instanzen verarbeitet die sequentielle Ausführung Elemente eines Arrays nacheinander, wodurch eine strenge Reihenfolge eingehalten wird.

Genau wie bei parallelen Multi-Instanzen, ist es mit der sequentiellen Variante möglich Prozesse übersichtlicher zu gestalten und mit dynamischen Größen der Datenmengen zu arbeiten. Beispielsweise würde dieser Prozess ohne sequentielle Multi-Instanz

diesem Prozess mit sequentieller Multi-Instanz entsprechen.

Konfiguration

Start-Token

Als Eingabewert wird ein Array erwartet, dass eine Menge größer 0 an Tokens enthalten muss.

[{ "myValue": 0 }, { "myValue": 1 }, { "myValue": 2 }]

Zu jedem Token wird eine Instanz der Aktivität gestartet, wenn die vorherige Instanz mit dem vorherigen Token abgeschlossen ist.

Gestartete sequentielle Multi-InstanceGestartete sequentielle Multi-Instance

Im Gegensatz zur parallelen Multi-Instanz wird hier der dritte Task erst gestartet, wenn die aktuelle Instanz abgeschlossen ist.

Timeout zwischen Iterationen

Mit dieser Konfiguration wird zwischen dem Beenden der vorhergehenden und dem Starten der nachfolgenden Instanz ein zu konfigurierender Zeitraum gewartet. Verwendungsgründe können verschiedene sein - zum Beispiel um Last gegen ein Drittsystem zu reduzieren.

Der Wert ist optional, aber wenn angegeben muss er größer als 0 und in der Einheit Millisekunden angegeben werden.

Sequentielle Multi-Instance mit TimeoutSequentielle Multi-Instance mit Timeout

Für das Timeout können auch Runtime-Expressions verwendet werden. Wenn in diesem Beispiel der Token kein taskTimeout enthält, wird zwischen den Task-Übergängen 5 Sekunden gewartet.

Runtime Expressions

Aktivitäten als Sequentielle Multi-Instanz haben Zugriff auf folgende zusätzliche Parameter:

currentLoopIndex

Der 0-basierte-Index der Instanzen, die durch die Aktivität innerhalb der Multi-Instanz-Ausführung gestartet wurden wird als currentLoopIndex angegeben. Der Index entspricht der Reihenfolge des Eingabe-Arrays.

// Nur die ersten 10 Elemente werden verarbeitet
if (currentLoopIndex < 10) {
  return { value: token.current.value * token.current.value };
}
 
return token.current;

totalLoopElements

Die absolute Menge der Eingabe-Elemente (gleich der Länge des Eingabe-Arrays) lässt sich mit totalLoopElements ermitteln.

// Der prozentuale Fortschritt der Verarbeitung wird mit in das Token geschrieben
{
  data: token.current,
  progress: `${Math.round((currentLoopIndex + 1)/totalLoopElements)} %`
}

loopResults

Da Sequentielle Multi-Instanzen im Gegensatz zum parallelen Konterpart nacheinander gestartet werden, ist es möglich mit dem Parameter loopResults auf Ergebnisse vorangegangener Iterationen zuzugreifen. Die Ergebnisse können nicht verändert, aber gelesen werden und so als Teil-Ergebnisse im nachfolgenden Schritt genutzt werden.

Beispielsweise um die bisherigen Ergebnisse zu aggregieren:

const previousSum: loopResults ? loopResults.reduce((prev, curr) => prev.value + curr.value, 0) : 0;

Oder im Verbund mit currentLoopIndex um das Ergebnis der vorhergehenden Iteration als neuen Eingabe-Wert zu verwenden:

const previousResult = currentLoopIndex > 0 ? loopResults[currentLoopIndex - 1] : 0;

Besonderheiten

  • Start-Token: Muss ein Array sein, wobei jede Instanz des Arrays nacheinander verarbeitet wird.
  • Pre- und Post-Skripte: Werden global einmalig ausgeführt – das Pre-Skript vor dem Start der sequentiellen Verarbeitung und das Post-Skript nach deren Abschluss. Dabei operieren die Skripte auf den Ein- und Ausgabe-Arrays.
  • Datenobjekte: Schreibzugriffe auf Datenobjekte erfolgen einmalig nach Beendigung aller sequentiellen Instanzen.

Standard-Schleifen (Loops)

Standard-Schleifen ermöglichen die wiederholte Ausführung einer Aktivität, bis eine bestimmte Abbruchbedingung erfüllt ist.

Genau wie bei den Multi-Instanz-Typen, ist es mit Loops möglich Prozesse übersichtlicher zu gestalten. Beispielsweise würde dieser Prozess ohne Loop

diesem Prozess mit Loop entsprechen.

Konfiguration

Start-Token

Im Gegensatz zu der parallelen und sequentiellen Multi-Instanz, wird kein Array als Eingabewert erwartet. Der Start-Token kann ein normaler Token, wie er auch bei anderen Aktivitäten verwendet wird, sein.

Break Condition

Die Break Condition ist eine Runtime Expression, die am Ende jedes Schleifendurchlaufs ausgeführt wird und bestimmt, ob die Schleife abgebrochen werden soll. Das Ergebnis der Runtime Expression muss einem boolschen Wert entsprechen - true bricht die Schleife ab, false startet den nächsten Schleifendurchlauf:

Standard Loop-Instance mit Break ConditionStandard Loop-Instance mit Break Condition

Der Task wird in diesem Fall so oft ausgeführt, bis der End-Token ein value enthält, dass kleiner als 0.25 ist.

Timeout between Iterations

Mit dieser Konfiguration wird zwischen dem Beenden der vorhergehenden und dem Starten der nachfolgenden Instanz ein zu konfigurierender Zeitraum gewartet. Verwendungsgründe können verschiedene sein - zum Beispiel um Last gegen ein Drittsystem zu reduzieren.

Der Wert ist optional, aber wenn angegeben muss er größer als 0 und in der Einheit Millisekunden angegeben werden.

Maximum Number of Iterations

Damit ein Loop aufgrund einer niemals erfüllenden Break Condition nicht unendlich lange läuft, gibt es die Möglichkeit die maximale Anzahl an Iterationen zu limitieren. Wenn das Limit überschritten werden würde, wird die Aktivität stattdessen mit einem Fehler beendet.

Der Wert ist optional, aber wenn angegeben muss er größer als 0 sein.

Standard Loop-Instance mit Maximum Number of IterationsStandard Loop-Instance mit Maximum Number of Iterations

Der Task wird in diesem Fall so oft ausgeführt, bis entweder die Break Condition erfüllt oder 100 Iterationen durchlaufen sind.

Runtime Expressions

Aktivitäten als Loop-Instanz haben Zugriff auf folgende zusätzliche Parameter:

currentLoopIndex

Der 0-basierte-Index der Instanzen, die durch die Aktivität innerhalb der Loop-Ausführung gestartet wurden wird als currentLoopIndex angegeben.

// Nur die ersten 10 Elemente werden verarbeitet
if (currentLoopIndex < 10) {
  return { value: token.current.value * token.current.value };
}
 
return token.current;

loopResults

Mit dem Parameter loopResults kann auf Ergebnisse vorangegangener Iterationen zugegriffen werden. Die Ergebnisse können nicht verändert, aber gelesen werden und so als Teil-Ergebnisse im nachfolgenden Schritt genutzt werden.

Beispielsweise um die bisherigen Ergebnisse zu aggregieren:

const previousSum: loopResults ? loopResults.reduce((prev, curr) => prev.value + curr.value, 0) : 0;

Oder im Verbund mit currentLoopIndex um das Ergebnis der vorhergehenden Iteration als neuen Eingabe-Wert zu verwenden:

const previousResult = currentLoopIndex > 0 ? loopResults[currentLoopIndex - 1] : 0;

Besonderheiten

  • Start-Token: Kann ein beliebiger Token sein, der als Start-Token für die erste Iteration verwendet wird.
  • Pre- und Post-Skripte: Werden global einmalig ausgeführt – das Pre-Skript vor dem Start der ersten Iteration und das Post-Skript nach dem Abschluss der letzten Iteraton.
  • Datenobjekte: Schreibzugriffe auf Datenobjekte erfolgen einmalig nach Beendigung aller Instanzen.