Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Batch Page

Batch Object Grooper.Core

A Batch Page represents an individual page within a Batch, serving as the core unit of content for document processing in Grooper.

Remarks

A Batch Page is the atomic element of a batch, representing a single scanned or imported page. Batch Pages are always contained within Batch Folders, which may represent documents or organizational folders. Together, Batch Folders and Batch Pages form the hierarchical structure of a Batch.

Creation and Population

  • Batch Pages are created by scanning physical documents or by splitting imported digital files (such as PDFs or multi-page images) using activities like Split Pages.
  • Each Batch Page is automatically assigned to a Batch Folder during import, scanning, or separation.

Image Management

  • Each Batch Page manages its own primary image, supporting a variety of formats (TIFF, JPEG, PDF, etc.).
  • The class provides methods for accessing, updating, and converting the primary image, as well as generating display images in different color formats (binary, grayscale, color).
  • Thumbnail images are generated and managed for efficient display in user interfaces.
  • Undo functionality is supported, allowing previous image versions to be saved and restored.

Review and Confirmation

  • Batch Pages can be flagged for review and confirmed by users as part of quality assurance workflows.
  • The 'Is Confirmed' property and related methods allow tracking and toggling the confirmation status of a page.

Layout and OCR Data

  • Batch Pages can store and manage layout data (such as page geometry and annotations) and OCR results.
  • This enables downstream activities such as data extraction, validation, and export.

Integration with Batch Processing

  • Batch Pages participate in batch processing activities, including image processing, recognition, extraction, and export.
  • Their state and content are updated as the batch progresses through its workflow.

For more information on how Batch Pages interact with Batch Folders and Batches, see the documentation for those types.

Properties

NameTypeDescription
General
ScanOnce™

Design Tabs

General View and manage the properties and visual content of a Batch Page.
Reports View reports for a node.
Advanced View or edit advanced details about a node.

Context Menu Commands

Command Shortcut Description
contrast Display As Binary Ctrl+Shift+B Changes the display format of the current Batch Page to black and white (binary).
palette Display As Color Ctrl+Shift+C Changes the display format of the current Batch Page to color.
filter_b_and_w Display As Grayscale Ctrl+Shift+G Changes the display format of the current Batch Page to grayscale.
gallery_thumbnail Generate Thumbnail Generates and saves a thumbnail image for the Batch Page.
shadow Invert Ctrl+Shift+V Inverts the polarity of the image on the Batch Page.
picture_as_pdf Rasterize Converts a PDF page to an image for the selected Batch Page.
reset_image Reset Ctrl+Shift+R Clears all display format and ScanOnce settings stored on the Batch Page.
rotate_left Rotate Left Ctrl+Left Rotates the Batch Page counter-clockwise.
rotate_right Rotate Right Ctrl+Right Rotates the Batch Page clockwise.
undo Undo Image Cleanup Ctrl+Z Replace the selected Batch Page with its Undo Image.

See Also

Notification