│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Service Instance

Database Row Grooper

Represents a Grooper service instance installed on a server, providing configuration, management, and monitoring.

Remarks

Service Instance objects model the configuration and operational state of Grooper Windows services deployed across your environment. Each instance corresponds to a single Windows service installed on a specific machine, and is permanently bound to a particular Grooper repository.

Key Roles:

  • Service Management:
    Each Service Instance represents a Windows service responsible for background processing, automation, or integration tasks within Grooper.
  • Repository Binding:
    Service instances are always linked to a single repository. To change the repository, uninstall and reinstall the service with the new repository assignment.
  • Configuration:
    Administrators can configure properties such as the service name, display name, user account, thread priority, and machine assignment using the Grooper UI (see the "Machines - Services" tab).
  • Status Monitoring:
    Provides real-time status, error tracking, and operational controls (start, stop, wait for status) for each service instance.
  • Event Handling:
    Raises critical stop events when unrecoverable errors occur, enabling alerting and automated remediation.

Installation and Configuration

  1. Install the Service:
    Use the GCC services install command to register a new service instance on the target server.
  2. Configure Properties:
    After installation, navigate to the "Machines" folder in the Design Page and select the service under the "Machines - Services" tab. Configure properties such as Service Name, User Name, and Thread Priority as needed.
  3. Start/Stop and Monitor:
    Use the Grooper UI or provided methods to start, stop, or monitor the service instance. Status and error information is available for troubleshooting.

Best Practices

  • Assign a dedicated user account with the required permissions for each service instance.
  • Use descriptive names for services to clarify their function and assignment.
  • Regularly monitor service status and review error logs for proactive maintenance.
  • Always uninstall and reinstall the service to change repository assignments.
  • Use the GCC services host command to run a service in-process from the command line.

Security Considerations

Ensure the specified user account has the Logon as Service permission, access to the Grooper database, and access to any required file store locations. Avoid using built-in accounts unless required by your environment.

Properties

NameTypeDescription

Derived Types

There are 6 implementations of Service Instance.

Activity Processing Executes unattended Code Activities as part of a Batch Process, providing scalable, parallel task processing for Grooper repositories.
API Services Exposes a set of API services which enables 3rd party applications to interact with a Grooper Repository.
Grooper Licensing Serves runtime licenses to Grooper applications using a self-hosted web service.
Import Watcher Schedules and executes import jobs, which load content from external sources into Grooper.
Indexing Service Monitors Grooper for document changes and automatically synchronizes changes to AI Search indexes as documents are added, edited, or deleted.
System Maintenance Service Automates and schedules system maintenance tasks for the Grooper repository.
Notification