Separation Event

Defines the conditions that trigger the creation of new documents during event-based separation.

---

Separation Events are used to configure how Batch Folders and Batch Pages are split into new documents during processing. Each event specifies a trigger condition, such as the detection of a blank page, a barcode, or a control sheet, and determines the resulting separation action.

Remarks

Overview

A Separation Event is an abstract base class for all event-based document separation logic. It is used within a Separation Provider to define when and how new documents are created as batches are processed.

• Each event is evaluated in sequence for each page or item in the batch.
• When an event's trigger condition is met, the associated Separate Action is executed, which may create a new folder, delete a page, or perform other actions.

Configuration

To configure a separation event:

1. Select the desired event type (e.g., Blank Page Detected, Barcode Detected, Control Sheet Detected).
2. Set the event's properties to define the trigger condition and resulting action.
3. Assign the event to a Separation Profile or Separation Provider.

Viewable Properties

• Folder Level:
  Specifies the relative folder level at which new documents will be created.
  A value of 1 creates new folders one level below the processing scope. A value of 0 disables folder creation.

• Delete Page:
  If enabled, the page that triggered the event will be deleted after separation.

Usage Notes

• Multiple separation events can be combined to handle complex separation scenarios.
• The order of events may affect the outcome, as only the first matching event is executed for each item.

---

For more information, see the documentation for Separation Provider, Separate Action, and Batch Folder.

Properties

Name	Type		Description
Folder Level	Int32	►	Specifies the folder level (relative to the processing scope) at which a new folder will be created during separation. Default1 The folder level is relative to the processing scope set in the batch process step (as determined by the step's 'Scope' and 'Folder Level' configuration). For example, if the separation step's processing scope is folder level 2, and you want to create new folders one level below, set this property to 1. If set to 0, no folders will be created. This is useful when you only want to delete separator pages (such as blank pages) and leave the document structure unchanged. Example: Processing Scope: Folder Level 2 SeparateAction.FolderLevel: 1 Result: New folders are created at level 3, directly under each folder at level 2.
Content Type	Content Type	►	The content type to assign to the new folder created by this separation action. EditorContent Type Editor Select the Content Type that should be assigned to new folders/documents created during separation. This determines the data model, extraction logic, and classification for the new document. This property is only visible and required when 'Folder Level' is greater than 0.
Delete Page	Boolean	►	If enabled, deletes the page that triggered the separation event. DefaultFalse Set to true to remove the page (such as a blank or barcode page) that caused the separation. Useful for cleaning up separator pages that are not needed in the final output. If false, the page will remain in the resulting document or folder.

Derived Types

There are 5 implementations of Separation Event.

Barcode Detected	Triggers document separation when a specific barcode is detected on a page.
Blank Page Detected	Triggers document separation when a blank page is detected.
Content Type Detected	Triggers document separation when a page 1 of a specific Content Type is detected. The Content Type Detected event is used to create new documents or folders in a batch when the first page of a document is confidently classified as a specific Content Type. This enables separation based on document classification, supporting complex, model-driven workflows.
Page Count	Triggers document separation at a fixed page interval.
Shape Detected	Triggers document separation when a specific shape is detected on a page.

See Also

Content CategoryContent ModelDocument TypeForm TypePage Type

Used By

Event-Based