Separation Review

From Grooper Wiki
Jump to navigation Jump to search
This is an example of the Separation Review Attended Client interface.

Separation Review is an attended activity client allowing human review of document separation during the Separate activity before loose pages are placed in document folders.


Grooper uses various approaches to separate loose pages into document folders. Different Separation Providers establish the separation points (or binding points) for Batch Folder creation differently. Separation Review was designed specifically with the ESP Auto Separation Separation Provider in mind, which performs page level classification on a Batch of loose pages (and other methods) to both separate and classify the Batch. ESP Auto Separation removes but does not eliminate a lot of the manual work to separate and classify documents. Separation Review is a new review module designed to make the manual work quick and easy.

Use Cases

Use the Separation Review activity (in a Batch Process) any time a user will need to validate Separation and Classification is 100% accurate. The type of documents being processed (complexity, OCR result variances, etc.) can determine whether a user will need Separation Review.

Following is a (by no means exhaustive) list of industries whose documents have shown to frequently require Separation Review. These documents are considered unstructured document types due to complex and extremely variable language present on the document pages.

  • Oil & Gas
  • Legal
  • Healthcare

Documents that may optionally need Separation Review will depend on the priority of desired accuracy. These documents are considered structured document types because the pages contain predictable locations of repeated fields, tables, and sections used in both simple and complex classification techniques.

  • Accounts Receivable
  • Accounts Payable
  • Tax Documents
  • HR Documents
  • Healthcare

How To

Separation Review will always take place after a Separate activity is performed in a Batch Process.

If you want to take advantage of Separation Review, you don't actually want the Separate step to place the pages into folders. Rather, you want to review the Separation Provider's logic before creating Batch Folders in the Batch.

You must set the Bind Only property to True for the configured Separation Provider.

This can be done on the Separate activity itself or on the referenced Separation Profile.

Separation and review bind only.png

Configuring Separation Review

Separation Review is a configuration of the Review activity of a Batch Process.

1. First, create a Batch Process.
2. Add a Batch Process Step.
3. Set the Activity Type property to Review.

Separation and review 31a.png

4. Click the Batch Views property then its ellipsis button.
5. In the Tab Page Setup Collection Editor window, click the Add button.

  • This will add an item to the list named <NO CONTROL TYPE>.

6. In the Batch View Type property drop-down, select Separation Viewer.

Separation and review 31b.png

7. Click the Control Settings property then its ellipsis button.
8. In the Separation Viewer Settings window click the drop-down arrow next to the Separation Settings property to expose further properties.
9. Click the Scope property, then it's corresponding drop-down arrow, and from the drop-down node tree, select a Content Type.

Separation and review 31c.png

Property Details

Attachment Rules – Configure how certain document types should be attached to a regular document type.
Respect Original Page Numbers – If a PDF or mult-page TIF file is used to create individual pages, Grooper will keep track of the page’s original number and use that value to prevent the last page of one document from being attached to the first page of the next document.
Bind Only – If this is set to true, all pages will remain individual pages when Separation Review completes, which defeats the purpose of this module. As of this writing, setting this property to False seems to make Separation Review easier to complete.
Goto First Invalid Item – Separation Review will auto-select the first item that couldn’t be assigned a document type because that item’s confidence didn’t meet or exceed the threshold for confident classification set on the Content Model.
Flag Messages – Optional property to predefined acceptable messages to assign to items in Separation Review.

Interface Overview

Separation and review 14.png
Separation and review 15.png
The documents are highlighted with two alternating colors to easily distinguish how separation will occur without needing to check the name of the Document Type.

If an item has red text, this means the item has a classification flag. In this image, hovering over Page 9 would show a tooltip with the reason the item is flagged.

This image also shows pages because the Separate activity has the Bind Only property set to Truewhich will leave the pages as loose pages in the batch until choosing the Separate command at the end of the review process. If the Bind Only property is set to False, this image will show folders because the Separate activity proceeded to separate the pages into folders.

Separation and review 16.png
This is the Candidates list view showing a list of candidates and their respective confidences based on the current selection.

Appending and Prepending to Classified Groups of Documents

Right-clicking on Page 9 allows selection of the Prepend to Next object command. Ctrl+N is the shortcut key. Page 9 is now considered Page 1 of 4.
Separation and review 17.png
Separation and review 18.png
Right-clicking on Page 13 allows selection of Append to Previous object command. Ctrl+P is the shortcut key. Page 13 is now considered Page 5 of 5.
Separation and review 19.png
Separation and review 20.png

Multi-selecting Pages and Classifying Them

The keyboard should be the only control needed to work through Separation Review. When one or more pages are selected, start typing the name of the Document Type. This will filter the Candidates list view. Typing “paid” in this example, reduces the candidate list to five Document Types because their names have the word “paid” in them.

Separation and review 21a.png

When the desired Document Type is in the list, pressing the Tab button will cause the focus to change to the Candidates list view. Use the Up and Down buttons to highlight the correct document type.

Separation and review 22.png

Pressing Enter when the correct Document Type is selected will classify the pages to the highlighted (from the Candidate list view) document type.

Separation and review 23.png

Select Span

It is necessary at times to make a multi-selection to grab all the pages pertaining to a particular document. Using the mouse or keyboard to select a page, then shift or control select the remaining is possible, however unnecessary with the Select Span command. One need simply select a page of a document, and use the Select Span object command whose hotkey is Ctrl+S. With the Select Span object command used, all the pages of the document are selected. From here one could Ctrl+UP or Ctrl+DOWN hotkeys to move the entire document up or down in the list of documents.
Separation and review 24.png Separation and review 25.png

Completing Separation Review

Above the list of pages is the Separate button. It will only be enabled when all pages have a classification assigned.

-Starting Separation Review-
Separation and review 26.png

-When all pages are classified-
Separation and review 27.png

When all pages are classified and the Separate button is clicked, the list will change and show all pages separated into classified documents. Notice the Folder icons and Folder names.

Separation and review 28.png

Clicking the button next to the separate button will undo the separation and revert folders back to pages.

-All pages are separated into folers.-
Separation and review 29.png

Clicking the (blue arched arrow) Undo button will undo all manual classification performed during Separation Review and revert the batch of pages to their previous state when Separation Review started. Note that deleted pages will not be recovered. Deleted pages are permanently unrecoverable.

Object Commands from the Context Menu

Separation and review 30.png

Append to Previous – Attaches selected item(s) to the preceding items above the selection.
Prepend to Next – Attaches selected item(s) to the proceeding items below the selection.
Delete – Deletes selected item(s).
Select Span – Shortcut command to highlight all items in the same color group.
Separate – Applies separation to items currently classified.
Unseparate – Removes separation to items currently in classified folders.
Move Up – Moves the selected item(s) up in the item order.
Move Down – Moves the selected items(s) down in the item order.
Flag Item – Assign a flag to an item for other workflow needs post-Separation Review.
Goto Next Loose Page – Auto-selects the next page not confidently assigned a document type.
Remove PDF Version – Removes an existing pdf file attached to the item.
Image – Provides a selection of image adjustment commands to apply to the current page.
Scan Once – Changes the current display image format.
Send To – Provides a selection of export commands to apply to the current page.
Properties – Displays metadata of a selected page.

Version Differences

Grooper 2.80 - Classification Review

Grooper 2.80 and previous versions relied on Classification Review with its various controls to separate loose pages, merge selected pages into documents, and correct misclassified folders or classify unclassified folders. This user interface required a moderate-to-large effort to complete classification and separation, especially when reverting one or more folders to loose pages in order to combine the same pages into separate documents and classifying each newly created document.

Grooper 2.9 - Separation Review

Separation Review is a new Attended Client in Grooper version 2.90.

When using the ESP Auto Separation provider to separate and classify documents, the Separation Review module should replace Classification Review, which will also still be available for legacy support or other use cases. Don’t be concerned about this being a new module. Slap the name “Classification Review 2.0” on Separation Review because Separation Review really is a true upgrade and efficiently redesigned approach of Classification Review. Consider it a godsend!

The design of Separation Review invites the heavy use of the keyboard and keyboard shortcuts to make quick work of any items needing corrective action. Many quality-of-life improvements now exist and are quickly realized if one has previous experience using Classification Review.

Even though this is a review client for separation, it is really designed to work in concert with ESP Auto Separation which also classifies the separated documents. Therefore, some classification tasks take place in this module. In the How To section, items in the list are color coded. The list shows current classification of the items. This doesn’t necessarily mean they are currently separated into documents. The actual separation occurs later. During use of Separation Review, using the various context menu commands will assist and ensure pages are classified correctly and ready for proper separation.