Wraps the next step in a database transaction, committing it when the pipeline finishes or rolling it back on failure. By default the transaction spans the whole step, from prepare through to finished, so it is started once and committed once. Set the isolated property to instead start and commit a separate transaction around each invocation of exec - for example, once per row when this step runs for each of ten rows - which avoids "nested transactions not supported" errors when transaction steps are chained together. Set alwaysRollback to force every transaction to roll back, which is useful for testing.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| alwaysRollback | boolean | Whether every transaction this step opens is rolled back rather than committed, regardless of the pipeline's outcome. Intended for testing this step or a pipeline that contains it without persisting any changes. |
| description | String | Human-readable summary of this step, shown to administrators managing the pipeline: that it wraps subsequent processing in a database transaction, committing when finished, or rolling back on failure or if configured to always roll back. |
| formPath | String | Path to the Velocity template used by the pipeline management UI to edit this step's configuration. |
| isolated | Boolean | The configured isolated flag as set on this step, distinct from isolated() in that it is not defaulted - it reflects whether the property was explicitly set at all. |
| next | PipelineStep | The single step that follows this one in the pipeline, or null if none has been configured. |
| nextStep | PipelineStep | The single step that follows this one in the pipeline, or null if none has been configured. Equivalent to getNext. |
| olated | boolean | Whether the transaction is scoped to each individual exec() call rather than to the whole step, treating an unconfigured value as false. |
Methods
getFormPath()
Returns: String
Path to the Velocity template used by the pipeline management UI to edit this step's configuration.
getDescription()
Returns: String
Human-readable summary of this step, shown to administrators managing the pipeline: that it wraps subsequent processing in a database transaction, committing when finished, or rolling back on failure or if configured to always roll back.
getNext()
Returns: PipelineStep
The single step that follows this one in the pipeline, or null if none has been configured.
getNextStep()
Returns: PipelineStep
The single step that follows this one in the pipeline, or null if none has been configured. Equivalent to getNext.
isAlwaysRollback()
Returns: boolean
Whether every transaction this step opens is rolled back rather than committed, regardless of the pipeline's outcome. Intended for testing this step or a pipeline that contains it without persisting any changes.
isolated()
Returns: boolean
Whether the transaction is scoped to each individual exec() call rather than to the whole step, treating an unconfigured value as false.
getIsolated()
Returns: Boolean
The configured isolated flag as set on this step, distinct from isolated() in that it is not defaulted - it reflects whether the property was explicitly set at all.