View source for Batch Object

<blockquote>{{#lst:Glossary|Batch Object}}</blockquote>
== About ==
<section begin="Batch Objects" />
=== Types of Batch Objects ===

There are three primary types of Batch Objects in Grooper:
* {{BatchIcon}} '''[[Batch]]:''' The root object representing the entire batch of documents.
* {{BatchFolderIcon}} '''[[Batch Folder]]:''' Used to organize documents and subfolders within a Batch. 
**<li class="fyi-bullet"> 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]]).
* {{BatchPageIcon}} '''[[Batch Page]]:''' Represents an individual page of content, such as a scanned image or [[Split Pages|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 Folder]]s and/or [[Batch Pages]].
* Each Batch Folder can contain additional Batch Folders or [[Batch Page]]s. 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.

<big>Example Batch hierarchy</big>
<div style="margin-left:2em; font-style:italic">
:{{Template:BatchIcon}} Batch
::{{Template:BatchFolderIcon}} Batch Folder
:::{{Template:BatchPageIcon}} Batch Page
:::{{Template:BatchPageIcon}} Batch Page
::{{Template:BatchFolderIcon}} Batch Folder
:::{{Template:BatchPageIcon}} Batch Page
:::{{Template:BatchPageIcon}} Batch Page
</div>

=== Participation in Batch processing ===

Batch Objects participate in all stages of Batch processing, including:
* Classification
* Data extraction
* Export
* Review and exception handling

=== Related Objects ===
<div style="padding-left: 1.5em">
==== Batch ====
{{#lst:Glossary|Batch}}

'''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 ====
{{#lst:Glossary|Batch Folder}}

'''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 Profile]]s 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 ====
{{#lst:Glossary|Batch Page}}

'''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).
</div>
</div>
<section end="Batch Objects" />

== Object Model info ==

<big>Grooper Type Name</big>
:''{{TypeName|Batch Object}}''

{{Inheritance|Grooper Object|Connected Object|Node|Batch Object}}

<big>Derived Types</big>
:::: {{WikiHelpLinks|Batch Object}}
::::: {{WikiHelpLinks|Batch Folder}}
:::::: {{WikiHelpLinks|Batch}}
::::: {{WikiHelpLinks|Batch Page}}

[[Category:Batch Object]]
[[Category:Document Modeling]]