Batch Object

Batch Objects are the foundational elements of Grooper's document processing system, providing a unified structure for organizing, processing, and reviewing document content within a inventory_2 Batch. Every item within a Batch—whether a document, folder, or page—is represented as a Batch Object (and Batches themselves are Batch Objects too).

About

Types of Batch Objects

There are three primary types of Batch Objects in Grooper:

• inventory_2 Batch: The root object representing the entire batch of documents.
• folder Batch Folder: Used to organize documents and subfolders within a Batch.
  • Batch Folders represent a "document" when either (1) they have child Batch Pages (representing pages of a document) or (2) they have a file attached to the Batch Folder (typically this occurs when files are imported from an Import Job).
• contract Batch Page: Represents an individual page of content, such as a scanned image or split page of an imported file.

Each type inherits common functionality from the Batch Object base, while also providing specialized properties and commands for their specific roles.

Hierarchical organization

Batch Objects are organized in a tree structure:

• The root of the tree is the Batch, which contains one or more Batch Folders and/or Batch Pages.
• Each Batch Folder can contain additional Batch Folders or Batch Pages. Batch Folders typically represent documents but can be used as folders in the Batch as well.
• Batch Pages represent individual pages of content, such as scanned images or imported files.

This hierarchy allows Grooper to manage complex document sets, supporting nested folders and multi-page documents within a single Batch.

Example Batch hierarchy

inventory_2 Batch

folder Batch Folder

contract Batch Page

contract Batch Page

folder Batch Folder

contract Batch Page

contract Batch Page

Participation in Batch processing

Batch Objects participate in all stages of Batch processing, including:

• Classification
• Data extraction
• Export
• Review and exception handling

Related Objects

Batch

inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

Batches are foundational to Grooper's document processing. Production Batches are assigned Batch Processes on creation which control all aspects of a document processing workflow.

How Batches are created

Batches are created in one of three typical ways:

• For scanned documents: from the Batches or Tasks Page

  Physical pages are acquired in Grooper by scanning them via a Scan Viewer in a Review step. First, a Batch is created with the "Create New Batch" button in the Batches Page or Tasks Page

• For imported documents: from Import Jobs

  Digital documents are acquired in Grooper from Import Jobs. Import Jobs are either summited by an Import Watcher service or manually from the Imports Page. Batches are created according to the Import Job's Import Provider settings.

• For test Batches: from the Design Page

  Test Batches are created manually by Design Page users in the "Test" branch of the "Batches" folder. Right click any folder in the Test branch to add a new test Batch.

Batch Folder

The folder Batch Folder is an organizational unit within a inventory_2 Batch, allowing for a structured approach to managing and processing a collection of documents. Batch Folder nodes serve two purposes in a Batch. (1) Primarily, they represent "documents" in Grooper. (2) They can also serve more generally as folders, holding other Batch Folders and/or contract Batch Page nodes as children.

• Batch Folders are frequently referred to simply as "documents" or "folders" depending on how they are used in the Batch.

Batch Folders are critical to how Grooper represents documents. They are critical to document classification, data extraction and export operations. Documents are processed by executing Grooper Activities and Commands executed at the "document level" in a Batch Process (meaning the Batch Folder level that form "documents" and not subfolders in a Batch). Batch Folders also store information at the folder level, including files attached to Batch Folders created on import.

How Batch Folders are created

Batch Folders are created in one of three typical ways:

• When pages are separated

  Loose pages are organized into documents by the Separate activity (or Separation Profiles at scan time in a Scan Viewer). When separation occurs, a Separation Provider identifies Batch Pages that qualify as the first page of a document. Then, Batch Folders are created for each identified document and each span of Batch Pages are placed in each Batch Folder.

• When files are imported

  " Digital documents are acquired in Grooper from Import Jobs. Import Jobs are either summited by an Import Watcher service or manually from the Imports Page. For each imported file, a Batch Folder is created and the file is attached to it.

• When files are dragged into a test Batch

  When testing configurations from the Design page, digital files can be quickly added to a test Batch by simply dragging it from your computer to a "Test Source" panel. You will find a Test Source panel in any "Tester" tab in the Design page.

Batch Page

contract Batch Page nodes represent individual pages within a inventory_2 Batch. Batch Pages are created in one of two ways: (1) When images are scanned into a Batch using the Scan Viewer. (2) Or, when split from a PDF or TIFF file using the Split Pages activity.

• Batch Pages are frequently referred to simply as "pages".

Batch Pages allow Grooper to process and store information at the page level, which is essential for operations that include Image Processing and text recognition (see Recognize). They enable the system to manage and process each page independently. This is critical for workflows that require page-specific actions and to take fullest advantage of Grooper's parallel processing capabilities.

How Batch Pages are created

Batch Pages are created in one of two typical ways:

• They're scanned from paper pages

  Physical pages are acquired in Grooper by scanning them via the Scan Viewer.

• They're "split" out of digital files

  Digital documents are acquired in Grooper from Import Jobs. For each imported file, a Batch Folder is created and the file is attached to it. Applying the Split Pages activity on a Batch Folder will create individual Batch Pages for each page in the file attached to the Batch Folder (must be a valid file type: PDF, TIFF or other supported image type).

Object Model info

Grooper Type Name

Grooper.Core.BatchObject

Inheritance

Grooper Object (Grooper.GrooperObject)

Connected Object (Grooper.ConnectedObject)

Node (Grooper.GrooperNode)

Batch Object (Grooper.Core.BatchObject)

Derived Types

Batch Object (Grooper.Core.BatchObject)

Batch Folder (Grooper.Core.BatchFolder)

Batch (Grooper.Core.Batch)

Batch Page (Grooper.Core.BatchPage)