2023.1:Batch (Object): Difference between revisions

Revision as of 16:42, 23 January 2024

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

2025

2023.1

2023

Batches are the fundamental units for documents in Grooper. They are a hierarchy of folders and pages used to represent documents and process them.

Glossary

The following is a list of terms you will see in this article along with their definitions.

Batch: An object in Grooper that contains the documents brought into Grooper via scanning or import.
Batch Folder: Any folder contained within the Batch. This includes the Batch level itself.
Batch Page: A single page object in a Batch, usually found at the last level of the Batch. Also referred to as a "Page".
Batch Process: A Grooper object that consists of several Batch Process Steps that are designed to apply activities to a Batch.
Document Folder: Any Batch Folder that contains a complete document. Usually created after a Separate step in a Batch Process.
Folder Level: The place or "level" at which a Batch Folder or a Batch Page appears within a Batch.

About

What is a Batch?

A Batch is an object in Grooper that contains the documents brought into Grooper via scanning or import.

There are three components to a batch:

The Batch itself
Batch Folders
Batch Pages

Batch objects in Grooper contain two child objects:

The root Batch Folder, containing a hierarchy of Batch Folders and Batch Pages.
A read-only Batch Process, containing the list of processing instructions for the Batch Folders and Batch Pages

Below is an extremely simple Batch. We are viewing it Grooper Dashboard, using the "Batch Viewer" tab. Multiple folder levels can be created in a batch depending on how complicated your documents are.

The Test Batch is located here on the node tree.
The Test Batch has two child objects, the root Batch Folder and a read-only Batch Process.

If we open up the root Batch Folder...
We can see the Batch Pages. We can also view the hierarchy of Batch Folders and Pages here after Separation.

If we click on the Batch object in the node tree...
We can click on the "Viewer" tab to see the Batch Viewer.
Here we can see the contents of the Batch.

At the top level is the Batch itself.
Here we have the pages at Level 1 in the Batch.
Here we can see the Batch and Pages as objects in the node tree.

Through the process of separation, pages will be separated into document folders.
These pages are now contained within "Folder (1)".
Here we can see the hierarchy of folders and pages within the Batch in the node tree.

Folder Levels

A Batch can have one or more levels of Batch Folders. A Batch may even start out having no folder levels. Batch Pages can exist at any level in the Batch, but will most often be bottom-most level.

Documents are represented as Batch Folders with Batch Pages inside. These are also referred to as a Document Folders. So, a two-page document would be a Batch Folder with two Batch Pages inside, one for the first and one for the last. Part of Grooper's document processing workflow is (usually) separating documents from loose pages by setting up logical points to create new Batch Folders and put Batch Pages inside.

However, all Batch Process Activities in Grooper are performed at some level within the Batch, either at the Batch Page, at a certain Batch Folder level, or at the top level, the Batch itself.

For example, OCR text is obtained from images by running a Recognize activity at the Page level. Document classification is done by running a Classify activity at the Folder level. Exporting is done by running a Document Export activity at the Batch level.

@@ Line 1: / Line 1: @@
-{{Migrated2023}}
+{{AutoVersion}}
-{{2023:{{PAGENAME}}}}
+<blockquote>
+'''Batches''' are the fundamental units for documents in Grooper. They are a hierarchy of folders and pages used to represent documents and process them.
+</blockquote>
+== Glossary ==
+The following is a list of terms you will see in this article along with their definitions.
+* '''Batch''': An object in Grooper that contains the documents brought into Grooper via scanning or import.
+* '''Batch Folder''': Any folder contained within the '''Batch'''. This includes the '''Batch''' level itself.
+* '''Batch Page''': A single page object in a '''Batch''', usually found at the last level of the '''Batch'''. Also referred to as a "Page".
+* '''Batch Process''': A Grooper object that consists of several '''Batch Process Steps''' that are designed to apply activities to a '''Batch'''.
+* '''Document Folder''': Any '''Batch Folder''' that contains a complete document. Usually created after a Separate step in a '''Batch Process'''.
+* '''Folder Level''': The place or "level" at which a '''Batch Folder''' or a '''Batch Page''' appears within a '''Batch'''.
+== About ==
+=== What is a Batch? ===
+A '''Batch''' is an object in Grooper that contains the documents brought into Grooper via scanning or import.
+There are three components to a batch:
+# The '''Batch''' itself
+# '''Batch Folders'''
+# '''Batch Pages'''
+'''Batch''' objects in Grooper contain two child objects:
+* The root '''Batch Folder''', containing a hierarchy of '''Batch Folders''' and '''Batch Pages'''.
+* A read-only '''Batch Process''', containing the list of processing instructions for the '''Batch Folders''' and '''Batch Pages'''
+Below is an extremely simple Batch.  We are viewing it Grooper Dashboard, using the "Batch Viewer" tab.  Multiple folder levels can be created in a batch depending on how complicated your documents are.
+# The Test '''Batch''' is located here on the node tree.
+# The Test '''Batch''' has two child objects, the root '''Batch Folder''' and a read-only '''Batch Process'''.
+[[File:23.1 Batch 01 About 01 What is a Batch 01.png]]
+# If we open up the root Batch Folder...
+# We can see the '''Batch Pages'''. We can also view the hierarchy of '''Batch Folders''' and '''Pages''' here after Separation.
+[[File:23.1 Batch 01 About 01 What is a Batch 02.png]]
+# If we click on the '''Batch''' object in the node tree...
+# We can click on the "Viewer" tab to see the Batch Viewer.
+# Here we can see the contents of the '''Batch'''.
+[[File:23.1 Batch 01 About 01 What is a Batch 03.png]]
+# At the top level is the '''Batch''' itself.
+# Here we have the pages at Level 1 in the '''Batch'''.
+# Here we can see the '''Batch''' and '''Pages''' as objects in the node tree.
+[[File:23.1 Batch 01 About 01 What is a Batch 04.png]]
+# Through the process of separation, pages will be separated into document folders.
+# These pages are now contained within "Folder (1)".
+# Here we can see the hierarchy of folders and pages within the '''Batch''' in the node tree.
+[[File:23.1 Batch 01 About 01 What is a Batch 05.png]]
+=== Folder Levels ===
+A '''Batch''' can have one or more levels of '''Batch Folders'''. A '''Batch''' may even start out having no folder levels. '''Batch Pages''' can exist at any level in the '''Batch''', but will most often be bottom-most level.
+Documents are represented as '''Batch Folders''' with '''Batch Pages''' inside. These are also referred to as a '''Document Folders'''. So, a two-page document would be a Batch Folder with two Batch Pages inside, one for the first and one for the last. Part of Grooper's document processing workflow is (usually) separating documents from loose pages by setting up logical points to create new Batch Folders and put Batch Pages inside.
+However, all Batch Process Activities in Grooper are performed at some level within the Batch, either at the Batch Page, at a certain Batch Folder level, or at the top level, the Batch itself.
+For example, OCR text is obtained from images by running a Recognize activity at the Page level. Document classification is done by running a Classify activity at the Folder level. Exporting is done by running a Document Export activity at the Batch level.
+[[File:23.1 Batch 01 About 02 Folder Levels 01.png]]
+<!--
+=== Production vs Test Batches ===
+'''Batches''' exist in two environments:
+* '''Production'''
+** Stored in the '''Batches > Production''' branch of the Grooper node tree.
+* '''Test'''
+** Stored in the '''Batches > Test''' branch of the Grooper node tree.
+Test '''Batches''' are only visible to Grooper Design users.  Production '''Batches''' are visible to all users who have appropriate access rights.
+* Typically, production '''Batches''' are created and processed using the "/Grooper/Batches" page.
+** However, be aware, production '''Batches''' can be created and processed both from the "/Grooper/Design" page and the "/Grooper/Batches" page, meaning multiple users at multiple access levels can affect '''Batch''' workflow.
+* Test '''Batches''', however, will only be seen by "Design" users.