Spawn Batch

The 'Processing Level' property specifies which level of the batch folder hierarchy is targeted for spawning.
Level 1 typically refers to top-level folders (documents) in the batch.
Increase this value to target subfolders at deeper levels.

> Example:
Set to 1 to process only top-level folders, or 2 to process their immediate children.

Can be one of the following values:

The 'Spawn Method' enumeration determines how folders are selected for inclusion in the spawned batch.

Choose a method that matches your batch splitting or sampling requirements.

Can be one of the following values:

The 'Action Type' enumeration determines what happens to the selected folders during the spawn operation.

• Use 'Copy' to duplicate folders into the new batch, leaving the originals unchanged.
• Use 'Move' to transfer folders to the new batch, removing them from the source batch.
• Use 'Delete' to remove folders from the source batch without creating a new batch.

Can be one of the following values:

The 'Batch Disposition' enumeration controls the fate of the original batch after folders have been spawned.

• Use 'None' to leave the source batch unchanged.
• Use 'DeleteIfEmpty' to delete the batch only if it is empty after spawning.
• Use 'DeleteAlways' to always delete the source batch after spawning.

> Note: Test batches are never deleted, regardless of this setting.

Can be one of the following values:

The 'Filter Type' enumeration controls the criteria used to select folders for spawning.

The 'Invert Filter' property reverses the logic of the selected filter.
When enabled, folders that do not match the filter criteria will be included in the spawned batch.

> Example:
If filtering by flagged items, enabling this property will select all unflagged items instead.

Use the 'Mime Type Lexicon' property to specify a list of MIME types for filtering folders.
Only folders with an attachment whose MIME type matches an entry in the lexicon will be included.

> Example:
Add application/pdf and image/tiff to include only PDF and TIFF documents.

The 'Included Content Types' property allows you to specify which Content Types should be included when filtering folders. Folders whose content type matches or inherits from any type in this list will be included in the spawned batch.

> Tip:
Use this property to target specific document types or categories for spawning.

The 'Step Size' property determines how frequently folders are selected when using the 'Every N' spawn method. Every Nth folder will be included in the spawned batch.

> Example:
Set to 5 to include every 5th folder in the batch.

The 'Spawn Percentage' property determines what fraction of folders are randomly selected when using the 'Random' spawn method. Enter a value between 0 and 1 (e.g., 0.1 for 10%).

> Example:
Set to 0.25 to randomly select 25% of folders for spawning.

The 'Starting Step' property specifies which Batch Process Step the new batch should begin at after spawning. If left blank, the batch will be created but not launched into a process.

> Tip:
Use this to route spawned batches directly into a specific workflow step.

Enable the 'Start Paused' property to create new batches in a paused state.
This allows for review or manual intervention before processing begins.

> Tip:
Use this when you want to configure or inspect spawned batches before they enter the workflow.

The 'Create Batch' property controls whether a separate batch is created for each selected folder (when using the 'Every N' method). Enable this to generate one batch per folder, or disable to group multiple folders into a single batch.

> Example:
Enable to create 10 batches from 10 folders, or disable to create a single batch containing all 10 folders.

The 'Batch Name Prefix' property allows you to specify a string that will be prepended to the name of each spawned batch. Use this to help identify or categorize spawned batches.

> Example:
Set to QA- to create batches named QA-Batch1, QA-Batch2, etc.

Can be one of the following values:

The 'Batch Name Suffix' enumeration controls how the names of spawned batches are constructed.

The 'Batch Name Suffix Zero Padding' property controls how many digits are used when adding a numbered suffix to batch names. Set to 0 for no padding, or specify a positive integer for zero-padded numbers.

> Example:
Set to 4 to produce batch names like Batch0001, Batch0002, etc.

Enable the 'Copy Batch Fields' property to copy index data (field values) from the source batch to each spawned batch. This is useful for preserving metadata or batch-level information.

> Warning:
The content type of the target batch process must match the source batch, or an error will occur.

The 'Maximum Batch Size' property limits how many folders can be included in each spawned batch. Set to 0 for no limit, or specify a positive integer to split large batches into smaller ones.

> Example:
Set to 100 to ensure no spawned batch contains more than 100 folders.

A combination of the following flags:

The Error Disposition property determines the system's response to errors that occur while executing the activity.

• Flag: The affected Batch Folder or Batch Page will be flagged for review.
• Log: The error will be written to the Grooper event log.
• Stop: Processing will halt, the Batch will be set to an error state, and all pending tasks will be deleted.

You can combine multiple options using the IssueDisposition flags.
Adjust this property to match your organization's error handling and escalation policies.

If the number of consecutive errors reaches this value, a critical stop will occur and the Activity Processing service will halt further processing.

• Use this property to prevent runaway failures and to ensure that persistent errors are escalated for review.
• Set to a higher value to allow more retries before stopping, or to a lower value for stricter error control.

Can be one of the following values:

The Concurrency Mode property determines whether the activity can be executed in parallel across multiple Batch Objects, or if it must run sequentially.

• This setting affects which Processing Queue the activity is submitted to and how tasks are distributed.
• Choose the appropriate mode based on the activity's thread safety and resource requirements.