URL Endpoints for Review

This article is about the current version of Grooper. Note that some content may still need to be updated.

2025

Three different URL endpoints can be used to open Review tasks in the Grooper Web Client, given certain information like the Grooper Repository ID, settings Batch Process name, inventory_2 Batch Id and more. This allows Grooper users to link directly to a Batch in Review with a URL.

About

An endpoint is a URL that links to a specific resource in a web-based application (Ex: https://servername/path/endpoint). Grooper has four endpoints designed to start or continue work in the Review step of a Batch Process.

• ReviewAll - Directs users to available Review tasks. Use this to start reviewing all available work for all Batches.
• ReviewBatch - Directs a user to Review tasks for a specific Batch. Use this to start reviewing a specific Batch.
• ReviewTask - Directs a user to a specific Review task. This option has no known use at this point. It may be useful for scripted solutions and/or improved on in future versions.
• Scan (version 2024 and above) - Creates a new Batch and directs a user to a Review step with a Scan Viewer to start scanning paper documents into it.

The ReviewAll endpoint

Use this endpoint to direct a user to available Review tasks in a Grooper Repository. Accessing this link will take the user to available Review tasks in the Tasks page.

Required Parameters: repositoryId (GUID)

You must pass the Grooper Repository ID in the URL.

The following URL would take a user to the first available task in a Grooper Repo whose ID is 00000000-0000-0000-0000-000000000000. After completing this task, the user would be directed to the next available task. And the task after that until all available tasks are completed.

• https://servername/Grooper/Review/ReviewAll?repositoryId=00000000-0000-0000-0000-000000000000

Optional Parameters: processName (string), stepName (string), queueName (string), caller (string)

You can optionally pass the following in the URL

• A Batch Process's name to filter Review tasks by a Batch Process
• A step's name in a Batch Process to filter Review tasks by step name.
• A Review Queue's name to filter Review tasks by members in a Review Queue.
• A "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.

The following URL would take a user to available tasks for steps named "Data Review" (&stepname=Data%20Review) for a Batch Process named "Invoices" (&processName=Invoices) and return the user to the Tasks Page when finished (&caller=Grooper/Tasks).

• https://servername/Grooper/Review/ReviewAll?repositoryId=00000000-0000-0000-0000-00000000000&processName=Invoices&stepName=Data%20Review&caller=Grooper/Tasks

The ReviewBatch endpoint

Use this endpoint to direct a user to Review tasks available for a specific Batch.

Required Parameters: repositoryId (GUID), batchID (GUID)

You must pass the Grooper Repository ID and The Batch ID in the URL.

The following URL would take the user to the first available task in a Batch whose ID is 00000000-0000-0000-0000-000000000000 in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.

• https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000

Optional Parameters: caller (string)

You may optionally pass a "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.

The following URL would take the user back to the Batches Page after all available Review tasks are completed for the Batch.

• https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000&caller=Grooper/Batches

The ReviewTask endpoint

https://servername/Grooper/Review/ReviewBatch?repositoryId={repositoryId}&taskId={taskId}

Use this endpoint to direct a user to a specific Review task.

• Please note this endpoint was created as a scaffold for custom scripts and potentially for future development. There is no way to know what a Review task's ID is before that task is created (when the Review step's Processing Job is created). This makes accessing this ID tricky using Grooper's current code base. Its practical use currently is limited as you must know the task ID to use it.

Required Parameters: repositoryId (GUID), taskID (int)

You must pass the Grooper Repository ID and Review task's ID in the URL.

The following URL would take the user to a Review task whose ID is "1" in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.

• https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1

Optional Parameters: caller (string)

You may optionally pass a "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.

The following URL would take the user back to the Tasks Page after the single task is completed.

• https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1&caller=Grooper/Tasks

The Scan endpoint

http://{serverName}/Grooper/Review/Scan?repositoryId={repositoryId}&processName={processName}&batchName={batchName}

This endpoint creates a new Batch using a Batch Process whose first step is a "scan step" (a Review step with a Scan Viewer). Use this endpoint to hit a link and start scanning documents into a new Grooper Batch.

Required Parameters: repositoryId (GUID), processName (string), batchName (string)

You must pass the following in the URL:

• repositoryId - The Grooper Repository's ID
• processName - The name of the published Batch Process used for scanning
• batchName - Whatever you would like to name the new Batch

The following URL would create a new Batch, name it "Scan_Session_001" and take them to the Review step to start scanning:

http://serverName/Grooper/Review/Scan?repositoryId={repositoryId}&processName={processName}&batchName={batchName}

How to Find Your Repository ID

The Repository ID for a Grooper Repository can be found on the root node. In the Design Page:

1. Select the Grooper Root node.
2. Under Repository Info, copy the value in the Repository ID property.

Glossary

Batch Process: settings Batch Process nodes are crucial components in Grooper's architecture. A Batch Process is the step-by-step processing instructions given to a inventory_2 Batch. Each step is comprised of a "Code Activity" or a Review activity. Code Activities are automated by Activity Processing services. Review activities are executed by human operators in the Grooper user interface.

• Batch Processes by themselves do nothing. Instead, they execute edit_document Batch Process Steps which are added as children nodes.
• A Batch Process is often referred to as simply a "process".

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

Grooper Repository: A Grooper Repository is the environment used to create, configure and execute objects in Grooper. It provides the framework to "do work" in Grooper. Fundamentally, a Grooper Repository is a connection to a database and file store location, which store the node configurations and their associated file content. The Grooper application interacts with the Grooper Repository to automate tasks and provide the Grooper user interface.

Repository: A "repository" is a general term in computer science referring to where files and/or data is stored and managed. In Grooper, the term "repository" may refer to:

• PRIMARILY a Grooper Repository. This is most commonly what people are referring to when they simply say "repository".
• Less commonly a CMIS Repository

Review Queue: person_play Review Queues help organize and filter human-performed Review activity tasks. User groups are assigned to each Review Queue, which is then set either on a settings Batch Process or a Review step. Based on a user's membership in Review Queues, this will affect how inventory_2 Batches are distributed in the Batches page and how Review tasks are distributed in the Tasks page.

Review: person_search Review is an Activity that allows user attended review of Grooper's results. This allows human operators to validate processed contract Batch Page and folder Batch Folder content using specialized user interfaces called "Viewers". Different kinds of Viewers assist users in reviewing Grooper's image processing, document classification, data extraction and operating document scanners.

Web Client: The Grooper user interface is accessed using a web browser from a URL. The Grooper Web Client is the application that installs the Grooper website on a web server.