==== Updating Batch Processes and Resetting Steps ====
==== Viewing Batch Statistics ====
==== Accessing the Batch Event Log ====
=== Event Log ===
=== Event Log ===
Revision as of 11:25, 15 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:
Install the IIS components on your server.
Install the Grooper Web Client application.
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.
Select Manage.
Select Add Roles and Features.
On the following screen, select Next.
Next, you will be asked to select the Installation Type.
Select Role-based or feature-based installation.
Select Next to continue.
Next, you will be asked to select a server on which to install the IIS.
Select the server.
FYI: The local server is selected by default.
Select Next to continue.
In the following screen, scroll down to the bottom of the list to select Web Server.
In the following prompt, select Add Features.
Then, select Next.
No additional Features are necessary.
Select Next to continue.
On the Web Server Role (IIS) screen, select Next.
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
Select Next after all components are selected.
The last step is to confirm your IIS installation.
Verify the settings are correct and all required components are present.
Select Install.
Close the install wizard.
FYI: You may close the install wizard while IIS is installing. It will continue to install in the background.
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
After unzipping the installer package, run the setup application.
Select Next to start installation.
Accept the terms of the licensing agreement.
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.
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.
Select Next to continue.
Select Next to continue setup.
Select Install to initialize installation.
You will see the following screen upon successfully installing the Grooper Web Client.
Select Finish to finish installation.
You can verify the Grooper Web Client was installed by opening Microsoft's Internet Information Services (IIS) Manager.
Under your server, select Application Pools.
You will see Grooper listed in the Application Pools.
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:
Select the Grooper Application Pool.
Select Advanced Settings....
The Advanced Settings window will pop up.
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
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.
Most likely you don't want any old user to access the Grooper Web Client. If you want to limit the users able to access Grooper by a web browser, you'll want 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.
To restrict Grooper Web Client users, you must first add at least one Grooper Designer.
In Grooper Design Studio, navigate to the root node of the Grooper Repository.
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.
This will bring up the ACL Editor window.
You can either search for users by group or individual user.
Search for the user you want to add, and select it from the list.
Press the Add button to add the user as a Designer.
This will add the selected user to the Designers list.
Press OK to add the user.
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.
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.
To add a Grooper User:
Select the root node of the Grooper Repository.
Select the Users property and press the ellipsis button at the end.
This will bring up the ACL Editor window.
You can either search for users by group or individual user.
Search for the user you want to add, and select it from the list.
Press the Add button to add the user as a User.
This will add the selected user to the Users list.
Press OK to add the user.
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.
Press the Save button to save changes.
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.
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
#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)
#Event Log - How to access Grooper's log of processing events and other statistics
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:
Navigation Links
Repository Info
Recent Events
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.
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.
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.
First, the Grooper Repository you're currently working in is always displayed at the top of the homepage.
To switch Repositories, click the Repositories button.
A dropdown menu will appear listing available Grooper Repositories you're connected to.
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.
You'll see the Repository listed at the top of the homepage has changed to the selected Repository.
Performing Review Tasks
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:
A container of documents in various states of processing.
These are represented as Batch Folders and Batch Pages contained in the Batch Root Folder.
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.
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:
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.
Process
This column lists the Batch Process assigned to the Batch. These are the step-by-step processing instructions given to the Batch.
Step
This is the current step in the Batch Process being applied to the Batch.
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.
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.
Priority
This is the priority assigned to the Batch. Higher priority steps will consume system resources before lower ones, effectively processing first.
Created
This is simply the date and time the Batch was created.
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.
In the search box you can free search any text in the Batches, Process, Step or Activity columns.
Or, you can select the Filter icon, to filter out Batches by certain criteria.
This will bring up a window to filter out your selection based on Status, Process, Step or Activity.
Click the arrow next to the property heading you want to filter by.
Check the box next to the specific value you want to filter by.
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?
First, select a Batch from the list.
The "Progress" tab displays the current progress of the selected Batch.
Each rectangle represents a step in the Batch Process.
The step's name is listed under the rectangle.
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.
Blue indicates the step's tasks were completed successfully (or without error).
Grey indicates the step is ready for processing.
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.
For these four batches, all are currently at a Review step in their process.
However, only one is listed as "Ready'"
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.
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 View" in order to verify each document in the Batch is classified correctly.
We will discuss how to use this "Classification View" and the other "Review Views" later in the #Review Applications section of this article.
For now, we're going to simply exit the review module.
To exit without saving your work, press the "Stop" button to return to the Batches page.
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.
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.
The list of Batches is always sorted by Age with the oldest Batch listed first the the newest created Batch listed last.
You can select also the Filter icon, to filter out Batches by certain criteria.
This will bring up a window to filter out your selection based on Queue, Process, Step or Batch (the Batch's name).
Click the hamburger icon at the end of the to the property heading you want to filter by.
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
Click "Save" to execute the filter or "Cancel" to cancel.
To start reviewing Batches, you have two options.
You can select a single Batch from the list by double clicking it.
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.
To exit without saving your work, press the "Stop" button to return to the Tasks page.
Or, click the Grooper icon to return to the homepage.
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:
A container of documents in various states of processing.
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...
You'll see the document icon instead of the folder icon for each item.
The folders are named "Document (#)" instead of "Folder (#)".
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 Applications
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 different "Views", depending on the type of review work your doing. These 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 View
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 View
You will use this to verify how Grooper extracted data from a document during the Extract step.
Thumbnail View
You will use this 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 View
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.
Classification View
Classification View allows Grooper users to review document classification. Grooper classifies documents using logic defined on a 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).
In the Classification View you will visually verify the Document Type Grooper was assigned correctly. 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.
We will select this this Batch to review Grooper's document classification during the Classify step.
As you can see the step's name is "Classification Review"
The steps activity type is "Review"
And most importantly, its status is "Ready", indicating it's ready to be processed.
When you open the Classification View module, this is what you'll see. The Batch's documents are presented in the typical folder hierarchy viewer.
Your job will be to select document folders and ensure the correct Document Type was assigned.
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.
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).
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".
To start reviewing, select a document folder.
This will bring up the document in the Document Viewer panel.
The document's classification results will be displayed in the Document Types Viewer.
This document as assigned the "Fairdeal" Document Type.
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.
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, you're job is to look at the document and make sure Grooper got it right.
Is this an invoice from Fairdeal Services?
Yes. Grooper got it right. You can see the company's logo.
You can see the invoices remittance address is addressed to Fairdeal Services.
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.
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.
So what happens when things go wrong?
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.
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.
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
Right click the document you want to classify.
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.
Press the hamburger button at the end of the Content Type property.
Select the appropriate Document Type from the Content Model.
In our case, we've selected "Risiti"
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.
The document's name has changed to "Risiti"
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:
Right click the document.
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.
This document was classified as an "Ankara" Document Type.
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.
Double click the Document Type in the Document Types Panel.
The document will be assigned that Document Type.
So, our document changed from "Ankara" to "Biha".
You should continue checking all document folders to ensure they've been classified correctly. We have one more problem in our Batch to resolve.
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.
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?
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.
Select the document you want to classify and press the Tab key on your keyboard.
This will move you to the Document Types Search Box. Start typing the Document Type you want to select.
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.
Once all documents have been reviewed, you're ready to complete the task.
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.
Press the OK button to complete the task.
This will complete the Review step in the Batch Process
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.
Complete Task
Stop Task
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, your work is NOT saved.
Be aware if you stop your current task in the middle of reviewing a Batch, you will lose any work you've done up to that point.
The Delete Task button will delete the current task, typically meaning it will delete the current Batch you are reviewing.
There is no undo 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.
Document Viewer Tips
The Document Viewer is a common element among all Review Views. It's how you, the user, can see the document or page selected.
There are a few things to point out regarding this viewer. This includes quality of life advice, such as how to zoom in and out of a page's image.
Zooming In and Out
Resizing Panels
Document Content Views
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.
Page 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 View
NOTES TO SELF
Will need info on all Data Elements
-Data Fields
-Data Sections (adding sections included)
-Data Tables (adding rows included)
Rubberband OCR
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
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:
Add the users to the Users list at the root node of the Grooper Repository.
Create a new Review Queue.
Select which Grooper Users you wish to add to the Review Queue.
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.
