Configuring Saga Steps
Reference for the common settings, step types, and links used to build and control saga execution flows.
Saga flows start with a single START node and can have one or more SUCCESS / FAIL nodes as the exit point. Other nodes are linked as sequential steps in between them and have the following common parameters:
Name: Descriptive name of the step, which will be displayed on saga graph
Description: Detailed description of what this step will perform
Stroke: Stroke color of the step on saga graph
Fill: Fill color of the step on saga graph
Auto Fail: Whether saga should automatically fail if this step fails
Continue on Fail: Whether saga step should continue on fail (to override in case saga itself is configured as Auto Fail)
Step types
Saga graphs are built from a small set of step types. Each type has different configuration fields and runtime behavior.
Control steps
These steps define entry and exit points of the flow:
Start: Entry point for the saga execution.
Success: A successful exit point.
Fail: A failure exit point.
Action and logic steps
These steps do the work between Start and exit nodes:
Event Step: calls an event handler action with parameters.
Transform Step: transforms the current payload and passes the output forward.
Condition Step: evaluates a condition and routes to different next steps.
Connecting steps
Step Link: defines how the flow moves from one step to the next. Use condition values to model branching and default (
*) paths.
Sagas also include a "Note" step, which is used for descriptive notes within the flow, such as to-dos, comments that are specific to a certain section of the flow for documentation & reference purposes. These notes have no functional impact on the saga flow.
Last updated