2022:Web Client: Difference between revisions
Dgreenwood (talk | contribs) |
Dgreenwood (talk | contribs) |
||
| Line 436: | Line 436: | ||
=== Setting Up Review Views === | === 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''''' | |||
<tabs style="margin:20px"> | |||
<tab name="General Information & Best Practices" style="margin:20px"> | |||
=== 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. | |||
{|cellpadding=10 cellspacing=5 | |||
|valign=top style="width:40%"| | |||
<br> | |||
# 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. | |||
| | |||
[[File:Web-review-designer-guide-01.png]] | |||
|- | |||
|valign=top| | |||
<br> | |||
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. | |||
#<li value=5> For example, we're using this '''Review''' step to review document classification. So we renamed it "Classification Review". | |||
|valign=top| | |||
[[File:Web-review-designer-guide-02.png]] | |||
|- | |||
|valign=top| | |||
<br> | |||
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'''. So, you should 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'''''. | |||
|valign=top| | |||
[[File:Web-review-designer-guide-03.png]] | |||
|} | |||
</tab> | |||
</tabs> | |||
Best practice to include a Content Scope (even if it seems redundant) | Best practice to include a Content Scope (even if it seems redundant) | ||
Revision as of 15:49, 12 April 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:
Other modern browsers may work but have not been fully tested, such as:
|
Installation Guide
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. |
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
With IIS installed, our next step is to install the Grooper Web Server.
|
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. |
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
3. Access Web Client
|
By default, the Web Client URL will be the following:
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. |
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)
|
|
|||
|
|
|||
|
|
|||
|
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.
|
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. |
|
|
|
|
|
|
|
|
|
|
|
Step 3: Logon to Web Client
Now, only listed Users will have access to do review work via the Grooper Web Client.
|
|
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 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.
|
|
|
|
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.
|
|
|
|
Best practice to include a Content Scope (even if it seems redundant)
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:
- 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.
Then, the Review Queue can be implemented in one of two ways:
- 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.
- 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

































