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

Batch Object

Node Grooper.Core

Represents a content object within a Batch, serving as the abstract base for Batch Folder and Batch Page objects in Grooper's batch processing hierarchy.

Remarks

A Batch Object is the foundational element of Grooper's batch structure, providing a unified interface and shared behaviors for all items that appear within a Batch.
This includes both Batch Folders (which organize documents and subfolders) and Batch Pages (which represent individual pages of content).

Hierarchical Structure

Core Responsibilities

  • Provides common properties such as 'Flagged', 'Flag Reason', and 'Culture Code' for review, exception handling, and localization.
  • Manages file storage for content, OCR results, and Layout Data at the object level.
  • Exposes methods for flagging, clearing flags, and managing OCR/layout data.

Notes

  • Batch Objects participate in all batch processing activities, including classification, extraction, export, and review.
  • Use the 'Flagged' and 'Flag Reason' properties to mark items for review or exception handling.

For more information, see the documentation for Batch, Batch Folder, and Batch Page.

Properties

NameTypeDescription

Design Tabs

General View or edit properties of a node.
Reports View reports for a node.
Advanced View or edit advanced details about a node.

Context Menu Commands

Command Shortcut Description
folder_open Add Folder Ctrl+Shift+F Adds a new folder as a child of the selected Batch Folder, with configurable position and metadata.
move_up Append To Previous Ctrl+P Appends selected items to the previous Batch Folder in the batch, reorganizing the batch structure.
flag Clear Flag Ctrl+Shift+L Clears the flagged state from one or more previously flagged items in a batch.
inventory_2 Copy To Test Batch Copies selected items to a test batch, optionally flagging them for review or testing.
flag Flag Item Ctrl+L Flags the selected items in a batch with a specified reason for review or special handling.
folder_open Insert Folder Ctrl+F Inserts a new Batch Folder as a sibling to the selected folder.
account_tree Merge Selected Ctrl+M Merges selected items into one or more new Batch Folders, with configurable content type and grouping.
inventory_2 Move To Test Batch Moves selected items to a test batch, removing them from their original location and optionally flagging them.
move_down Prepend to Next Ctrl+Shift+P Prepends selected items to the next Batch Folder in the batch, moving them to the start of that folder.
drive_file_rename_outline Rename F2 Renames the selected Batch Object to a new display name.
video_settings Run Activity Runs a selected code activity on the selected Batch Objects.
edit_document Run Step Runs a specific batch process step on the selected item(s).
folder_zip Split Folder Ctrl+S Splits the parent Batch Folder at the selected item, moving it and all subsequent siblings into a new folder.

Derived Types

There are 3 implementations of Batch Object.

Batch Represents a hierarchy of folders and pages, serving as the root container for content and processing within a Grooper batch workflow.
Batch Folder A Batch Folder is a hierarchical container within a Batch, representing both folders and documents in Grooper's batch processing system.
Batch Page A Batch Page represents an individual page within a Batch, serving as the core unit of content for document processing in Grooper.

See Also

Culture Data

Notification