2023.1:Separation Profile (Node Type)

From Grooper Wiki

This article is about an older version of Grooper.

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

20252023.1

insert_page_break Separation Profiles store settings that determine how contract Batch Pages are separated into folder Batch Folders. Separation Profiles can be referenced in two ways:

  • In a Review activity's Scan Viewer settings to control how pages are separated in real time during scanning.
  • In a Separate activity as an alternative to configuring separation settings locally.

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023.1). The first contains a Project with resources used in examples throughout this article. The second contains one or more Batches of sample documents.

About

A Separation Profile is an object in Grooper that can be configured with settings that determine how loose pages are separated and grouped into documents, placing them in Batch Folders within the Batch. For each profile, a Separation Provider is specified, defining the method by which pages are separated.

There are two reasons you might want to configure a Separation Profile:

  1. A single Separation Profile can be referenced in the Separate Activity Step in multiple Batch Processes. This can minimize the amount of time you would need to configure the Separation Provider for multiple Batch Processes if the process of separation needs to be performed the same way for each.
  2. If you want to perform separation at the time of scanning, a Separation Profile must be configured and referenced in the Scan Viewer Review Step for separation to occur.
    • Only Scan-Supported Separation Providers can be selected on a Separation Profile used on a Scan Viewer step. For more on Text Based versus Scan-Supported Providers take a look at our Separation and Separation Provider articles.

FYI

Strictly speaking, Separation Profiles are not required in most cases. They are only required:

  1. When referencing one in the Scan Viewer settings to perform document separation at scan time.
  2. If you want to share separation settings with another user, you can export a Separation Profile without exporting your entire Batch Process.


How To

Add a Separation Profile

  1. To add a Separation Profile, first right click on the Project or Folder where you want to add the object.
  2. Hover over "Add".
  3. Then click on "Separation Profile..."


  1. Give a name to your Separation Profile.
  2. Click "EXECUTE" to create the Separation Profile.


  1. The Separation Profile should now show up in your node tree.

Setting the Separation Provider Property

  1. Select the Separation Profile in the node tree.
  2. Next to the Provider property, click on the hamburger icon to access the drop down menu. Choose which Provider you would like to configure for this Separation Profile.


  1. From there you can configure the Separation Provider the way you normally would.

For more information on Providers please see our Separation Provider article.


Using a Separation Profile on the Separate Activity Step

  1. Select the Separate step of a Batch Process.
  2. Here you have the option of setting a Provider or referencing a Separation Profile.


  1. Click the hamburger icon next to the Separation Profile property.
  2. Navigate the folders in the drop down list and select the Separation Profile.


  1. Now the Separate Step will reference the Separation Profile when it performs Separation. Notice that the option to add a Provider has disappeared since we have selected a Separation Profile instead.


Using a Separation Profile on the Scan Review Step

  1. Select the Scan Review Step in your Batch Process.
  2. Click on the ellipsis button to the right of the Views property.


  1. If it has not already been added, click the + button to add a new View.
  2. Click Scan View in the drop down menu.


  1. Select the Scan View from the list.
  2. Click the hamburger icon to the right of the Separation Profile property.
  3. Navigate through the folders to select the desired Separation Profile from the drop down.


  1. Click "OK" to apply changes.

Glossary

Activity: Grooper Activities define specific document processing operations done to a inventory_2 Batch, folder Batch Folder, or contract Batch Page. In a settings Batch Process, each edit_document Batch Process Step executes a single Activity (determined by the step's "Activity" property).

  • Batch Process Steps are frequently referred by the name of their configured Activity followed by the word "step". For example: "Classify step".

Batch Folder: The folder Batch Folder is an organizational unit within a inventory_2 Batch, allowing for a structured approach to managing and processing a collection of documents. Batch Folder nodes serve two purposes in a Batch. (1) Primarily, they represent "documents" in Grooper. (2) They can also serve more generally as folders, holding other Batch Folders and/or contract Batch Page nodes as children.

  • Batch Folders are frequently referred to simply as "documents" or "folders" depending on how they are used in the Batch.

Batch Process: settings Batch Process nodes are crucial components in Grooper's architecture. A Batch Process is the step-by-step processing instructions given to a inventory_2 Batch. Each step is comprised of a "Code Activity" or a Review activity. Code Activities are automated by Activity Processing services. Review activities are executed by human operators in the Grooper user interface.

  • Batch Processes by themselves do nothing. Instead, they execute edit_document Batch Process Steps which are added as children nodes.
  • A Batch Process is often referred to as simply a "process".

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

Project: package_2 Projects are the primary containers for configuration nodes within Grooper. The Project is where various processing objects such as stacks Content Models, settings Batch Processes, profile objects are stored. This makes resources easier to manage, easier to save, and simplifies how node references are made in a Grooper Repository.

Review: person_search Review is an Activity that allows user attended review of Grooper's results. This allows human operators to validate processed contract Batch Page and folder Batch Folder content using specialized user interfaces called "Viewers". Different kinds of Viewers assist users in reviewing Grooper's image processing, document classification, data extraction and operating document scanners.

Separate: insert_page_break Separate is an Activity that sorts contract Batch Pages into individual folder Batch Folders. This distinguishes "loose pages" from the documents formed by those pages. Once loose pages are separated into Batch Folder documents, they can be further processed by unknown_document Classify, export_notes Extract, output Export and other Activities that need to run on the folder (i.e. document) level.

Separation Profile: insert_page_break Separation Profiles store settings that determine how contract Batch Pages are separated into folder Batch Folders. Separation Profiles can be referenced in two ways:

  • In a Review activity's Scan Viewer settings to control how pages are separated in real time during scanning.
  • In a Separate activity as an alternative to configuring separation settings locally.

Separation Provider: The Provider property of the Separate Activity defines the type of separation to be performed at the designated Scope.

Separation: Separation is the process of taking an unorganized inventory_2 Batch of loose contract Batch Pages and organizing them into documents represented by folder Batch Folders in Grooper. This is done so Grooper can later assign a description Document Type to each document folder in a process known as "classification".