2022:Web Client: Difference between revisions

From Grooper Wiki
← Older editNewer edit →
Line 1,485: Line 1,485:
* Sections can be tools to group data into a category, sub-divide a document into smaller units, or establish "multi-instance" sections (more on what this means later).
* Sections can be tools to group data into a category, sub-divide a document into smaller units, or establish "multi-instance" sections (more on what this means later).


As a reviewer, it's your job to check Grooper's results for each of these '''Data Elements''' after the '''Extract''' activity collects them.  This is precisely what the '''''Data Viewer''''' is for.
As a reviewer, it's your job to check Grooper's results for each of these '''Data Elements''' after the '''Extract''' activity collects them.  This is precisely what the '''''Data Viewer''''' is for.  There's a lot of things that can go wrong in the wide world of document processing.  Optical Character Recognition (OCR) can convert a document's image to digital text.  However, it's not perfect.  Rarely will your OCR results be 100% accuracy.  If the document's underlying text data is imperfect, so may be your data extraction.  There might be other problems with the extraction logic's ability to find and return data.  This is especially the case for document sets with a lot of variety.  If a document has a data structure that has not been properly modeled in the '''Data Model's''' design, there's a good chance Grooper will fail to return the data at all or only return partial data.  Regardless why the error occurred, you, the reviewer, are the last line of defense to ensure accurate data is captured for each document.


<tabs style="margin:20px">
<tabs style="margin:20px">
Line 1,514: Line 1,514:


# Instead of using a folder hierarchy, you can navigate through the documents in the '''Batch''' using the Folder Navigator at the top of the Review Panel.
# Instead of using a folder hierarchy, you can navigate through the documents in the '''Batch''' using the Folder Navigator at the top of the Review Panel.
#* There are eight document folders in this '''Batch'''.  I have navigated to the fourth document in the '''Batch'''.  So we are at folder "4" of "8", indicated by "4 / 8".
#* There are eight document folders in this '''Batch'''.  I have navigated to the sixth document in the '''Batch'''.  So we are at folder "6" of "8", indicated by "6 / 8".
#* You may use the single arrow buttons to go to the next or previous document.
#* You may use the single arrow buttons to go to the next or previous document.
#* You may use the double arrow buttons to go to the first and last document.
#* You may use the double arrow buttons to go to the first and last document.
#* You can also type the number of the document you want to select in the number box.
#* You can also type the number of the document you want to select in the number box.
# The document's classified '''Document Type''' and folder number is listed next.
# The document's classified '''Document Type''' and folder number is listed next.
#* Pro Tip: If you need to reclassify the document at this point, you can right click this heading and choose "Assign Document Type" to change its '''Document Type'''.  Be aware changing a document's '''Document Type''' will clear its extracted data.  However, you can also right click this heading and select "Extract" to re-run Grooper's data extraction.
#* Pro Tip: If you need to reclassify the document at this point, you can right click this heading and choose "''Assign Document Type''" to change its '''Document Type'''.  Be aware changing a document's '''Document Type''' will clear its extracted data.  However, you can also right click this heading and select "''Extract''" to re-run Grooper's data extraction.
# The document's extracted data occupies the rest of the Review Panel.  The various fields, tables and sections established in the document's '''Data Model''' are listed here with their extraction results placed in editable text boxes.
# The document's extracted data occupies the rest of the Review Panel.  The various fields, tables and sections established in the document's '''Data Model''' are listed here with their extraction results placed in editable text boxes.
|valign=top|
|valign=top|
Line 1,537: Line 1,537:
|-
|-
|valign=top|
|valign=top|
<br>
# Press the warning icon to get more information about the errors present.
# Press the warning icon to get more information about the errors present.
# This will toggle a list of every field or table cell with an error and its corresponding error message.
# This will toggle a list of every field or table cell with an error and their corresponding error message.
#* In this case it's telling us the "Invoice Total" field's "Value is required".
#* In this case it's telling us the "Invoice Total" field's "Value is required".
# Any field in table cell in an error state will be highlighted red.
# Any field in table cell in an error state will be highlighted red.
Line 1,555: Line 1,556:


We will start our journey into data review by looking at how to review fields.  We will use the same set of invoice documents we reviewed for classification previously.  And this is a fairly common part of your workflow.  First, you review Grooper's work to make sure the documents are classified correctly.  Once Grooper knows what kind of document it's working with, it knows what data its looking for and how to find it.  Now that Grooper has extracted the data, we can use the Data Viewer to verify it collected all the data required and collected it accurately.
We will start our journey into data review by looking at how to review fields.  We will use the same set of invoice documents we reviewed for classification previously.  And this is a fairly common part of your workflow.  First, you review Grooper's work to make sure the documents are classified correctly.  Once Grooper knows what kind of document it's working with, it knows what data its looking for and how to find it.  Now that Grooper has extracted the data, we can use the Data Viewer to verify it collected all the data required and collected it accurately.
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="font-size:14pt"|'''FYI'''||It should be noted document '''Data Models''' have a high degree of configurability.  Obviously, unless you're processing invoices, the specific data elements you will be reviewing in your environment will be different.  You may have hundreds of data points to review on a single document.  You may have just a few.  That all depends on the business requirements for your document set and what your organization deems appropriate to extract from them.
However, the basics remain the same across all use cases.  Grooper will extract information from the document, populate that data into fields and tables, and you'll review the results based off what you a human can see on the document.
|}
==== Required Fields ====
Commonly, an organization will deem certain data critical for document processing.  Certain fields ''must'' therefore be extracted in order for the work to be considered complete.  In Grooper, we satisfy this requirement by making a field "required".  This will place the field (or table cell) in an error state if no value was extracted at all.  In the '''''Data Viewer''''', Grooper will alert you that the required value is missing, and will require you to manually enter it before review is completed.
{|cellpadding=10 cellspacing=5
|valign=top style="width:40%"|
In the case of this document's '''Data Model''' three fields are required:
* Invoice Number
* Invoice Date
* Invoice Total
# We have navigated to the second document in the '''Batch'''.
# The "Invoice Number" and "Invoice Date" fields extracted just fine.
# The "Invoice Total" field did not.  It is empty or "blank".
#* Grooper will highlight any required fields that are empty in red.
# When you enter that field's textbox, Grooper will pop up a message indicating the problem, "Value is required."
|valign=top|
[[File:Web-review-data-view-05.png]]
|-
|valign=top|
<br>
# All we need to do is enter the value for this invoice total as it appears on the document.
# Type the value into the field's textbox and press <code>Enter</code> or <code>Tab</code> to move to the next field.
# You will see the error warning disappear because the data error was resolved.
# Press the ''Save'' button to save any changes made to the document's data.
|valign=top|
[[File:Web-review-data-view-06.png]]
|}
==== Data Model Differences ====
Before looking at more problems, please be aware '''Data Models''' can be (and often are) different for individual '''Document Types'''.  For the most part, we're working with a "flat" '''Content Model'''.  All the '''Document Types''' share the same '''Data Model''', meaning we're looking for the same data elements for each one.  However, in your environment, each '''Document Type''' may represent more diverse kinds of documents and require their own individual '''Data Models''' with their own specific fields and tables.  Or, your '''Document Types''' may all share some data elements, but have some addition fields unique to the individual '''Document Type'''.
{|cellpadding=10 cellspacing=5
|valign=top style="width:40%"|
<br>
This is the case with our "Envoy" '''Document Type'''.  For the most part, the data we want to collect from this '''Document Type''' is the same as the rest.  However, ''just'' for the "Envoy" '''Document Type''' we want to collect the purchase order number listed on the invoice.  For whatever reason, we'll pretend have a business need for the PO number from this vendor, but none of the rest.
# The top half of the review screen is occupied by the "parent" '''Data Model's''' fields.  These are the ones shared by all '''Document Types'''.
# Then, we have the additional "Envoy" '''Data Model's''' elements we can review as well.
#* In our case it's a single "PO Number" field in a section named "Additional Details"
# We review the field just like we would any other field, and continue to the next document.
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="font-size:14pt"|'''FYI'''||Pro Tip! 
Most users find tabbing through fields with the <code>Tab</code> key is the easiest way to review a document's fields in the '''''Data Viewer'''''.
If you are on the ''last'' field of a document (such as this one) and press the <code>Tab</code> key, it will save the document and take you to the next one in the '''Batch'''.
|}
|valign=top|
[[File:Web-review-data-view-07.png]]
|}
==== Data Element Overrides (and Required Validation) ====
Another way '''Data Models''' can differ from '''Document Type''' to '''Document Type''' is through "Data Element Overrides" (sometimes just called "overrides" for short).  This allows Grooper designers to change how fields, tables and sections behave for a specific '''Document Type''' while still maintaining a parent '''Data Model''' shared by multiple '''Document Types'''.
We're going to use another common review feature to demonstrate this.  There may be some data that is not only required to be present, but extremely important Grooper extracted accurately.  Your Grooper designer may designate this as a field that requires validation.  So, even if it's accurately extracted, the field will stay in an error state until the user clears it.
{|cellpadding=10 cellspacing=5
|valign=top style="width:40%"|
For the "Ankara" '''Document Type''', we've decided the "Remit To Address" requires manual validation.  We've set up an override so that ''just'' this '''Document Type''' requires validation for this field.  For the rest of them, we'll just take what Grooper gives us.
# Fields requiring validation will ''always'' be in an error state until the field is reviewed.
#* Grooper will give you an error message saying "This field must be reviewed"
# In our case, Grooper ''did'' extract this address accurately.  What's on the document is what's in the extracted field.
So, how do we proceed?  We have to get rid of the error or Grooper will consider this an "invalid" document.
|valign=top|
[[File:Web-review-data-view-08.png]]
|-
|valign=top|
<br>
To clear the error, you must "confirm" the field is valid.
# Right click in the field's text box.
# Select ''Confirm''
#* Or, you can use the keyboard shortcut <code>F6</code>
|valign=top|
[[File:Web-review-data-view-09.png]]
|-
|valign=top|
<br>
#<li value=3> This will confirm the value is correct, and the textbox's color will change to green.
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="font-size:14pt"|'''FYI'''||You may have noticed there are still data errors present on this document.  The total number of errors dropped from "4" to "3".
The remaining three errors pertain to the extracted table data.  We will circle back to these issues in the next section when we discuss reviewing table extraction in Grooper.
|}
|valign=top|
[[File:Web-review-data-view-10.png]]
|}
==== Rubberband OCR ====
==== "Valid" Doesn't Mean Accurate ====


</tab>
</tab>

Revision as of 12:21, 17 March 2022

WIP This article is a work-in-progress. It was written using a beta version of 2022. This article is subject to change and/or expansion as it is updated to the release version of 2022.

This tag will be removed upon draft completion.

The Grooper Web Client allows users to connect to a Grooper dashboard over the internet via a web server. This allows end-users to process review based steps in a Batch Process in a web browser, without the need to install Grooper on their own machine.

About

THIS SECTION TO BE COMPLETED AT A LATER DATE

⚠ The Grooper Web Client DOES NOT support Internet Explorer.

The following browsers are supported:

  • Microsoft Edge
  • Google Chrome
  • Mozilla Firefox

    • Other modern browsers may work but have not been fully tested, such as:

  • Apple Safari
  • Opera Web Browser

    • Installation

    Setting up the Grooper Web Client is done in three simple steps:

    1. Install the IIS components on your server.
    2. Install the Grooper Web Client application.
    3. Open the Web Client URL in a browser and start using it.

    As a side note, there are some additional requirements for users scanning paper documents into Grooper with a physical scanner. These requirements will be detailed in the #Scanning with Web Review section of this article.

    1. Install IIS

    The first step to setting up your server for Grooper Web Review is installing the IIS (Internet Information Services) components.

    ⚠ It's important to do this step first. Installing and setting up IIS first is required before installing the Grooper Web Client.


    Open the Server Manager application.

    1. Select Manage.
    2. Select Add Roles and Features.


    2. On the following screen, select Next.


    Next, you will be asked to select the Installation Type.

    2. Select Role-based or feature-based installation.
    3. Select Next to continue.


    Next, you will be asked to select a server on which to install the IIS.

    2. Select the server.
      • FYI: The local server is selected by default.
    3. Select Next to continue.


    2. In the following screen, scroll down to the bottom of the list to select Web Server.


    2. In the following prompt, select Add Features.
    3. Then, select Next.


    No additional Features are necessary.

    2. Select Next to continue.


    2. On the Web Server Role (IIS) screen, select Next.


    2. In the Role Services selection panel, select the following components (FYI: If a window appears asking you to add features, select Add Features):
      • Web Server
        • Common HTTP Features
          • Default Document
          • Static Content
        • Security
          • Request Filtering
          • Basic Authentication
          • Windows Authentication
        • Application Development
          • .NET Extensibility 4.5
          • ASP.NET 4.5
          • ISAPI Extensions
          • ISAPI Filters
          • WebSocket Protocol
      • Management Tools
        • IIS Management Console
        • IIS 6 Management Compatibility
          • IIS 6 Metabase Compatibility
        • IIS Management Scripts and Tools
        • Management Service
    3. Select Next after all components are selected.


    The last step is to confirm your IIS installation.

    2. Verify the settings are correct and all required components are present.
    3. Select Install.


    2. Close the install wizard.
      • FYI: You may close the install wizard while IIS is installing. It will continue to install in the background.


    2. Upon successful installation, we can see IIS in the Server Manager application.

    With IIS installed, our next step is to install the Grooper Web Server.

    FYI You may want to add a service user account at this time. The service account must have full access to the Grooper database and file store to function properly.

    2. Install Grooper Web Client

    Next, we will install the Grooper Web Client application.

    ⚠ If you have not done so already, install Grooper and add repository connections before continuing.

    If you need instructions on installing Grooper, please visit the Install and Setup article.


    First, you will need to download the Grooper Web Client Installer from the Downloads and Resources section of Grooper x Change

    1. After unzipping the installer package, run the setup application.


    2. Select Next to start installation.


    2. Accept the terms of the licensing agreement.
    3. Select Next to continue.


    In the following screen, you will enter the user name and password of the account that will logon to use the application.

    ⚠ Before selecting a user, ensure the user has permissions access to the Grooper database and file store location. The user must be able to read and write to the database and file store.

    This is where you would want to enter a service account's information, if you are choosing to use one. The account must have access to the database and file store in order to do work in Grooper.

    2. Enter the account's user name and password.
      • FYI: You may also use the Browse... feature to help find the domain and user, if you need.
    3. Select Next to continue.


    2. Select Next to continue setup.


    2. Select Install to initialize installation.


    You will see the following screen upon successfully installing the Grooper Web Client.

    2. Select Finish to finish installation.


    You can verify the Grooper Web Client was installed by opening Microsoft's Internet Information Services (IIS) Manager.

    1. Under your server, select Application Pools.
    2. You will see Grooper listed in the Application Pools.
    3. In the Sites folder, you can also select the Grooper site created.

    FYI One of the most common issues with installing the Grooper Web Client are permissions related. The service account must have permissions to the Grooper database and file store for each Grooper Repository. Users will not be able to create a Batch or process review steps using Web Review if it does not.

    If you did not choose an account with appropriate credentials during the Grooper Web Client installation, you will need to switch users to an account with appropriate access.

    To add a service account with proper credentials do the following:

    1. Select the Grooper Application Pool.
    2. Select Advanced Settings....
    3. The Advanced Settings window will pop up.
    4. Scroll down to the Identity property and configure it with the new user account.

    You will need to restart the Application Pool after making changes.

    3. Access Web Client


    At this point, users are ready and able to access the Grooper Web Client using a URL.

    By default, the Web Client URL will be the following:

    • http://<YOUR_SERVER_NAME>:13930
    1. Open up a browser and enter the URL.

    You can now start using the Grooper Web Client. We will detail the UI navigation and how to execute Review tasks in the #User Guide section of this article.

    Click here to return to the top

    Security

    Most likely you don't want any old user to access the Grooper Web Client. If you wish to limit the users able to access Grooper by a web browser, you'll need to update the Security settings in Grooper Design Studio. This will allow you to grant users access by adding individual users or user groups using Windows ACL.

    Step 1: Add a Designer (or Designers)


    To restrict Grooper Web Client users, you must first add at least one Grooper Designer.

    1. In Grooper Design Studio, navigate to the root node of the Grooper Repository.
    2. Select the Designers property and press the ellipsis button at the end.
    ⚠ Notice the Designers property lists 0 Access Control Entries

    Until you list at least one user as a "Designer", any valid user on the domain will have access to Grooper (both Design Studio and Web Client). Selecting one or more Designers will allow only specified users the capability to do design work in Grooper Design Studio.


    1. This will bring up the ACL Editor window.
    2. You can either search for users by group or individual user.
    3. Search for the user you want to add, and select it from the list.
    4. Press the Add button to add the user as a Designer.


    1. This will add the selected user to the Designers list.
    2. Press OK to add the user.


    1. This will designate the user as a Designer.
      • They will then have rights to do work in Grooper Design Studio, such as creating and editing Content Models and Batch Processes.
      • If multiple users need access to Grooper Design Studio, they will all need to be added to the Designers list.
    2. Press the Save button to save changes.

    Now that a Designer has been added, we can add Users. The users added to the Users list will be able to use Review steps in Batch Processes and will enable the usage of Review Queues.

    FYI Review Queues allow further security control in Grooper. For example, if you have several Batch Processes but want to limit a user's ability to only review one particular Batch Process, you can use a Review Queue to do that.

    Please note, you must add a user to the Users list before configuring a Review Queue. We will discuss Review Queues later in this article.

    Step 2: Add Users

    Now that a Designer has been added, we can add Users. The users added to the Users list will be able to use Review steps in Batch Processes and will enable the usage of Review Queues.

    FYI Review Queues allow further security control in Grooper. For example, if you have several Batch Processes but want to limit a user's ability to only review one particular Batch Process, you can use a Review Queue to do that.

    Please note, you must add a user to the Users list before configuring a Review Queue. We will discuss Review Queues later in this article.


    To add a Grooper User:

    1. Select the root node of the Grooper Repository.
    2. Select the Users property and press the ellipsis button at the end.


    1. This will bring up the ACL Editor window.
    2. You can either search for users by group or individual user.
    3. Search for the user you want to add, and select it from the list.
    4. Press the Add button to add the user as a User.


    1. This will add the selected user to the Users list.
    2. Press OK to add the user.


    1. This will designate the user as a User.
      • They will then have rights to do review work in Grooper. They will be able to access the Grooper Web Client and execute Review tasks in a Batch Process.
      • If multiple users need access to Grooper Design Studio, they will all need to be added to the Designers list.
    2. Press the Save button to save changes.

    Step 3: Logon to Web Client

    Now, only listed Users will have access to do review work via the Grooper Web Client.


    Upon opening the Grooper Web Client URL, users will be prompted to enter their credentials. Only users entered as a Designer or a User will be able to access the Web Client.

    FYI You may not be prompted to log in if you're accessing the Web Client and your machine are on the same domain. In that case, your Windows credentials may simply be passed through automatically.

    Click me to return to the top

    User Guide

    Welcome to the Grooper Web Client! The Grooper Web Client allows users to process documents using a web browser.

    In the following sections, we will give end-users guidance on how to navigate the Web Client user interface and use it to process Batches and review their documents. We will discuss the following topics:

    • #Web Client UI - How to navigate Grooper using a web browser
    • #Performing Review Tasks - How to process human-attended document review activities
    • #Review Applications - How to use the various review-based activities in Grooper
    • #Batch Management - How to maintain document Batches in production (pausing work, updating processing instructions, and more) and access Batch statistics and the event log.

    Web Client UI

    The first thing you're going to want to know is how to get around the Grooper Web Client interface.


    To access the Grooper Web Client, simply enter the URL provided to you by your Grooper administrator.

    • You may be prompted to enter user account credentials, as seen in this screenshot.
    • If you do not see this screen, it's likely Windows passed through your own logon credentials automatically.
    ⚠ The Grooper Web Client DOES NOT support Internet Explorer.

    The following browsers are supported:

  • Microsoft Edge
  • Google Chrome
  • Mozilla Firefox

    • Other modern browsers may work but have not been fully tested, such as:

  • Apple Safari
  • Opera Web Browser
    		•


    Upon entering the URL, you'll land at the Web Client's homepage. This page is divided into four main sections:

    1. Navigation Links
    2. Repository Info
    3. Recent Events
    4. Context Toolbar

    Navigation Links

    The Navigation Links section is the main way you'll get around in the Web Client. It contains a variety of links for Grooper users, including:


    Batches - Used to access a list of all current Batches in production.

    • From here, users can see and select Batches in process. They can also filter Batches by a variety of search criteria, use a search function to search for Batches by keyword, and process user attended review activities.

    Tasks - Used to access a list of review tasks ready for users.

    • This is another way for end-users to select and start review based work via the Web Client. Only review tasks ready for processing will be presented to the user. Users can also filter review tasks by Batch, Batch Process, Step or Queue.

    Learn - Used to access Grooper University courses at learn.grooper.com.

    • This is an external resource for Grooper designers who have an active training subscription.

    Connect - Used to access our Grooper x Change web forums at xchange.grooper.com.

    • This is an external resource for Grooper users to interact with each other. Users can post questions to the Grooper community, including other users and our own internal team. We also post news, links to installer files, information about about our beta programs and more using Grooper x Change.

    Wiki - Used to access our wiki site at wiki.grooper.com

    • If you're reading this you've already found our Grooper wiki! This is an external resource containing articles about a variety of Grooper topics.


    FYI The Designer and Analyze links are currently greyed out and unclickable.

    These are placeholders for content coming in future Grooper releases.

    Repository Info

    The Repository Info window provides some "at a glance" processing statistics and information about your Grooper Repository.


    A Grooper Repository is the environment in which processing resources are created and executed. This includes the Batches of documents themselves, the Batch Processes used to process them, and components used in the Batch Process such as Content Models.

    This data displayed in the Repository Info window subdivided into three sections:

    Totals

    • This is a running total of various aspects of the Repository, including the total number of published Batch Processes, total tasks in current and previous Batches in production, and total number of "nodes" (the processing objects Grooper architects create in Grooper Design Studio).

    Tasks

    • This displays numbers regarding the review based activities for Batches in the Repository, including those ready for processing, those currently being worked on, and those that were previously completed.
    • This can give end-users a quick view of tasks awaiting review.

    Nodes

    • This displays the total number of specific types of Grooper objects in the Repository.
    • This information will be most useful for Grooper architects working in Grooper Design Studio.

    Recent Events

    The Recent Events window is Grooper's event log.


    This panel displays information regarding different processing events. This includes audit trails of processing events, such as Batch creation, task steps in a Batch Process submitted for processing, and Batch completion. This also includes warnings and error messages, giving you information about errors processing steps of a Batch Process.

    This panel can be useful to track down information or a sequence of events if you're troubleshooting a problem.


    FYI If you're familiar with the thick client version of Grooper Design Studio, this is essentially the same event log you see when selecting the root node of your Grooper Repository.

    Context Toolbar

    The Context Toolbar is a navigation bar providing various utility in the Web Client.


    Depending on the context (which page you've navigated to), this menu will change slightly. However, please note wherever you are in the Grooper Web Client, clicking the Grooper logo will always take you back to this home screen.

    Click here to return to the top

    Switching Grooper Repositories

    Depending on the size and scope of your operation, you may be working out of multiple Grooper Repositories. If you are, you may need to switch between Grooper Repositories to access documents ready for processing in one or the other.


    To do this, you'll use the Repository button on the homepage's Context Toolbar.

    1. First, the Grooper Repository you're currently working in is always displayed at the top of the homepage.
    2. To switch Repositories, click the Repositories button.

    A dropdown menu will appear listing available Grooper Repositories you're connected to.

    2. Select the Repository you wish to switch to from the list.


    Upon making your selection you will switch to the selected Repository, granting you access to all the Batches and processing assets contained therein.

    1. You'll see the Repository listed at the top of the homepage has changed to the selected Repository.

    Performing Review Tasks: The Batches and Tasks Pages

    Documents come into Grooper either by scanning pages or importing files into a Batch. A Batch is the fundamental container of work in Grooper. It holds your documents as they are processed through Grooper. Along with the container comes a list of processing instructions called a Batch Process.

    So a Batch is really two things:

    1. A container of documents in various states of processing.
      • These are represented as Batch Folders and Batch Pages contained in the Batch Root Folder.
    2. A step by step list of instructions of what to do with those documents.
      • This is the Batch Process.

    A Batch Process will consist of automated tasks called Unattended Activities, as well as review-based activities requiring user intervention called Attended Activities. For end-users, most of your work will be centered around document review tasks (or Attended Activates). In these activities, you will review the automated work Grooper has done in previously in the Batch Process. For example, you may be reviewing the classification decisions Grooper made or reviewing Grooper's data extraction to ensure all data was captured accurately.

    Different organizations will utilize human review to varying degrees. Depending on the use case, Grooper may be able to automate more work without the need for human intervention. However, as good as Grooper can be at making document processing decisions, no computer software can beat the human brain. Review tasks are well suited for situations where you need to ensure the accuracy of Grooper's results in one way or another. You play a critical role in verifying Batches are processed accurately through the steps of a Batch Process.

    So, how do you get started?

    There are two ways users can start processing review tasks in a Grooper Repository, either using the Batches or Tasks pages. Either is acceptable. These present two different ways of displaying available work in Grooper. We will start by reviewing the Batches page.

    Batches Page


    The Batches page will present a user interface to select Batches currently in production within the Repository. Users will be able to see the Batch's progress and process any human attended Review activity.

    To get to the Batch page, click the Batches icon on the Grooper Web Client homepage.

    1. In the Navigation Links panel of the homepage, click the Batches link.


    This will bring up the Batches interface. The first thing you'll see is a list of Batches currently in process.

    FYI If you're familiar with the Grooper Dashboard application in the Grooper thick client, this should look very familiar to you. The interface is very similar, if not identical, just with a different skin.

    You can sort the Batch List by the following properties:

    1. Batch
      • This column lists the name of the Batch. Often, this name will be related to the Batch Process used with a timestamp tacked onto the end.
    2. Process
      • This column lists the Batch Process assigned to the Batch. These are the step-by-step processing instructions given to the Batch.
    3. Step
      • This is the current step in the Batch Process being applied to the Batch.
    4. Activity
      • This is the current step's Activity type.
      • FYI: You can name a step whatever you want in a Batch Process. Many steps simply share the Grooper activity's name. However, for Review tasks in particular, you'll often find they are given a more descriptive name, describing the type of review you're going to do for that step.
    5. Status
      • This describes the state of the Batch's current step. This can be Working if the step is currently processing, Ready if the step is able to be processed and just waiting for a user to start it, or Paused if the whole Batch has been placed in a paused state, preventing any steps from being processed.
    6. Priority
      • This is the priority assigned to the Batch. Higher priority steps will consume system resources before lower ones, effectively processing first.
    7. Created
      • This is simply the date and time the Batch was created.
    8. Created By
      • This is the Grooper user who created the Batch.


    If you have a particularly large number of Batches, you can narrow down what you're looking for using the search box or the filter utility.

    1. In the search box you can free search any text in the Batches, Process, Step or Activity columns.
    2. Or, you can select the Filter icon, to filter out Batches by certain criteria.
    3. This will bring up a window to filter out your selection based on Status, Process, Step or Activity.
    4. Click the arrow next to the property heading you want to filter by.
    5. Check the box next to the specific value you want to filter by.
    6. Click "Save" to execute the filter or "Cancel" to cancel.


    Now that we've gotten the lay of the land, you're probably asking yourself how do I actually start doing work in Grooper? How do I start reviewing documents?

    1. First, select a Batch from the list.
    2. The "Progress" tab displays the current progress of the selected Batch.
    3. Each rectangle represents a step in the Batch Process.
    4. The step's name is listed under the rectangle.
    5. These numbers indicate how many tasks have been processed for the given step.
      • In this case there were 8 out of 8 total document folders in the Batch processed by the Classify step.
      • FYI: If you're wondering why the previous Recognize step lists "9/9" and not "8/8", that's because Recognize ran on the page level and not the folder level. There were 9 total pages and 8 total folders in this Batch. We'll talk more about the difference between pages and folders later on in this article.


    What color the step is will indicate something about the steps processing status.

    1. Blue indicates the step's tasks were completed successfully (or without error).
    2. Grey indicates the step is ready for processing.
    3. Black indicates the step is awaiting processing or otherwise has not been processed.
      • Either it's waiting its turn for steps before it, the Batch has been "paused", or in certain circumstances the step was skipped.

    Red will indicate one or more tasks in the step have failed to process for one reason or another.

    Green will indicate one or more tasks in the steps are actively being processed.


    For end-users doing review work in Grooper, you will be processing steps with the "Review" activity type that are ready for processing.

    1. For these four batches, all are currently at a Review step in their process.
    2. However, only one is listed as "Ready'"
    3. With the Batch selected we can see in the "Progress" tab, the step is grey, also indicating it is ready for processing.
      • Both a step's Status listed as Ready and its color being grey mean the same thing. It's just two different ways of visualizing/understanding it's ready to go.
    4. To start the Review module, simply double click the Batch.


    This will bring up the Review activity module to perform one kind of review or another, be it classification review, data review, image processing review or another. In Grooper, the different kinds of review applications are displayed as "Views". For example, the type of review this step is doing is classification review. The user is presented a "Classification Viewer" in order to verify each document in the Batch is classified correctly.

    We will discuss how to use this "Classification Viewer" and the other "Review Views" later in the #Review Views section of this article.

    For now, we're going to simply exit the review module.

    1. To exit without saving your work, press the "Stop" button to return to the Batches page.
    2. Or, click the Grooper icon to return to the homepage.

    Tasks Page


    The Tasks page is different from the Batches page in that it only presents users with Batches with Review steps currently ready for processing. Users can pick and choose which Batch they want to review, or they can set up a task filter and start processing all Batches it returns in order the Batch's age.

    To get to the Tasks page, click the Tasks icon on the Grooper Web Client homepage.

    1. In the Navigation Links panel of the homepage, click the Tasks link.


    This will bring up the Tasks interface. The first thing you'll see is a list of Batches with Review steps ready for processing.

    FYI This interface and how you interact with it is very similar to using the Grooper Attended Client thick client application. This program also allows users to filter production Batches with Review steps ready for processing and start processing them.


    1. The list of Batches is always sorted by Age with the oldest Batch listed first the the newest created Batch listed last.
    2. You can select also the Filter icon, to filter out Batches by certain criteria.
    3. This will bring up a window to filter out your selection based on Queue, Process, Step or Batch (the Batch's name).
    4. Click the hamburger icon at the end of the to the property heading you want to filter by.
    5. Select the specific value you want to filter by.
      • For example, we could select a particular Batch Process which would give us a list of only Batches with that Batch Process
    6. Click "Save" to execute the filter or "Cancel" to cancel.


    To start reviewing Batches, you have two options.

    1. You can select a single Batch from the list by double clicking it.
    2. You can press the "Play" icon to start reviewing all Batches in the list that match your filter.
      • Once one Review task is completed, the next Review task in the list for the next Batch will automatically open.
      • This is a handy way to start feeding yourself review work, without manually selecting each Batch every time you complete a Review task.


    Just as we saw using the Batches page, this will bring up the Review activity module to perform one kind of review or another, be it classification review, data review, image processing review or another. For example, this is the exact same "Classification View" module for the exact same Batch we saw earlier. The document review is identical whether you open the Review step using the Batches page or the Tasks page. The only difference is how you get there.

    The individual "Review Views" will be discussed in the #Review Applications section of this article.

    For now, we're going to simply exit the review module.

    1. To exit without saving your work, press the "Stop" button to return to the Tasks page.
    2. Or, click the Grooper icon to return to the homepage.

    Click here to return to the top

    What is a Document?

    Before continuing, lets take some time to cement some Grooper terminology we've been using as well as some of the icons you'll be seeing through the rest of this article.

    As we've mentioned previously, a Batch is the fundamental collection of work in Grooper's document processing. It is essentially two things:

    1. A container of documents in various states of processing.
    2. A step by step list of instructions of what to do with those documents, or its Batch Process.

    We often use the term "document" loosely. It can be an overly generic term for the stuff in the Batch that Grooper is doing stuff to. However, from Grooper's perspective a "document" is a very specific thing represented in a specific way in a Batch. So what is a document really?

    Grooper has two objects to represent items in a Batch:

    • Batch Folders
    • Batch Pages

    So, anything in a Batch is either a folder or a page.

    A "document" is just a special kind of folder. In the most basic sense, a "document" is a folder with content. That content can be child Batch Pages or a digital file (like a PDF) attached to the folder.


    This is Grooper's normal representation of a Batch as a hierarchy of Batch Folders and Batch Pages.


    At the top is the Batch Root.

    • This is always represented by a folder icon and named after the Batch itself. The Batch Root is truly just a folder. Just like any other folder, it contains items. It's just a special folder in that its at the top of the folder hierarchy, containing all items below it.


    Batch Folders will be represented by a folder icon.

    • So both "Folder (1)" and "Folder (2)" are Batch Folders.


    Batch Pages are represented by thumbnails of the page's image.


    There's a big difference between "Folder(1)" and "Folder (2)".

    • "Folder (1)" is a document (or a "document folder").
    • "Folder (2)" is not (It's just a simple folder).

    Why? "Folder (1)" has content. It contains two Batch Pages, "Page 1" and "Page 2". We can expand the folder's contents using the arrow button to the left of the folder icon.

    "Folder (2)" has no content, making it a regular old folder.

    FYI You'll often hear Grooper users talk about a parent/child relationship. A parent/child relationship describes how items (called "objects" or "nodes") are related at different levels in a hierarchical structure, such as our Batches. In this case, the pages (which are at Level 2 of the Batch hierarchy) are children of the document folder "Folder (1)" (which is at Level 1 of the Batch hierarchy). "Folder (1)" is the parent of its child pages. Folder (1) is a child of the Batch itself (which is the root or Level 0 of the Batch hierarchy).

    Simple enough, right?

    Next, let's talk about classification. A classified document is a document folder who has been assigned a Document Type from a Content Model.

    Grooper architects design Content Models to determine what makes one kind of document distinct from another and how to get information from them. These "different types of documents" are distinguished as Document Types created in the Content Model. By assigning a document folder a Document Type, Grooper then can use the logic defined in the Content Model to extract data from it.

    Proper document classification is often critical to the process downstream. So, it's paramount to make sure Grooper assigned a document the right Document Type. One of the things you may be doing in Grooper is executing a classification review module to do just that.


    However, be aware, once a document is classified, the items in your Batch are going to look a little different.

    Here, "Folder (1)" has been classified. It's folder name has changed to "Federal W-4 (1)". Why? It was assigned a Document Type named "Federal W-4".

    • Notice the icon changed as well, from a folder icon to a document icon.


    "Folder (2)" is still not a document, just a folder. It has no content.


    "Folder (3)" is a document, just an unclassified one. It does have content, but no Document Type assigned to it.

    • Its name remains the generic "Folder" name, and its icon has not changed.


    So, a document is a special kind of folder, and a classified document is a special kind of document.

    • Documents are folders with content.
    • Classified documents are documents that have been assigned a Document Type.

    ⚠ If you're importing files (such as PDFs or TIFF files), rather than hooking Grooper up to a scanner to bring in content, please pay attention to this next part.

    The two main ways to get content into Grooper is by scanning pages directly into a Batch or importing files (such as PDF or TIF documents) from a file system.

    If you are importing document files, Grooper will create a Batch Folder for every file imported, and attach that file to the folder. Things will look a little different than what we've described so far.

    Here we have three Batch Folders created for three PDF files imported into a new Batch. Absolutely no processing steps have been executed for this Batch.

    However, for each folder...

    1. You'll see the document icon instead of the folder icon for each item.
    2. The folders are named "Document (#)" instead of "Folder (#)".
    3. The file imported for each folder is attached to the folder and listed under its name.

    Are these folders documents? Yes

    • While these folders do not have child content, like pages, they have attached content in the PDFs attached to each folder.

    Are these documents classified? No

    • Despite sharing the same icon as a classified document, these documents are not classified.
    • They will not be classified until they are assigned a Document Type and their name changes from "Document (#)" to "Document Type Name (#)"

    To sum up:

    • All documents are folders. Not all folders are documents.
    • Documents are folders with content.
      • Content can be child pages (or documents).
      • Content can be files attached to the folder.
    • Classified documents are documents who have been assigned a Document Type.

    Review Views

    In this section, we will demonstrate the various document review applications in Grooper and how to use them.

    When you start processing Review steps in a Batch, you're going to see one or more different "Views" into the Batch. These Review Views present the Batch in different ways, best suited for the type of work you're doing. In these Views, you will verify Grooper's work during automated steps of a Batch Process and use the review modules to manually edit a document if Grooper made a mistake.

    There are currently four Review Views available in Grooper:

    Classification Viewer
    • You will use this to verify how Grooper classified a document during the Classify step. You may also use this view to verify how pages were separated into document folders during the Separate step.
    Data Viewer
    • You will use this to verify how Grooper extracted data from a document during the Extract step.
    Thumbnail Viewer
    • You will use this to review individual page images. Most commonly, this is used to verify how pages were processed by an IP Profile (for example, during the Image Processing step) or otherwise ensure the pages are ready for OCR during the Recognize step.
    Folder Viewer
    • This is a fairly generic Batch viewer. This is most often added as a secondary Review View so that the user has an option to navigate to folders using the standard folder/page hierarchy view.

    Document Viewer Tips


    The Document Viewer is a common element among all Review Views. It will always occupy the right-most panel of the Review screen. It's how you, the user, can inspect a document or page selected in a Batch.

    Before we get into each of the individual Review Views and how to use them, let's familiarize ourselves with the Document Viewer. This will include quality of life advice, such as how to zoom in and out of a page's image.

    Zooming In and Out


    By default, the image will be zoomed to a Width view. The image will fill the viewer based on the width of the document.

    The zoom view is indicated by the Zoom setting at the top right of the image.


    There are three ways to zoom in or out of a document's image.

    1. Double-click the image to cycle through a Width, Height, Full or Fit view.
    2. Hold the Ctrl key and use the mouse wheel to zoom in and out of the image more granularly.
    3. Use keyboard shortcuts to select a zoom view or zoom in or out.


    1. Double Click to Zoom

    1. Double click the image to cycle to the next zoom view.
    2. This will change the zoom setting from Width to Height, filling the viewer based on the height of the document.
      • Double clicking again will change the view from Height to Full.
      • Double clicking one more time will change the view from Full to Fit.
      • Double clicking another time after that will cycle back to Width.


    2. Mouse Wheel to Zoom

    You can also use the mouse wheel to zoom in and out of the image.

    1. Be sure your cursor is hovered over the image.
      • If you don't, you'll end up controlling the zoom view for your entire browser window.
    2. Press and hold the Ctrl on your keyboard and either:
      • Scroll forward on the mouse wheel to zoom in.
      • Scroll backward on the mouse wheel to zoom out.
    3. You will see the zoom percentage reflected in the zoom setting.

    You can zoom in up to 300% of the image's size and zoom out up to 5% of its size.


    3. Keyboard Shortcuts

    Alternatively, you can use the following keyboard shortcuts to control the zoom view:

    Zoom Setting Keystroke
    Width W
    Hieght H
    Fit F
    Full 1
    Zoom In I
    Zoom Out O

    Resizing Panels

    You may also resize the Document Viewer panel. This can be particularly helpful when using the Data Viewer to review extracted data.

    For example, we can't see all the the extracted table data here. There's a fourth column hidden out of view.


    We can resize the Document Viewer panel to see more of the Review Viewer panel, using our mouse.

    1. Hover your cursor between the Review Viewer and the Document Viewer.
      • You will see the narrow gap between the two panels change to a purple color.
    2. Click and hold the left mouse button.


    2. Move your mouse right to narrow the Document Viewer or left to widen it.
    3. With the Document Viewer narrowed, we can see all four columns of the extracted table data.

    Rendition Views

    The Rendition Views are found at the top right of the Document Viewer. This allows users different views of the document or page's content. Depending on the circumstance, review users may find one Rendition View most helpful to complete their Review task.


    The Rendition Views are as follows:

    • Child Rendition
    • Attachment Rendition
    • Text Rendition


    Attachment Rendition

    If you ingested documents into a Batch by importing files (such as PDFs) from a file system, you will be able to access the Attachment Rendition. When files are imported into Grooper, a document folder is created for each file, and that file is attached to the folder.

    1. The attached file listed here is the original imported file attached to the document folder.
      • In this case it's a PDF file named "08.pdf".
    2. Selecting the Attachment Rendition will display this attached file.
    3. For multipage documents, you can use the page navigator to navigate between pages.


    Child Rendition

    The Child Rendition will display a document's content, as composed of its child objects. For example, if a folder has child pages, the document is the sum total of all its pages.

    1. Expanding out this folder shows it has two child page objects.
      • FYI: In this case, an activity called Split Pages was applied to the document folder. This created a page for each page in the attached PDF. The attached PDF was a two-page file. So, we ended up with two child pages in the folder.
    2. Selecting the Child Rendition will display the folder's content, as comprised of its child objects and their images.
      • In this case, a document formed from the two pages in the folder.
    3. If there are multiple child pages, you can use the page navigator to navigate between pages.


    Text Rendition

    The Text Rendition will display a document's OCR or extracted native text data.

    1. Selecting the Text Rendition will displays the document's Grooper generated full text data.
    2. Instead of an image, every line of text is displayed in the Document Viewer.
    3. Page breaks will be displayed like so.


    There are also some toggleable controls at the top of the Document Viewer.

    1. Click this button to toggle word wrapping.
    2. Click this button to toggle line numbers before each line of text.

    Click here to return to the top

    Classification Viewer

    The Classification Viewer allows Grooper users to review document classification. Grooper classifies documents using logic defined in a Grooper Content Model. Document Types are added to the Content Model to distinguish one type of document from another. Grooper is able to tell one Document Type from another by using trained examples of the documents, assigning rules for classification, or some combination of the two. Most typically, a document is assigned a Document Type during the Classify step of a Batch Process (although there are other ways depending on the Batch Process and how documents are ingested to a Batch).

    Starting the Review Step


    In the Classification Viewer you will visually verify the Document Type Grooper assigns is correct. You will either manually assign documents a Document Type if Grooper was unable to classify the document or change the document's Document Type if Grooper misclassified the document.

    1. We will select this this Batch to review Grooper's document classification during the Classify step.
    2. As you can see the step's name is "Classification Review"
    3. The steps activity type is "Review"
    4. And most importantly, its status is "Ready", indicating it's ready to be processed.
    FYI A Grooper designer can name a Batch Process step whatever they want, but the activity type for review steps, regardless of the Review View, will always be Review.

    Most often, the Grooper designer will name the review step after the kind of review that's being done or the Review View being used. However, be aware if the Grooper designer does not provide a custom name, the Review step will simply be named "Review".


    When you open the Classification Viewer module, this is what you'll see. The Batch's documents are presented in the typical folder hierarchy viewer.

    1. Your job will be to select document folders and ensure the correct Document Type was assigned.
    2. Document Types are listed in the Document Types Viewer panel below the Batch Viewer panel.
      • In this example, we will be reviewing invoices. We've created a Document Type for each invoice's vendor.
    3. The document type will be listed in the folder's name.
      • For example, this document's name is "Nama (2)". It was assigned a Document Type named "Nama" (or the "Nama" Document Type).
    4. If a document was not classified, it will be flagged.
      • This is indicated by the red dot next to the folder.
      • Furthermore, the folder's name will remain the generic "Document".

    Reviewing Document Classification


    1. To start reviewing, select a document folder.
    2. This will bring up the document in the Document Viewer panel.
    3. The document's classification results will be displayed in the Document Types Viewer.


    1. This document as assigned the "Fairdeal" Document Type.
    2. Why? Grooper determined it to be most similar to the "Fairdeal" Document Type based on the Content Model's classification logic.
      • In this case it scored an 87% similarity rating.
      • Put another way, Grooper is 87% confident this is a "Fairdeal" document.
    3. While there is some similarity to other Document Types, they are less than the "Fairdeal" Document Type's similarity.
      • Grooper will always assign the document the Document Type whose similarity is highest.

    Grooper's calculation of these similarity scores are based on a variety of things, such as training algorithms and extraction rules. While Grooper tries to emulate what a human does when it looks at a document and makes a decision as to what it is, it's purely mathematical in nature. If the score is highest, its that Document Type from Grooper's perspective.

    You, as a human being, are intuitive. You can make cognitive connections a computer simply can't. So, your job is to look at the document and make sure Grooper got it right.


    Is this an invoice from Fairdeal Services?

    1. Yes. Grooper got it right. You can see the company's logo.
    2. You can see the invoices remittance address is addressed to Fairdeal Services.
    3. If you're familiar with invoices from this company, you will notice patterns in how the document is structured, how information is visually laid out on the page.
      • Whatever the use case is, you will use your knowledge of the document set to decide what the document is, and therefore what Document Type should be assigned, often within a split-second for each document.

    Your job for the document is done. You've verified its Document Type is correct.

    2. You can move on to check the next document.
      • You may use your mouse and click on the next document.
      • You can also use the Up and Down arrow keys on your keyboard to navigate from one document to the next.

    Correcting Document Classification


    So what happens when things go wrong?

    1. Notice "Document (5)" has a flag next to it.
      • It has not been assigned a Document Type.
      • Also, the folder's name being "Document" is another indication it hasn't been classified.
    2. Why? It's not similar enough to any Document Type for Grooper to confidently classify the document.
      • FYI: By default, a document must score a similarity rating of 60% for a Document Type to be assigned. However, this can be adjusted. In your environment, your Grooper designer may have lowered that to allow a document to be classified below that threshold.
    3. This document should have been assigned the "Risiti" Document Type as it is an invoice from Risiti Construction.

    So, we need to fix this and manually assign the Document Type. There are two ways to do this.

    Option 1: Right Click and Assign Document Type

    1. Right click the document you want to classify.
    2. Select Assign Document Type.
      • Or, you can use a keyboard shortcut by selecting the document and pressing Ctrl + Shift + A on your keyboard.


    This will bring up the "Assign Document Type" window.

    1. Press the hamburger button at the end of the Content Type property.
    2. Select the appropriate Document Type from the Content Model.
      • In our case, we've selected "Risiti"
    3. Click the Apply button to assign the Document Type.

    FYI You can also use the search box to search for a Document Type by name. Simply start typing in the search box


    Upon applying your selection, the Document Type will be assigned to the document.

    1. The document's name has changed to "Risiti"
    2. The "Risiti" Document Type is now selected in the Document Types Viewer.


    FYI You may have noticed the flag remains on the document after manually assigning it a Document Type.

    Depending on how the Classification View is configured in Grooper Design Studio, you will either be allowed to complete your review with flagged documents or you will not be able to complete the task until all flags are resolved.

    If you can't complete review until flags are resolved, you will need to remove the flag.

    To remove a flag from the document:

    1. Right click the document.
    2. Select Clear Flag.
      • Or, you can use a keyboard shortcut by selecting the document and pressing Ctrl + Shift + L on your keyboard.

    Option 2: Use the Document Types Panel

    A quicker method of manually classifying a document may be to simply select the right Document Type from the Document Types Panel. We will use the next document in our Batch to illustrate this.

    Another common problem that can arise is Grooper misclassifying a document.

    1. This document was classified as an "Ankara" Document Type.
    2. It should have been classified as a "Biha" Document Type, but its similarity score was too low.
      • "Ankara" scored an 89%. "Biha" scored an 87%. 89 is greater than 87. So, "Ankara" won out.


    Rather than right clicking the document in the Batch and selecting a Document Type from a dropdown list, you can also simply double click the right Document Type in the Document Types Panel.

    1. Double click the Document Type in the Document Types Panel.
    2. The document will be assigned that Document Type.
      • So, our document changed from "Ankara" to "Biha".

    Option 2.5: Better Utilizing the Document Types Panel

    You should continue checking all document folders to ensure they've been classified correctly. We have one more problem in our Batch to resolve.

    1. Check out "Document (8)".
      • This document is flagged and unclassified. This should have been assigned the "Rechnung" Document Type, but it wasn't. It was not classified whatsoever.
    2. However, it scored a very high 92% similarity to the "Rechnung" Document Type, and it's also the most similar Document Type.
      • What gives? Why wasn't it classified?
    3. The problem is its not different enough from the next most similar Document Type.
      • "Rechnung" scored 92%. "Standard" scored 91%. That's only a 1% difference in their similarity.
      • In effect, this is "too close to call". Grooper has erred on the side of caution and not classified the document, leaving it up to the reviewer to determine which Document Type is correct.
    FYI By default, Grooper requires at least a 2% difference in Document Type similarity. However, this minimum difference can be increased or decreased in Grooper Design Studio.


    So, we need to manually classify the document. This gives us an opportunity to demo a handy shortcut.

    1. Select the document you want to classify and press the Tab key on your keyboard.
    2. This will move you to the Document Types Search Box. Start typing the Document Type you want to select.
    3. Once you've narrowed down which Document Type you're looking for, simply press enter to assign the document the selected Document Type.
      • FYI: You can also use the Up and Down arrow keys in the Document Types Viewer to select Document Types as well.

    This is particularly useful if you have a large Content Model with dozens or hundreds of Document Types.

    Completing the Review Step


    1. Once all documents have been reviewed, you're ready to complete the task.
    2. To do this, you'll press the "Complete Task" button in the Context Toolbar.


    You will be presented with a Confirmation window to verify you're ready to complete the review task.

    1. Press the OK button to complete the task.


    1. This will complete the Review step in the Batch Process
    2. Grooper will start processing the next step in the Batch Process.


    ⚠ When in any Review View, you will have three buttons in the Context Toolbar.
    1. Complete Task
    2. Stop Task
    3. Delete Task


    The Stop Task button will close the Review task. This will exit the Review View and return you to the previous page.

  • If you Stop Task, changes to the Batch ARE SAVED.
  • This means if you stop review work on a Batch, you (or another reviewer) can pick up where you left off.


    • The Delete Task button will delete the current task, typically meaning it will delete the current Batch you are reviewing.

  • There is no "undo delete" in Grooper. If you Delete Task, you will delete the Batch without going back.
  • DO NOT press the Delete Task button unless you are absolutely sure you want to delete the Batch forever.
    		•

    Completion Criteria

    The Classification Viewer may be configured so that certain criteria must be met in order to complete the review task. If so configured, either or both of the following conditions must be satisfied:

    • All document folders must be classified.
    • All flags on document folders must be removed.

    If this completion criteria has been enabled, and a Batch has documents that are flagged and/or unclassified, you the Classification Viewer will notify you in two ways:

    1. A yellow exclamation mark will appear next to the Classification Viewer' tab.
    2. The Complete Task button will be greyed out.
      • This button will be unclickable until the completion criteria is satisfied. This is Grooper's way of ensuring all documents have been reviewed before the task is completed.

    Click here to return to the top
    Shortcuts
    Shortcut Keystrokes Description
    Shared Folder and Page Commands
    Flag Item Ctrl + L Places a flag on the selected folder/page. Users may select pre-generated flag messages or enter their own custom message.
    Clear Flag Ctrl + Shift + L Removes a flag on the folder/page.
    Delete Del This will delete the selected folder/page. CAUTION!!! There is no "undo" in Grooper. If you delete an item, it will be gone forever.
    Rename F2 Renames the folder/page. Be aware, this does not classify a document folder. It only changes the folder's name.
    Cut Ctrl + X Cuts a selected folder/page in the Batch.
    Copy Ctrl + C Copies a selected folder/page in the Batch.
    Paste Ctrl + V Pastes a copied or cut folder/page to the selected folder location in the Batch.
    Move Down Ctrl + Down Moves the selected folder/page down in the Batch.
    Move Up Ctrl + Up Moves the selected folder/page in the Batch.
    Append to Previous Ctrl + P For folders, this appends any of a selected folder's children (pages or folders) to the folder before it. Effectively this will delete the selected folder and move any of its pages/folders to the bottom of the previous document/folder.

    For pages, this will move the selected pages to the bottom of the previous folder above.

    Prepend to Next Ctrl + Shift + P For folders, this prepends any of the selected folder's children (pages or folders) to the folder after it. Effectively this will delete the selected folder and move any of its pages/folders to the bottom of the next document/folder.

    For pages, this will move the selected pages to the bottom of the next folder below.

    Merge Selected Ctrl + M Merges selected folders/pages into a new document. This will create a folder, prompt you to assign it a Document Type, and move the selected folders/pages into the new folder.
    Folder Specific Commands
    Assign Document Type Ctrl + Shift + A Opens a window to select a Document Type for the selected document.
    Goto Flagged Ctrl + G Selects the next document in the Batch with a flag. If there are no subsequent documents with flags in the Batch, it will cycle back to the first document with a flag.
    Remove Level Ctrl + U Deletes the folder and moves any child objects (pages or folders) to the folder's level in the Batch. For example, if there was a document folder at Level 1 in the Batch with a single page in it (at Level 2). The folder would be deleted and the page would be moved to Level 1 in the Batch.
    Insert Folder Ins Adds an empty folder to the selected folder.
    Page Specific Commands
    Rotate Left Ctrl + Left Rotates the page 90 degrees to the left (counter-clockwise).
    Rotate Right Ctrl + Right Rotates the page 90 degrees to the right (clockwise).
    Split Folder Ctrl + S Splits a document into a new folder at the selected page. This applies specifically to document folders with multiple pages. Imagine you have a five page document folder at Level 1 in the Batch. You select page 3 and apply the "Split Folder" command. This will cut pages 3 to 5 from the document folder and place them into an unclassified folder at Level 1. You'll end up with two folders created out of the original (One containing pages 1 and 2. One containing pages 3 to 5) both at the same level in the Batch hierarchy (Level 1).

    Data Viewer

    The Data Viewer is used to review the data Grooper collects from each document during the Extract step of a Batch Process.

    The Extract activity applies the logic set up in a Content Model to find and return data from a document. This extraction logic is defined by configuring Data Models. Data Elements are added to the Data Model for each piece of information you want to collect.

    There are three types of Data Elements. Data can be collected as either Data Fields, Data Tables or Data Sections (or "fields", "tables" and "sections" for short).

    • Fields are for what's called "single instance" data.
      • Think a social security number on a W-2 form. There will be one single social security number filled in for the whole document. There is a single instance of this information (hence the term "single instance"), collected as a single value for the field.
    • Tables are necessary to collect information listed in a table formed by rows and columns on a document.
    • Sections can be tools to group data into a category, sub-divide a document into smaller units, or establish "multi-instance" sections (more on what this means later).

    As a reviewer, it's your job to check Grooper's results for each of these Data Elements after the Extract activity collects them. This is precisely what the Data Viewer is for. There's a lot of things that can go wrong in the wide world of document processing. Optical Character Recognition (OCR) can convert a document's image to digital text. However, it's not perfect. Rarely will your OCR results be 100% accuracy. If the document's underlying text data is imperfect, so may be your data extraction. There might be other problems with the extraction logic's ability to find and return data. This is especially the case for document sets with a lot of variety. If a document has a data structure that has not been properly modeled in the Data Model's design, there's a good chance Grooper will fail to return the data at all or only return partial data. Regardless why the error occurred, you, the reviewer, are the last line of defense to ensure accurate data is captured for each document.

    Starting the Review Step


    In the Data Viewer you will verify the data Grooper extracts from each document is correct. If what Grooper extracts does not match up with what's on the page, you will edit the result using text box editor.

    1. We will select this Batch to review Grooper's data extraction results obtained during the Extract step.
    2. As you can see, the step's name is "Data Review'"'.
    3. The step's activity type is "Review".
    4. And, most importantly, its status is "Ready", indicating it's ready to be processed.
    FYI A Grooper designer can name a Batch Process step whatever they want, but the activity type for review steps, regardless of the Review View, will always be Review.

    Most often, the Grooper designer will name the review step after the kind of review that's being done or the Review View being used. However, be aware if the Grooper designer does not provide a custom name, the Review step will simply be named "Review".


    When you open the Data Viewer module, this is what you'll see. This is a different view into a Batch than we've seen so far. It's designed specifically to give us information about the data collected for each document.

    1. Instead of using a folder hierarchy, you can navigate through the documents in the Batch using the Folder Navigator at the top of the Review Panel.
      • There are eight document folders in this Batch. I have navigated to the sixth document in the Batch. So we are at folder "6" of "8", indicated by "6 / 8".
      • You may use the single arrow buttons to go to the next or previous document.
      • You may use the double arrow buttons to go to the first and last document.
      • You can also type the number of the document you want to select in the number box.
    2. The document's classified Document Type and folder number is listed next.
      • Pro Tip: If you need to reclassify the document at this point, you can right click this heading and choose "Assign Document Type" to change its Document Type. Be aware changing a document's Document Type will clear its extracted data. However, you can also right click this heading and select "Extract" to re-run Grooper's data extraction.
    3. The document's extracted data occupies the rest of the Review Panel. The various fields, tables and sections established in the document's Data Model are listed here with their extraction results placed in editable text boxes.


    1. The yellow exclamation mark indicates data errors. There is something wrong with the data for at least one document.
      • This could mean a required value was not extracted, something requires manual validation, Grooper extracted data that did not match a field's expected type, or a custom validation event placed an error on a field.
    2. By default, Grooper will not allow you to complete the review task, until all data errors are resolved. The Complete Task button will remain grey and unclickable until all data errors have been resolved.
      • FYI: Depending on the Batch Process, you may need to complete the review task with errors present. In those cases, your Grooper designer will configure the Data Viewer so that you will be able to complete with errors unresolved.
    3. The yellow document icon in the Folder Navigator indicates there are "invalid documents". The number displays how many documents have data errors.
      • You can click this icon to navigate to the next invalid document.
    4. The red warning icon indicates there are data errors in the selected document's data. The number displays how many fields or table cells are in an error state.


    1. Press the warning icon to get more information about the errors present.
    2. This will toggle a list of every field or table cell with an error and their corresponding error message.
      • In this case it's telling us the "Invoice Total" field's "Value is required".
    3. Any field in table cell in an error state will be highlighted red.
    4. When you select that field, the error message will pop up next to it.


    Next, we will dig into some of these common data errors and how to resolve them by discussing how to review fields, tables and sections in the Grooper Web Client.


    Reviewing Data Fields

    We will start our journey into data review by looking at how to review fields. We will use the same set of invoice documents we reviewed for classification previously. And this is a fairly common part of your workflow. First, you review Grooper's work to make sure the documents are classified correctly. Once Grooper knows what kind of document it's working with, it knows what data its looking for and how to find it. Now that Grooper has extracted the data, we can use the Data Viewer to verify it collected all the data required and collected it accurately.

    FYI It should be noted document Data Models have a high degree of configurability. Obviously, unless you're processing invoices, the specific data elements you will be reviewing in your environment will be different. You may have hundreds of data points to review on a single document. You may have just a few. That all depends on the business requirements for your document set and what your organization deems appropriate to extract from them.

    However, the basics remain the same across all use cases. Grooper will extract information from the document, populate that data into fields and tables, and you'll review the results based off what you a human can see on the document.

    Required Fields

    Commonly, an organization will deem certain data critical for document processing. Certain fields must therefore be extracted in order for the work to be considered complete. In Grooper, we satisfy this requirement by making a field "required". This will place the field (or table cell) in an error state if no value was extracted at all. In the Data Viewer, Grooper will alert you that the required value is missing, and will require you to manually enter it before review is completed.

    In the case of this document's Data Model three fields are required:

    • Invoice Number
    • Invoice Date
    • Invoice Total
    1. We have navigated to the second document in the Batch.
    2. The "Invoice Number" and "Invoice Date" fields extracted just fine.
    3. The "Invoice Total" field did not. It is empty or "blank".
      • Grooper will highlight any required fields that are empty in red.
    4. When you enter that field's textbox, Grooper will pop up a message indicating the problem, "Value is required."


    1. All we need to do is enter the value for this invoice total as it appears on the document.
    2. Type the value into the field's textbox and press Enter or Tab to move to the next field.
    3. You will see the error warning disappear because the data error was resolved.
    4. Press the Save button to save any changes made to the document's data.

    Data Model Differences

    Before looking at more problems, please be aware Data Models can be (and often are) different for individual Document Types. For the most part, we're working with a "flat" Content Model. All the Document Types share the same Data Model, meaning we're looking for the same data elements for each one. However, in your environment, each Document Type may represent more diverse kinds of documents and require their own individual Data Models with their own specific fields and tables. Or, your Document Types may all share some data elements, but have some addition fields unique to the individual Document Type.


    This is the case with our "Envoy" Document Type. For the most part, the data we want to collect from this Document Type is the same as the rest. However, just for the "Envoy" Document Type we want to collect the purchase order number listed on the invoice. For whatever reason, we'll pretend have a business need for the PO number from this vendor, but none of the rest.

    1. The top half of the review screen is occupied by the "parent" Data Model's fields. These are the ones shared by all Document Types.
    2. Then, we have the additional "Envoy" Data Model's elements we can review as well.
      • In our case it's a single "PO Number" field in a section named "Additional Details"
    3. We review the field just like we would any other field, and continue to the next document.
    FYI Pro Tip!

    Most users find tabbing through fields with the Tab key is the easiest way to review a document's fields in the Data Viewer.

    If you are on the last field of a document (such as this one) and press the Tab key, it will save the document and take you to the next one in the Batch.

    Data Element Overrides (and Required Validation)

    Another way Data Models can differ from Document Type to Document Type is through "Data Element Overrides" (sometimes just called "overrides" for short). This allows Grooper designers to change how fields, tables and sections behave for a specific Document Type while still maintaining a parent Data Model shared by multiple Document Types.

    We're going to use another common review feature to demonstrate this. There may be some data that is not only required to be present, but extremely important Grooper extracted accurately. Your Grooper designer may designate this as a field that requires validation. So, even if it's accurately extracted, the field will stay in an error state until the user clears it.

    For the "Ankara" Document Type, we've decided the "Remit To Address" requires manual validation. We've set up an override so that just this Document Type requires validation for this field. For the rest of them, we'll just take what Grooper gives us.

    1. Fields requiring validation will always be in an error state until the field is reviewed.
      • Grooper will give you an error message saying "This field must be reviewed"
    2. In our case, Grooper did extract this address accurately. What's on the document is what's in the extracted field.

    So, how do we proceed? We have to get rid of the error or Grooper will consider this an "invalid" document.


    To clear the error, you must "confirm" the field is valid.

    1. Right click in the field's text box.
    2. Select Confirm
      • Or, you can use the keyboard shortcut F6


    2. This will confirm the value is correct, and the textbox's color will change to green.
    FYI You may have noticed there are still data errors present on this document. The total number of errors dropped from "4" to "3".

    The remaining three errors pertain to the extracted table data. We will circle back to these issues in the next section when we discuss reviewing table extraction in Grooper.


    Rubberband OCR

    "Valid" Doesn't Mean Accurate

    Reviewing Data Tables

    Reviewing Data Sections

    Shortcuts
    Advanced Techniques: Validation and Calculation Expressions
    Advanced Techniques: Database Lookups
    Advanced Techniques: Rubberband Zone

    - Redaction use case and/or elevation use case example

    Thumbnail View

    Shortcuts

    Folder View

    NOTES TO SELF

    This is probably as good a time as any to talk about switching back and forth between views, if so enabled.

    Shortcuts

    Batch Management

    Pausing and Resuming Batch Processing

    Updating Batch Processes and Resetting Steps

    Viewing Batch Statistics

    Accessing the Batch Event Log

    Designer Guide

    Setting Up Review Views

    Best practice to include a Content Scope (even if it seems redundant)

    Data Model Styling for Data View

    Review Queues

    Review Queues allow further control of what Grooper Users have access to. Imagine a situation where you have several Grooper Batch Processes running in your Grooper environment. One or more of these processes may require elevated access for one reason or another. For example, you may have a Batch Process designed to process human resources files. These files would have personally identifiable information (PII) and should only be reviewed by users trained in PII compliance.

    If you want to restrict users ability to perform review tasks you will need to do the following:

    1. Add the users to the Users list at the root node of the Grooper Repository.
    2. Create a new Review Queue.
    3. Select which Grooper Users you wish to add to the Review Queue.
    4. On the Review step of a Batch Process select the Review Queue.
      • Then, only Grooper Users listed in the Review Queue will be able to perform that Review task in that Batch Process.

    DETAILED EXAMPLE COMING SOON

    Scanning With Web Client

    Retrieved from "https://wiki.grooper.com/index.php?title=2022:Web_Client&oldid=8288"