Grooper Service: Difference between revisions

From Grooper Wiki
Line 64: Line 64:
# You will be prompted "Are you sure you want to delete this Key?". Click Yes.
# You will be prompted "Are you sure you want to delete this Key?". Click Yes.
# Exit the Registry Editor.
# Exit the Registry Editor.
=== See Also ===
* '''[[Activity Processing]]'''
* '''[[Grooper Licensing]]'''
* '''[[Import Watcher]]'''

Revision as of 10:35, 8 July 2025

STUB

This article is a stub. It contains minimal information on the topic and should be expanded.

Grooper Services are various executable programs that run as a Windows Service to facilitate Grooper processing. Service instances are installed, configured, started and stopped using Grooper Command Console (or in older Grooper versions, Grooper Config).

About

Services are utilities that perform specialized operations within the Grooper environment. The two most common Grooper Services are "Activity Processing" and Import "Watcher".

  • Activity Processing is a service that executes processing jobs and tasks in a Batch Process. Running one or more Activity Processing services allows your system to automate Activity tasks when processing document content in a Batch.
  • Import Watcher is a service that watches an assigned external storage location, like a Windows folder or an email inbox, and will import its contents into Grooper at designated times or polling cycles. Running one or more Import Watcher services allows your system to automate Batch creation from file content.


Service instances are installed and managed from Grooper Command Console (GCC) using the services commands. More information on installing and managing services can be found in this section of the Grooper Command Console article.

Service types

There are currently 6 different Grooper Services you can install.

  • Activity Processing - Executes Activities which perform the work associated with steps in a Batch Process.
  • API Services - Exposes a set of API endpoints, enabling 3rd party applications to interact with the Grooper Repository.
  • Grooper Licensing - Dstributes Grooper licensing to workstations when using the "self-hosted" licensing method.
  • Import Watcher - Schedules and runs Import jobs to import file content into Grooper.
  • Indexing Service - Synchronizes data to AI Search indexes as documents are added, edited and deleted from the Grooper Repository.
  • System Maintenance Service - Runs the "System Maintenance" command on a recurring schedule.

Additional info

Service user rights

The Grooper Service user account must have the following permissions:

File store access

  • Type: NTFS\Share
  • Reason: Read and write access to the Grooper file store location

Database access

  • Type: SQL
  • Reason: Read and write access to the Grooper database

Logon As Service

  • Type: Local Security Policy
  • Reason: Run services installed via Grooper Command Console

Addressing "ghost services" - Deleting services from Windows

Very rarely, a Grooper service will not uninstall properly when you uninstall a Grooper service service. Or, a user may delete a Grooper Repository connection or purge a Grooper Repository without uninstalling services first.

This can make it appear as though a duplicate or "ghost" Windows service is installed without being listed in GCC (or Grooper Config before version 2024).


If this does occur, you will need to manually delete the service. If you know the name of the service instance (something like Grooper.ServiceTypeName.##) you need to delete, you can use the following command lines to stop the service (if necessary) and manually delete it.

SC STOP Grooper.ServiceTypeName.##
SC DELETE Grooper.ServiceTypeName.##

OR

You can delete the service from the Windows Registry Editor, using the following steps:

  1. Open the Registry Editor (regedit.exe)
  2. Navigate to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services.
  3. Select the key of the service you want to delete.
    • Grooper services will always be named something like Grooper.ServiceTypeName.##
  4. From the "Edit" menu select "Delete.
  5. You will be prompted "Are you sure you want to delete this Key?". Click Yes.
  6. Exit the Registry Editor.