2022:Web Client

From Grooper Wiki
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

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.

  1. On the following screen, select Next.

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

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

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

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

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

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

No additional Features are necessary.

  1. Select Next to continue.

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

  1. 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
  2. Select Next after all components are selected.

The last step is to confirm your IIS installation.

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

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

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

  1. Select Next to start installation.

  1. Accept the terms of the licensing agreement.
  2. 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.

  1. 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.
  2. Select Next to continue.

  1. Select Next to continue setup.

  1. Select Install to initialize installation.

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

  1. 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 Review

At this point, users are ready and able to access Grooper's Web Review using a URL.

By default, Web Review 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 Web Review client. In the next section, we will detail the UI navigation.

Click here 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. As long as the machine you're using has domain access to the server running the Grooper Web Client, you're good to go!

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)
  • #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 Web Client interface.


When you open the Grooper Web Client in a browser for the first time, you'll see 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

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:

  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, generally speaking, any computer software is not as good as the human brain. Review tasks are well suited for situations ensuring the accuracy of Grooper's results in one way or another. You play a critical role in ensuring 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

Batches Page

NOTES TO SELF

From "Batches" and "Tasks"

- Saving the business about pausing/resuming Batches, updating Batch Processes, etc for the Batch Management section

Review Applications

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

NOTES TO SELF

Explanations for how to navigate each Review view with a specific use case example.

Shortcuts list included for each view

Classification View - Reviewing Grooper's Document Classification

Data View - Reviewing Grooper's Data Extraction

NOTES TO SELF

Will need info on all Data Elements -Data Fields -Data Sections (adding sections included) -Data Tables (adding rows included)

Need info on expressions and database lookups

Rubberband OCR

Rubberband Zone - Redaction use case and/or elevation use case example

Thumbnail View - Reviewing Grooper's Image Processing

Folder View - A Generic Batch Viewer

NOTES TO SELF

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

Batch Management

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

Scanning With Web Review