│ Grooper Help - Version 25.0
25.0.0024 2,166

Batch Folder

Batch Object Grooper.Core

A Batch Folder is a hierarchical container within a Batch, representing both folders and documents in Grooper's batch processing system.

Remarks

A Batch Folder serves as the primary organizational unit within a Batch, capable of containing other Batch Folders and Batch Pages. This flexible structure enables Grooper to represent complex document hierarchies, such as multi-level folders, documents, and sub-documents, within a single batch.

Creation and Organization

  • Batch Folders are created during scanning, digital import, or by user-driven separation and organization activities.
  • Folders may be generated automatically by assigning a Separation Profile in the Scan View, by running the Separate activity, or by importing digital files using an Import Provider.
  • Users can also manually organize pages and folders, supporting both automated and ad-hoc document assembly workflows.

Folder Types and Classification

Attachments and Content Links

  • Batch Folders can have files attached, such as digital documents, images, or archives. Attachments are managed using Attachment Types, which determine how Grooper processes and interacts with each file.
  • When digital documents are imported, a Content Link may be created to reference the original file location. If the import is performed in sparse mode, only the link is stored, enabling Grooper to process documents without duplicating content.
  • The Export activity can also generate content links, supporting downstream integration and document lifecycle management.

Data Extraction and Indexing

  • Each Batch Folder can be assigned a Content Type with an associated Data Model, enabling extraction, validation, and presentation of structured data.
  • Index data is stored per folder and can be managed, validated, and exported as part of the batch process.
  • Folders support multiple content types, including secondary types, allowing for flexible classification and data extraction scenarios.

Integration with Batch Processing

  • Batch Folders participate in all batch processing activities, including classification, extraction, export, and review.
  • Their hierarchical structure enables complex workflows, such as nested document sets, compound documents, and multi-level separation.
  • Folders expose commands for manipulation, classification, and content management, supporting both automated and manual processing.

Usage Notes

  • Use Batch Folders to organize documents and pages according to business requirements, supporting both simple and highly complex batch structures.
  • Configure Content Types and Attachment Types to enable classification, extraction, and specialized processing for each folder or document.
  • Leverage content links and sparse documents for efficient storage and integration with external systems.

For more information, see the documentation for Batch, Batch Page, Content Type, and Attachment Type.

Properties

NameTypeDescription
General
Attachment

Design Tabs

General View and manage the properties and contents of a Batch Folder, including its hierarchy and associated documents.
Reports View reports for a node.
Advanced View or edit advanced details about a node.

Context Menu Commands

Command Shortcut Description
search_check Add To Index Adds or updates the current document in the search indexes associated with its Content Types.
edit_document Assign Document Type Ctrl+Shift+A Assigns a primary and optional secondary Content Type to the selected Batch Folder.
collapse_all Collapse Moves all OCR and Layout Data from descendant pages and folders to the current Batch Folder, then removes all children.
edit_document Edit Type Assignment Ctrl+Shift+A Adds, removes, or promotes a Document Type assignment for the selected Batch Folder.
list_alt Extract Runs data extraction on the selected Batch Folder and saves the results.
account_tree Group Children Organizes the children of a folder into subfolders based on item count and/or total file size.
document_scanner Insert Control Sheets Inserts a Control Sheet as the first page of each Batch Folder in a batch.
description New Text Document Creates a new text document inside this folder.
search_check Remove From Index Removes the current document from one or more search indexes, making it no longer discoverable via search or retrieval.
account_tree Remove Level Ctrl+U Removes the selected Batch Folder and moves its children up one level in the hierarchy.
restore_page Revert To Loose Pages Moves all descendant Batch Pages to the root of the folder and deletes all subfolders.
variable_insert Set Field Value Sets the value of a field stored on a Batch Folder.
sort_by_alpha Sort Children Reorders the children of the current Batch Folder according to the specified sort options.

Derived Types

There are 1 implementations of Batch Folder.

Batch Represents a hierarchy of folders and pages, serving as the root container for content and processing within a Grooper batch workflow.

Child Types

Batch FolderBatch Page

See Also

Content CategoryContent ModelDocument TypeForm TypePage TypeAttachment TypeContent LinkCulture Data

Notification