Spawn Batch

Creates a new batch using a filtered set of level 1 folders from the current batch.

Remarks

Copies one or more level 1 folder objects from the batch to a new batch, optionally launching the new batch into a Batch Process. If no items in the batch match the specified criteria, no batch is created.

Inherits from: Unattended Activity

Properties

The following 21 properties are defined.

Property Name Description
General
Processing Level Type: Int32, Default: 0, Range: 0 - 32

Indicates the level inside the batch which contains the items to be spawned.

Method Type: SpawnMethod, Default: Filter

Specifies the spawn operation to execute. Can be one of the following values:

  • Filter - Selects the items to spawn by filtering on attributes such as MIME type, content type, or flag status.
  • EveryN - Spawns every Nth item in the batch to a new batch. Useful for random QA sampling.
  • Random - Spawns a percentage of the items to a new batch. Useful for random QA sampling.

Action Type: ActionType, Default: Move

Controls how items are moved / copied to the spawned batch. Can be one of the following values:

  • Copy - Creates a copy of the selected documents in the spawned batch, leaving the original documents unaltered in the source batch.
  • Move - Moves the selected documents from the current batch to the spawned batch.
  • Delete - Deletes the selected documents. When this action is used, no batch will be spawned.

Source Batch Disposition Type: BatchDisposition, Default: None

Specifies what should be done with the source batch. Can be one of the following values:

  • None - The source batch will be left alone.
  • DeleteIfEmpty - The source batch will be deleted only if it is empty.
  • DeleteAlways - The source batch will always be deleted.
Please note that test batches will never be deleted, regardless of the value of the property.

Item Filtering
Filter By Type: FilterType, Default: FlaggedItems

Indicates which folders will be included in the spawned batch. Can be one of the following values:

  • AllItems - All folders will be included.
  • MimeType - All folders which have a native file MIME type matching one listed in the MIME Type Lexicon will be included.
  • ContentType - All folders with a content type which matches or inherits from one of the Content Types listed in the Content Types property.
  • FlaggedItems - All flagged folders will be included.
  • InvalidItems - All folders whose index data is invalid will be included.

Invert Filter Type: Boolean, Default: False

If set to true, inverts the filtering logic.

Mime Type Lexicon Type: Embedded Lexicon

An Embedded Lexicon containing one or more MIME types. Any folder with matching MIME type will be spawned.

Included Content Types Type: List of Content Type

A list of content types to be used when FilterBy is set to ContentType. A folder will be spawned if its content type appears in this list, or if its content type inherits from one of the selected types.

Step Size Type: Int32, Default: 10, Range: 0 - 2147483647

When the EveryN method is in use, specifies the step size. Every Nth item in the batch will be spawned.

Spawn Percentage Type: Double, Default: 10%, Range: 0% - 100%

When the EveryN method is in use, specifies the step size. Every Nth item in the batch will be spawned.

Batch Creation
Starting Step Type: Batch Process Step

The Batch Process Step where the newly-spawned batch will begin processing. If no step is specified, the batch will be created, but will not be launched into a batch process.

Start Paused Type: Boolean, Default: False

An optional prefix to add the spawned batch name.

Move Task History Type: Boolean, Default: False

If set to true, during a move operation the task history will be transferred to the new batch.

Batch Name Prefix Type: String

An optional prefix to add to the spawned batch name.

Batch Name Suffix Type: BatchNameSuffixEnum, Default: SourceBatchName

Suffix to add to the spawned batch name. Can be one of the following values:

  • None - No suffix will be added, unless the newly-created batch name conflicts with an existing batch name, in which case a numeric suffix will be added.
  • SourceBatchName - The batch name will be created from the prefix and the source batch name.
  • NumberedSuffix - The batch name will be created from the prefix and a numbered suffix.

Batch Name Suffix Zero Padding Type: Int32, Default: 4

Allows Configuration of zero-padding for the Batch Name Suffix Option. To specify no zero padding, set this property to zero (0). To specify zero-padding to a specific number of characters, specify the number of characters to be zero-padded.

Copy Batch Fields Type: Boolean, Default: False

If set to true, Batch field values will be copied to new batches. An exception will occur during processing if the Content Type for the target step's batch process does not match this batch process' Content Type.

Maximum Batch Size Type: Int32, Default: 0

Specifies the maximum number of items which will be spawned into a single batch. A value of 0 indicates no limit. Use this setting to split large batches into smaller ones.

Processing Options
Error Disposition Type: IssueDisposition, Default: Flag, Log

Determines what happens when an error occurs processing an activity.

Maximum Consecutive Errors Type: Int32, Default: 0

The maximum number of consecutive errors, after which a critical stop will be raised. A critical stop will cause services to stop running.

Concurrency Mode Type: ConcurrencyMode, Default: Multiple

Specifies the parallel processing mode for this activity. Can be one of the following values:

  • Multiple - Multiple instances can run concurrently.
  • PerMachine - Only a single instance can run per machine.
  • Single - Only a single instance can run per Grooper repository.
This value determines the type of Thread Pool on which the activity can be executed.

See Also

Batch Process Step, Content Type, Embedded Lexicon

Used By

Batch Folder - Apply Activity, Batch Process Step