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

Timer Service

Service Instance Grooper.Services

Serves as a base class for Grooper services that are exposed as self-hosted web services.

Remarks

The Web Service class provides a flexible foundation for building Grooper services that communicate over HTTP or HTTPS.

It is intended to be used as a base class in an Object Library, allowing developers to derive new service types that expose RESTful endpoints for integration with external systems, automation tools, or custom applications.

By inheriting from 'Grooper.Services.WebService', you can implement the required hosting logic and define the service contract for your web API.

How It Works

  • The service runs as a Windows service, self-hosting a WCF-based web server within the Grooper process.
  • Administrators can configure the Host Name, Port No, URL Path, and HTTPS Enabled properties to control how and where the service is accessible.
  • The service can be started and stopped using the Grooper UI or service control commands, and will listen for incoming HTTP or HTTPS requests at the configured endpoint.
  • The Connection URL property provides the fully-formed endpoint address for client applications and integrations.
  • Built-in support for SSL/TLS allows secure communication, with the Add Certificate property generating a ready-to-use netsh command for certificate binding.

Configuration and Usage

  • Derive a new class from Web Service in your Object Library and implement the required service contract and hosting logic.
  • Set the Host Name to the desired DNS name or IP address, or use 0.0.0.0 to listen on all interfaces.
  • Choose an available Port No (typically between 1024 and 49151) and ensure it is open in your firewall.
  • Specify the URL Path segment for the service endpoint (e.g., grooper/license).
  • Enable HTTPS for secure communication and use the Add Certificate command to bind an SSL certificate.
  • Use the Enable Debugging property to control whether detailed exception information is returned to clients (recommended only for development).

Best Practices

  • Always enable HTTPS in production environments to protect sensitive data.
  • Use descriptive and unique URL paths to avoid conflicts with other services.
  • Restrict the host name or IP address to limit exposure to trusted networks.
  • Disable debugging in production to avoid exposing internal details.
  • Document the Connection URL and share it with integration partners or client applications.

Impact

  • Enables secure, standards-based integration with Grooper services from external systems.
  • Misconfiguration of network or security settings may prevent clients from connecting or expose sensitive data.
  • Proper use of SSL/TLS and firewall rules is essential for production deployments.

Properties

NameTypeDescription
General
Scheduling
Service Settings
Notification