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

The Grooper Web Client DOES NOT support Internet Explorer.

The following browsers are supported:

  • Microsoft Edge
  • Google Chrome
  • Mozilla Firefox
  • Other modern browsers may work but have not been fully tested, such as:

  • Apple Safari
  • Opera Web Browser
  • Installation

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

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

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

    1. Install IIS

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

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


    Open the Server Manager application.

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


    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 (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
    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 Client


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

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

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

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

    Click here to return to the top

    Security

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

    Step 1: Add a Designer (or Designers)


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

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

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


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


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


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

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

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

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

    Step 2: Add Users

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

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

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


    To add a Grooper User:

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


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


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


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

    Step 3: Logon to Web Client

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


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

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

    Click me to return to the top

    User Guide

    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

    NOTES TO SELF

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

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

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

    DETAILED EXAMPLE COMING SOON

    Scanning With Web Client