Batch Job (<batch:job/>)
Defines the main batch processing scope. A batch job contains two phases:
-
Process Records: Executes the record processing logic defined in nus.
-
On Complete: Executes after all records are processed, for example to log results or perform cleanup.
Configuration Options
| Property | Type | Default | Description |
|---|---|---|---|
|
String |
Auto-generated |
Display name for the component in the canvas |
|
String |
Auto-generated |
Unique identifier for the component |
|
Integer |
50 |
Number of records per block to process concurrently within the Process Records phase |
Child Elements and Scopes
-
One or more Batch Steps inside the job
-
One optional On Complete scope
Batch Processing Constraints
-
Batch jobs can’t be nested.
-
At least one Batch Step must be present.
Batch Processing Example
<batch:job doc:name="Batch Job Example" doc:id="job-1" batchBlockSize="100">
<batch:step doc:name="Step 1" doc:id="step-1">
<!-- record processors -->
</batch:step>
<batch:on-complete doc:name="On Complete" doc:id="onComplete-1">
<!-- final operations -->
</batch:on-complete>
</batch:job>
Batch Step (batch:step/)
Defines a step inside a batch job. Steps group record-level processors and can optionally include a batch aggregator.
Child Elements and Sub-Scopes
Processors: A sequence of processors (for example, Transform, Logger) that act on each record.
Batch Aggregator: Aggregates records into blocks (optional).
Batch Aggregator (batch:aggregator/)
Aggregates records into blocks within a Batch Step for grouped processing before records are sent back into the flow.
Batch Aggregator Configuration Options
| Property | Type | Default | Description |
|---|---|---|---|
doc:name |
String |
Auto-generated |
Display name in the UI |
doc:id |
String |
Auto-generated |
Unique identifier for the component |
aggregatorSize |
Integer |
100 |
Number of records to group before applying aggregation logic |