2023.1:Batch (Object): Difference between revisions

From Grooper Wiki
← Older editNewer edit →
Start // Edit via Wikitext Extension for VSCode
No edit summary
Line 62: Line 62:
=== Folder Levels ===
=== 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.
When scanning pages into Grooper, the pages come in one at a time and there is no differentiation between one document or another. As part of Grooper's workflow, pages are normally separated into '''Document Folders''' (each folder containing one complete document) so that Grooper knows where one document begins and ends.  


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.
Depending on the complexity of the documents brought into Grooper, sometimes a '''Batch''' can be comprised of multiple levels of '''Batch Folders''' within '''Batch Folders''' until you get to the '''Document Folder''' with the pages inside (A '''Document Folder''' is just a '''Batch Folder''' that contains the pages of a document).  


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 certain activities, it is important to tell Grooper which Folder Level the activity needs to be executed on.
 
* The Batch Level is always the first and top folder in the Batch. It contains all folders and pages within the '''Batch'''. This is considered "Level 0".
* The first set of '''Batch Folders''' under the Batch Level is considered "Level 1".
* A folder that is inside of a "Level 1" folder is at a "Level 2", a folder that is inside of a "Level 2" folder is at a "Level 3", and so on.
* A Page is always considered to be at the "Page Level". Sometimes you will have pages inside folders of different levels, but you always want to run certain activities on all pages. You would set those activities to a "Page" level.  


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.
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 73: Line 78:
[[File:23.1 Batch 01 About 02 Folder Levels 01.png]]
[[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.
[[File:23.1 Batch 01 About 02 Folder Levels 02.png]]
* 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.

Revision as of 10:03, 24 January 2024

This article is about an older version of Grooper.

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

20252023.120232.80

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:

  1. The Batch itself
  2. Batch Folders
  3. 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.

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


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


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


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


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

Folder Levels

When scanning pages into Grooper, the pages come in one at a time and there is no differentiation between one document or another. As part of Grooper's workflow, pages are normally separated into Document Folders (each folder containing one complete document) so that Grooper knows where one document begins and ends.

Depending on the complexity of the documents brought into Grooper, sometimes a Batch can be comprised of multiple levels of Batch Folders within Batch Folders until you get to the Document Folder with the pages inside (A Document Folder is just a Batch Folder that contains the pages of a document).

For certain activities, it is important to tell Grooper which Folder Level the activity needs to be executed on.

  • The Batch Level is always the first and top folder in the Batch. It contains all folders and pages within the Batch. This is considered "Level 0".
  • The first set of Batch Folders under the Batch Level is considered "Level 1".
  • A folder that is inside of a "Level 1" folder is at a "Level 2", a folder that is inside of a "Level 2" folder is at a "Level 3", and so on.
  • A Page is always considered to be at the "Page Level". Sometimes you will have pages inside folders of different levels, but you always want to run certain activities on all pages. You would set those activities to a "Page" level.

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.



Retrieved from "https://wiki.grooper.com/index.php?title=2023.1:Batch_(Object)&oldid=19025"