API Services

Specifies the DNS name or IP address on which the API service will listen for incoming requests.

Usage

• Set to the machine name, a specific network interface, or an externally accessible DNS name.
• Use localhost to restrict access to the local machine.
• Use 0.0.0.0 to listen on all available interfaces.

Example

grooper-server.example.com

Impact

• Determines which clients can reach the API service.
• Incorrect values may prevent clients from connecting.

Sets the TCP port on which the API service will listen for HTTP or HTTPS requests.

Usage

• Choose a port in the range 1024–49151 that is not in use by other services.
• Ensure firewall rules allow inbound traffic on this port.

Example

13905

Impact

• Clients must specify this port in the API URL.
• Changing the port requires clients to update their connection settings.

Enables or disables HTTPS (TLS/SSL) for secure communication with the API service.

Usage

• Set to true to require encrypted connections.
• Requires a valid SSL certificate to be installed on the server.

Impact

• When enabled, clients must use https:// in the API URL.
• Strongly recommended for production environments to protect sensitive data.

When enabled, detailed exception information is included in API responses when errors occur.

Usage

• Set to true for development or troubleshooting.
• Set to false in production to avoid exposing sensitive information.

Impact

• Detailed errors can help with debugging but may reveal internal implementation details.

Adds an interactive API documentation and testing resource at the root of the API service.

Usage

• Enable to allow users to explore and test API endpoints via a web browser.
• Useful for development, QA, and onboarding new integration partners.

Example

Navigate to the API service URL in a browser to access the test resource.

Impact

• Provides a convenient way to learn and validate API usage.
• Should be disabled in production for security reasons.

API keys are unique identifiers that are used for authentication by clients calling the web service.

The 'API Keys' property controls access to the API service by requiring clients to present a valid API key with each request. Each key is a GUID and should be treated as a secret credential. API keys are the primary mechanism for authenticating and authorizing external applications and integration partners.

Usage

• Add, remove, or edit API keys as needed for each integration partner, application, or user.
• Use the 'Description' field for each key to document its intended use, owner, or associated system.
• Distribute API keys securely to trusted parties only.
• Rotate API keys periodically and immediately revoke any that are lost or compromised.
• Audit API key usage regularly to ensure only authorized access is permitted.

Security Best Practices

• Never share API keys in public forums, code repositories, or unsecured channels.
• Use unique API keys for each external system or user to enable granular access control and auditing.
• Remove unused or obsolete API keys to reduce attack surface.
• Combine API key authentication with HTTPS to protect keys in transit.

Operational Considerations

• When an API key is deleted or disabled, any client using that key will immediately lose access.
• If an API key is compromised, revoke it and issue a new one to the affected party.
• Use the API key description to track ownership and facilitate incident response.

Returns the full base URL for the API service, including protocol, host name, and port.

Usage

• Use this value to construct API requests from client applications.
• The URL reflects the current settings for 'Host Name', 'Port No', and 'HTTPS Enabled'.

Example

https://grooper-server.example.com:13905

Impact

• Clients must use this URL as the base for all API calls.

Binds the Service Instance to a specific Grooper repository. This association is permanent for the lifetime of the service instance. To change the repository, uninstall and reinstall the service with the desired repository assignment.

Usage

• Select the target repository when installing or configuring the service.
• The repository must be accessible and properly configured for the service to function.

Impact

• All operations performed by this Service Instance will be executed against the selected repository.
• Changing the repository after installation is not supported; uninstall and reinstall to rebind.

Specifies the internal Windows service name used to identify the Service Instance on the target machine. This value is typically auto-generated but can be customized during installation.

Usage

• Use a descriptive name to clarify the service's function or assignment.
• The name must be unique among all Windows services on the machine.

Example

Grooper.ActivityProcessing.01

Impact

• Used by system tools and scripts to control or monitor the service.
• Changing this value after installation requires uninstalling and reinstalling the service.

Sets the friendly name shown in the Windows Services control panel and Grooper UI for this Service Instance. This name helps administrators and users identify the service's purpose.

Usage

• Use a clear, descriptive display name to distinguish this service from others.
• The display name can include the service type and instance number for clarity.

Example

Grooper Activity Processing, Instance 01

Impact

• Changing the display name updates how the service appears in management tools but does not affect its internal operation.

Can be one of the following values:

Controls the thread scheduling priority for all processing performed by this Service Instance.

Usage

• Select a priority appropriate for the server's workload.
• On workstations, use a lower priority to avoid impacting user interface responsiveness.

Options

• Values are from the ThreadPriority enumeration, such as Normal, BelowNormal, or AboveNormal.

Impact

• Higher priorities may improve processing speed but can affect other applications.
• Lower priorities reduce the risk of interfering with interactive users.

Specifies the Windows user account used to run the Service Instance. This account must have the necessary permissions for service operation.

Requirements

• Logon as Service permission on the target machine.
• Access to the Grooper database (if using Windows authentication).
• Access to any required file store locations.

Usage

• Enter the account name in the format DOMAIN\\Username or .\LocalUser.
• Avoid using built-in accounts unless required by your environment.

Impact

• The service will run with the permissions of the specified account.
• Insufficient permissions may prevent the service from starting or accessing required resources.

Sets the password for the specified user account. This value is stored securely and is required for non-built-in accounts.

Usage

• Enter the password for the account specified in 'User Name'.
• The password is encrypted and not displayed in the UI.

Security

• Ensure the password is kept up to date if the account's credentials change.
• Only users with administrative privileges should be allowed to view or modify this property.

Impact

• Incorrect passwords will prevent the service from starting.