2022:Web Client

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 Guide

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 IIS2. Install Grooper Web Client3. Access Web Client

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 (or above) ASP.NET 4.5 (or above) 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.

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 DesignerStep 2: Add UsersStep 3: Logon to Web Client

Step 1: Add a Designer (or Designers)

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.

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: 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.

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

Please visit the User Guide article to learn more about using the Grooper Web Client for document review.

In this article, we give end-users guidance on how to navigate the Web Client user interface and use it to process Batches to review documents. We 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 Views - 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.

Designer Guide

Setting Up Review Views

In Grooper 2022, there is a single Activity for any human-attended review step in a Batch Process. This is the Review activity.

Whether your users are doing classification review, data review, image review or scanning, you're going to use the Review activity to do it all. Depending on what you want the user to do in that step, you will add one (or more) "Review Views". For example, if the step is intended to allow users to review Grooper's document classification, you'll add a Classification View. Then, the user will have access to the Classification Viewer when they process the Review task.

The following "Review Views" can be added to a Review step and executed in the Grooper Web Client:

• Classification View
• Data View
• Thumbnail View
• Folder View
• Scan View

General Information & Best PracticesAdding a Review ViewClassification ViewData ViewFolder ViewThumbnail Viewer

General Information & Best Practices

User-attended steps are added to a Batch Process by adding a Review step. We're going to look at the Batch Process we used to process invoice documents in the User Guide portion of the course. I have unconfigured the two Review steps in this process. Next, I will show you how they were configured from scratch. We will demonstrate the basics of adding a Review step first.

Select the Batch Process to which you want to add a Review Step. We have an unconfigured step added after the "Classify" step of this Batch Process, which we have selected. This will be our first Review step. In the Step Properties panel, select the Activity Type property. Select Review from the dropdown list.
After assigning the Activity Type, the very first thing you should do is change the name of your Review step. "Review" is a really general word. Do your reviewers a favor and name the step something more specific. It's best practice to rename the Review step according to the type of review work the user is going to be doing. You don't have to rename it, but you should. For example, we're using this Review step to review document classification. So we renamed it "Classification Review".
Next, we need to configure the Review activity, by adding the Review View (or Views) we want our users to operate. Right? WRONG First, it is also best practice to configure the Content Scope property for a Review step. The Content Scope property limits what Content Types a user has access to in the review module, such as when manually assigning a document folder a Document Type. Technically speaking, the Review step will work without this property configured. However, it is considered best practice to always assign a Content Scope regardless of the Review View you're configuring. Generally speaking, there's only one Content Model used throughout the Batch Process. In most cases, you will scope the Content Scope to that Content Model. In this Batch Process, we use the Content Model named "Invoices Model". So we've selected it for the 'Content Scope. Put another way, we don't want the users to have access to other models in the Project. "Invoices Model OLD" is an older, testing version of the production "Invoices Model" Content Model. "Purchase Orders" is a Content Model that pertains to processing purchase order documents, not invoices and is therefore outside of the scope of work for this Batch Process. Neither contain valid Document Types for the kind of work our Batch Process is doing. Configuring the Content Scope property is particularly relevant when configuring a Review step for reviewing document classification, as it will limit the Document Types the user can manually assign to document folders. However, even when configuring Review for other kinds of review work, it is still considered best practice to configure the Content Scope.

Adding a Review View

Depending on what type of review work you intend the user to do during the Review step, you will add and configure one or more Review Views, using the Views property.

To add a Review View: Select the Views property. Press the ellipsis button at the end.
This will bring up the Views collection editor. Press the Add button. Select a Review View from the list. In Grooper 2022, only the following Review Views are accessible through the Grooper Web Client: Classification View Data View Folder View Scan View Thumbnail View
The selected Review View will be added to the list. With the Review View selected, use the right panel to configure its properties, if needed. We will discuss each Review View in more detail next in this tutorial. Press the OK button when finished adding and configuring the Review View(s).
Once added, you'll see the Review View listed in the Views property. In the next tabs of this tutorial, we will talk about each of the Review Views and some common configuration considerations.

Classification View

Adding a Classification View allows users to use the Classification Viewer. This allows users to review document classification when processing a Review task. It's configuration is very basic. The only question you really need to ask yourself is "Are there any completion criteria that should be required of the user during review?" You can require any flags on document folders to be removed before completing the Review task. You can require all documents to have a Document Type assigned before completing the Review task.
To configure either or both of these completion criteria, select the Folder Criteria property. Press the ellipsis button at the end.
This will bring up a Folder Criteria list editor. Press the Add button to add a new set of completion criteria. The Level property allows you to choose at which folder level in the Batch heirarchy, the criteria should apply. Most typically, all your documents exist at the same folder level in your Batch (often at level 1). In most cases, you'll only need one folder criteria configuration added at a single folder level. The Resolve Flags property determines whether or not error flags will prevent the Review task from being completed. Turn this to True if you want to force users to clear any document flags before the task can be completed. The Require Content Type' property determines whether or not unclassified documents will prevent the Review task from being completed. Turn this to True if you want to force users to assign a Document Type to all document folders before the task can be completed.

Data View

Adding a Data View allows users to use the Data Viewer. This allows users to review data extracted during the Extract step of a Batch Process and manually enter field values for Data Elements in the document's Data Model. Your primary considerations when configuring the Data View will be two-fold. You should ask yourself the following questions: At what folder level in the Batch do the document folders exist? Do you want users to complete the Review task with invalid documents present in the Batch? If you do want the user to complete the Review task with invalid documents, do you want to throw an error flag on the document after the task is completed?
The Processing Level property determines the subfolder level at which documents should be reviewed. PLEASE NOTE: This is relative to the Scope configuration specified on the Review step. For example: If your Review step is scoped to the Batch level, and your documents exit at the first folder level below the root folder, you would set this property to Level1 (This is also the most common/default configuration). If your Review step is scoped to Folder and level 1, and your documents exist at the first folder level below the root folder, you would set this property to Level0 (This is effectively no different from the previous example. It would perform the same way, just with extra clicks on your part). If your Review step is scoped to the Batch level, and your documents exist at the second folder level below the root folder, you would set this property to Level2 (This is a common configuration when reviewing documents split from larger parent files). The Allow Invalid Documents property determines if the Review task can be completed when invalid documents with data validation errors still present in the Batch. The default here is False because most typically organizations want to ensure all data errors have been reviewed and corrected. However, there are situations where you have to complete the task with errors in order to move on to the next step. For example, if a reviewer can't verify a highly sensitive field, an invalid document might be moved into a new Batch for a higher level secondary review by an activity called Spawn Batch. In order to move to the next activity (Spawn Batch in this example) you'd need to turn this property to True. The Flag Invalid Documents property will throw an error flag on any document folder with invalid data. This is False by default, meaning if a document folder has one or more field with a validation error, the folder itself will not be flagged. If set to True it will be flagged. This can be useful in situations where you do need to complete the Review task with invalid documents. The flags will clearly indicate which documents are invalid after the task is completed.
FYI The Data Viewer behaves differently in the Grooper Web Client than in the thick client in one major way. The Auto-Load Next Invalid Document feature does not work in the Grooper Web Client. In the thick client, if this is set to True, when the user tabs out of the last field of a document, the next invalid document will be loaded in the review screen. Otherwise, the next available document in sequence is loaded. At the time of writing this article, the Data Viewer in the Grooper Web Client will always behave as if this property is False.

Folder View

Adding a Folder View allows users to use the Folder Viewer. This gives users a simple Batch viewer in the Review step.
Most commonly, designers will add a Folder View as a secondary Review View, as certain views obscure the traditional folder hierarchy of the Batch. For example, many users find it helpful to have a Folder View added with a Data View. The Folder View has the same set of configurable properties as the Classification View.

Thumbnail Viewer

Adding a Thumbnail View allows users to use the Thumbnail Viewer. This review module focuses on reviewing each individual page, allowing users to select a thumbnail from the review screen to bring up the page in the Document Viewer. Most typically, this interface is used to review the results of an IP Profile. There are two questions you should ask yourself when setting up a Thumbnail View: Are there any completion criteria you want to require? You can require the user to confirm each individual page in the Batch passes muster and/or any error flags on pages be removed prior to completing the review. Do you want to allow users to manually apply an IP Profile to pages during the Review step? And, if so, what IP Profiles do you want them to use?
There are two "completion criteria" properties available to the Thumbnail Viewer. The Resolve Page Flags property determines whether or not the Review step can be completed when pages are flagged in the Batch from a previous step. Turning this to True will require users to remove those flags manually before they can complete their task. The Require Confirmation' property determines whether or not the user must confirm each page before the Review step can be completed. Users can press the Enter key to confirm a page, placing a green checkmark on the page. Turning this to True requires the user to confirm all pages before they can complete their task. FYI: Confirming the page will also remove any flag on the page.
The Allowed IP Profiles property allows you to select one or more IP Profiles the user can apply to a page's image during Review. Use the dropdown list to select IP Profiles from your Project (or any referenced Projects) by checking the box next to the profile's name.

Data Model Styling for Data View

NOTES TO SELF

Include table of differences in what you can do in thick client and what you can't in thin client.

Review Queues

Review Queues allow further control of what Batches and tasks Grooper users have access to.

• Imagine a situation where you have several Batch Processes running in your environment and several users reviewing work in Grooper. You may want to assign certain users to certain Batch Processes based on their experience with the kinds of documents in the document set or quality of their work.
• Imagine another situation where you want restrict the kinds of review your workers do. Maybe one group only performs data review and another only performs classification review. And maybe any of them can do document scanning.

You can control the work presented to users in the Batches and Tasks Pages with Review Queues. This allows you to better filter work to your users by defining ACL settings for Batch Processes and/or steps in a Batch Process.

You can also think of this as a "soft security" measure. By filtering out work available to users, it acts as a kind of gatekeeper, controlling what comes across their desk.

• CAUTION! Please note this is not a "hard security" measure. There are conceivable ways in which a user assigned a certain Review Queue may still be able to access Batch content that is outside of their queue. For true "hard security", the best practice is to isolate that work in a separate Grooper Repository and restrict user access in the Security settings configured on the root node.

The general steps to create a Review Queue are as follows:

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. Then, the Review Queue can be implemented in one of two ways:
   1. On the Batch Process to restrict work accessed from the "Batches Page".
      • This will prevent users from seeing any Batch using that Batch Process in the "Batches Page" interface.
      • Only Grooper Users listed in the Review Queue will be able to access Batches with that Batch Process in the "Batches Page" interface.
   2. On a Review step of a Batch Process to restrict work accessed from the "Tasks Page".
      • This will prevent users from seeing the Review task in the "Tasks Page"
      • Only Grooper Users listed in the Review Queue will be able to start the Review task from the "Tasks Page".

DETAILED EXAMPLE COMING SOON