Skip to main content

Batch Iterator

The Batch Iterator activity iterates over all records in a batch.

Configuring the Batch Iterator Activity

To configure the Batch Iterator activity, fill in the required fields in the activity panel.

Configuration

FieldRequiredDescriptionExample
NameRequiredUnique name for this iterator activityMyActivity
DescriptionOptionalHelpful description of this activity's purposeReads a file from S3
Batch IdOptionalUnique identifier for the batch to iterate
ActionOptionalAction to perform on the batch Options: Next, Reset.
Batch SizeOptionalNumber of records to fetch in one iteration100

Input

FieldRequiredData TypeDescriptionExample
Batch IdOptionalStringUnique identifier for the batch
ActionOptionalStringAction to perform: next (fetch records) or reset (return records to queue)next
Batch SizeOptionalNumberNumber of records to fetch (for 'next' action)1
Record IdsOptionalArrayRecord IDs to reset (for 'reset' action)

Output

FieldRequiredData TypeDescriptionExample
StatusOptionalStringCurrent status of the batch operation
CountersOptionalObject
ContextOptionalObjectContext information for the batch
Processing LimitOptionalNumberMaximum number of records that can be processed simultaneously
RecordsOptionalArrayRecords fetched from the batch (for 'next' action)
Reset CountOptionalNumberNumber of records reset (for 'reset' action)