Batches Page (UI Element)

This article is about the current version of Grooper. Note that some content may still need to be updated.

2025

The Batches Page is the operational workspace where users monitor and manage document processing jobs. It provides visibility into batch status, processing stages, and allows users to perform review, validation, and administrative actions.

Introduction

The Batches Page of is the primary production interface for working with document processing jobs after a solution has been designed and deployed. While the Design Page is focused on configuration, the Batches Page is focused on execution and oversight.

From the Batches page, users can:

• View all Batches within a selected project or folder.
• Monitor batch status (e.g., Created, Processing, Pending Review, Completed, Error).
• See the current processing activity and Batch progress.
• Open batches for:
  • Document Review
  • Data Review
  • Quality Control
• Execute batch-level commands such as:
  • Process
  • Reset
  • Update
  • Delete
• Filter and search for batches based on status, date, or other metadata.

The interface is designed for operational users, supervisors, and administrators who need real-time insight into workflow progress. It supports both automated processing pipelines and human-in-the-loop review stages, making it the central hub for day-to-day production management in Grooper.

Batches Page layout

• The top-most UI element, known as the Batch List, shows a list of Batches in production. The Batch List is a central UI component for managing and interacting with Batches in Grooper. It provides a dynamic, filterable table view of batches under a specified base folder or process, supporting efficient navigation, selection, and execution of batch commands. It enables users to browse, search, and act on large sets of batches. It supports paging (up to 1000 batches per page), column sorting, and searching by batch name or other criteria.
• The Bottom most UI element, known as the Batch Info Viewer, shows a series of tabs that have information about the Batch. The Batch Info Viewer control is a central component of the batch management user interface, providing users with a comprehensive, multi-tabbed view of batch-related data. It serves as the primary information panel for one or more selected batches, aggregating and presenting key batch data in a user-friendly, organized manner. It also enables users to quickly switch between different informational aspects of a batch, such as processing jobs, statistics, error events, history, and detailed properties.
• Above the Batch List are several Batch Commands. These consist of Pausing, Processing (or Resuming), Resetting Batch Process Steps, Updating the Batch Process, and or Deleting the Batch from the list.
• The buttons to the right of the Batch commands are commands that interact with the Batches List.
• The "Create New Batch" button allows you to create a new Batch. This command is designed for creating Batches that start with a Scan activity. When creating a Batch this way it will only consider Batch Process Steps that are of a Batch scope.
• When you click the "Create New Batch" button the "Create New Batch" window will open.
• The Name property allows you to name the Batch. The default setting of this property is a full "date-time" string. You can choose to name the Batch whatever you like.
• The Process property allows you to select a published Batch Process.
• The Priority property allows you to set a priority for the processing of Jobs and Tasks associated with the Batch. Set this to an integer from 1 to 5. 1 is the highest priority, while 5 is the lowest.
• The "Refresh" button will refresh the list of Batches below.
• The "Filter Batches" button allows you to adjust which Batches are displayed in the Batches list.
• When you click the "Filter Batches" button the "Batch Filter" window will open. From here you can adjust several properties that will affect which Batches are displayed.
• The "Upload Documents" button allows for the creation of Batches by selecting a small subset of documents. This button is meant for creating Batches for quick processing of a small Batch. Consider using this if you simply need to process one or two documents without going through a full Import setup. Batches created this way will consider and start with Batch Process Steps set to any scope.
• When you click the "Upload Documents" button the "Upload Documents" window will open.
• Click the "Choose Files" button to open a Windows Explorer and choose individual documents.
• Use the "Process" dropdown to select a published Batch Process.
• Notice this Batch is on a "Review" activity and is in the "Working" status (this also applies to the "Ready" status). If you double click this Batch...
• ...you'll be taken to the view of the Review task. From here you are actually interacting with the Review task and you can complete the task if desired.
• Notice the "Status" of this Batch is "Paused". If you double click this Batch...
• ...you'll be taken to a view where you can interact with the three main views of Folder View, Data View, and Thumbnail View. Using these views does not complete any Task, but you can use commands and adjust data to alter the Batch and its contents.

Batch Commands

• The "Pause" button will pause a Batch that is currently processing.
• The "Resume" button will resume processing a paused Batch.
• The "Reset" button will open a window and allow you to choose a Batch Process Step to reset.
• Pressing the "Reset" button will open the "Reset" window.
• The Target Step property allows you to choose where in the Batch Process to resume from.
• The Steps to Reset property allows you to choose which Batch Process Steps to reset.
• Clicking the ellipsis button for the Steps to Reset property will open the "Steps to Reset" window, allowing you to choose which steps to reset.
• The "Update Process" button will allow you to update the Batch Process.
• Pressing the "Update Process" button will open the "Update Process" window, where you can choose a Batch Process to update to, and which Batch Process Step where the Batch will begin processing.
• The "Delete" button will allow you to delete the selected Batch.

Batch Info Viewer

• The "Jobs" tab shows progress bars pertaining to the Tasks and Jobs of a selected Batch. The bars are color coded, giving "at a glance" information. Solid dark gray indicates a paused Batch. Gradient gray indicates unprocessed tasks. Blue indicates successfully completed tasks. Red indicates tasks that are in an error state.
• The "Statistics" tab gives statistical information about the Tasks and Jobs that have been processed for the selected Batch.
• The "Events" tab gives information about each event that has occured on a selected Batch. Information about the error status of failed Tasks can be viewed here.
• The "History" tab gives information, divided into columns, about the status of Jobs that have been processed for the selected Batch.
• The "Details" tab gives high level information about the contents of the selected Batch.