│ Grooper Help - Version 25.0
25.0.0023 2,165
  • Overview
  • Help Status

services

Manage Grooper services on the local machine.

Remarks

The services command group provides tools for installing, configuring, starting, stopping, and managing Grooper services on your system. These commands allow you to control Grooper Windows services and also host service instances directly inside the GCC process for testing or development.

With the services group, you can review which Grooper services are installed and running, install new service instances for repository processing or licensing, and remove services that are no longer needed. You can start or stop all services at once, or control individual services as required for maintenance or troubleshooting. For example, you can start all services after an upgrade, or stop them before performing system maintenance.

The group also supports advanced scenarios such as spinning up service instances in Docker containers, or hosting services in-process for development and scaling. You can view available service types, configure service properties, and ensure that each service is connected to the correct repository.

These commands are essential for administrators who need to deploy, monitor, and maintain Grooper services in production, test, or development environments. Use them to automate service management, quickly respond to operational needs, and streamline the setup of new environments.

For help on a specific command, use:
gcc help services <command>

Commands

Below are the commands in this group

host <connectionNo> <typeName> [settings]

Host a Grooper service in-process.

Hosts a Grooper service instance in the current GCC process, using the specified repository connection and service type.

Use this command for testing or development scenarios where running as a Windows service is not required.

Examples:

  1. Host an ActivityProcessing service with custom settings:
    gcc services host 1 ActivityProcessing "{"NumberOfThreads":2,"QueueName":"MyQueue"}"

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • The type name can be abbreviated: you may enter a partial type name as long as it uniquely matches one of the available service types (see 'services types'). For example, 'Activity' will match 'ActivityProcessing' if no other type starts with 'Activity'.
  • The settings parameter is a JSON string with property values for the service.
  • Press Ctrl+C to stop the hosted service.

connectionNo

The connection number, as shown by the 'connections list' command.

typeName

The type name of the service to host (e.g., 'ActivityProcessing').Type names can be abbreviated: You may enter a partial type name as long as it uniquely matches one of the available service types. For example, 'Activity' will match 'ActivityProcessing' if no other type starts with 'Activity'.

settings

JSON content, enclosed in quotes, representing properties to be set on the service (e.g., NumberOfThreads, QueueName).

host_copy <instanceNo>

Host a copy of a Grooper service installed on the local machine in-process.

Hosts a copy of an installed Grooper service instance in the current GCC process, using the instance number from the 'services list' command. Use this command to spin up additional workers for testing or scaling.

Examples:

  1. Host a copy of the second service in the list:
    gcc services host_copy 2

Notes:

  • The instance number is shown in the first column of the 'services list' output.
  • Press Ctrl+C to stop the hosted service.

instanceNo

The service number, as shown by the 'services list' command.

host_copy <connectionNo> <instanceNo>

Host a copy of an installed Grooper service in-process for a specific connection.

Hosts a copy of a Grooper service instance registered in the database for the specified repository connection and instance number. Use this command to run a service in-process for a particular repository.

Examples:

  1. Host the first service for the second connection:
    gcc services host_copy 2 1

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • The instance number is shown in the 'services list' output for that connection.
  • Press Ctrl+C to stop the hosted service.

connectionNo

The connection number, as shown by the 'connections list' command.

instanceNo

The service number, as shown by the 'services list' command for the specified connection.

install <connectionNo> <typeName> <userName> <password> [threadCount] [queueName]

Install a new instance of a Grooper service.

Installs a new Grooper Windows service for the specified repository connection and service type. Use this command to add new service instances for processing, licensing, or other Grooper functions.

Examples:

  1. Install an ActivityProcessing service with 4 threads:
    gcc services install 1 ActivityProcessing MyUser MyPassword 4 MyQueue

  2. Install a LicenseService as a specific user:
    gcc services install 1 LicenseService MyUser MyPassword

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • The type name can be abbreviated: you may enter a partial type name as long as it uniquely matches one of the available service types (see 'services types'). For example, 'Activity' will match 'ActivityProcessing' if no other type starts with 'Activity'.
  • If the password is '?', you will be prompted to enter it securely.
  • Use 'services list' to verify the new service is installed.

connectionNo

The connection number, as shown by the 'connections list' command.

typeName

The type name of the service to install (e.g., 'ActivityProcessing', 'LicenseService').Type names can be abbreviated: You may enter a partial type name as long as it uniquely matches one of the available service types. For example, 'Activity' will match 'ActivityProcessing' if no other type starts with 'Activity'.

userName

The user name to run the service under. Use a domain or local account as appropriate.

password

The password for the provided user name. If set to '?', you will be prompted to enter the password securely.

threadCount

The thread count, if the typeName is ActivityProcessing. Default is 1.

queueName

The work queue to pull work from, if the typeName is ActivityProcessing.

list

List all Grooper services installed on this machine.

Displays a table of all Grooper Windows services currently installed on the local machine, including their status and associated repository connection.

Use this command to review which Grooper services are present, check their running status, and identify which repository each service is connected to.

Examples:

  1. List all installed Grooper services:
    gcc services list

Notes:

  • The output includes the service number, name, status, repository name, and connection number.
  • Use the service number as input for other commands such as 'start', 'stop', 'uninstall', or 'host_copy'.

list <connectionNo>

List all Grooper services for a specific repository connection.

Displays a table of all Grooper service instances registered in the database for the specified repository connection. Use this command to see which services are configured for a particular repository, their type, status, and thread count.

Examples:

  1. List all services for the first connection:
    gcc services list 1

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • The output includes the service number, name, type, status, and thread count.

connectionNo

The connection number, as shown by the 'connections list' command. Enter the number of the repository connection whose services you want to list.

spinup <connectionNo> <typeName> [threadCount] [queueName]

Spin up a Grooper service instance in a Docker container.

Creates and starts a Grooper service instance in-process, running under the NETWORK SERVICE account. Use this command for containerized or test environments where a Windows service is not required.

Examples:

  1. Spin up an ActivityProcessing service with 2 threads:
    gcc services spinup 1 ActivityProcessing 2 MyQueue

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • The type name can be abbreviated: you may enter a partial type name as long as it uniquely matches one of the available service types (see 'services types'). For example, 'Activity' will match 'ActivityProcessing' if no other type starts with 'Activity'.

connectionNo

The connection number, as shown by the 'connections list' command.

typeName

The type name of the service to spin up (e.g., 'ActivityProcessing').Type names can be abbreviated: You may enter a partial type name as long as it uniquely matches one of the available service types. For example, 'Activity' will match 'ActivityProcessing' if no other type starts with 'Activity'.

threadCount

The thread count, if the typeName is ActivityProcessing. Default is 1.

queueName

The work queue to pull work from, if the typeName is ActivityProcessing.

start

Start all Grooper services on this machine.

Starts all installed Grooper Windows services on the local machine. Use this command to bring all services online after installation or maintenance.

Examples:

  1. Start all Grooper services:
    gcc services start

Notes:

  • The command will attempt to start all services in the correct order.
  • Use 'services list' to verify the status of each service.

start <instanceNo>

Start a specific Grooper service by instance number.

Starts a single Grooper Windows service, identified by its instance number as shown in the 'services list' command.

Examples:

  1. Start the first service in the list:
    gcc services start 1

Notes:

  • The instance number is shown in the first column of the 'services list' output.
  • Use 'services list' to verify the service status after starting.

instanceNo

The service number, as shown by the 'services list' command. Enter the number of the service you want to start.

stop

Stop all Grooper services on this machine.

Stops all installed Grooper Windows services on the local machine. Use this command to bring all services offline for maintenance or troubleshooting.

Examples:

  1. Stop all Grooper services:
    gcc services stop

Notes:

  • The command will attempt to stop all services in the correct order.
  • Use 'services list' to verify the status of each service.

stop <instanceNo>

Stop a specific Grooper service by instance number.

Stops a single Grooper Windows service, identified by its instance number as shown in the 'services list' command.

Examples:

  1. Stop the second service in the list:
    gcc services stop 2

Notes:

  • The instance number is shown in the first column of the 'services list' output.
  • Use 'services list' to verify the service status after stopping.

instanceNo

The service number, as shown by the 'services list' command. Enter the number of the service you want to stop.

types [connectionNo]

Display a list of available Grooper service types.

Shows all service types that can be installed or hosted for the specified repository connection. Use this command to discover the available service types and their descriptions.

Examples:

  1. List all available service types for the connection number:
    gcc services types 1

  2. List all available service types for the first connection:
    gcc services types

Notes:

  • The output includes the type name, display name, and a brief description.
  • Use the type name as input for the 'install', 'spinup', or 'host' commands.

connectionNo

The connection number (optional). Include this parameter to show types contained in object libraries for a specific repository.

uninstall <instanceNo>

Uninstall a Grooper service instance.

Removes a Grooper Windows service instance from the local machine, and deletes the corresponding database row if present. Use this command to clean up unused or obsolete service instances.

Examples:

  1. Uninstall the third service in the list:
    gcc services uninstall 3

Notes:

  • The instance number is shown in the first column of the 'services list' output.
  • You will be prompted to confirm the removal before it is performed.
  • Use 'services list' to verify the service has been removed.

instanceNo

The instance number, as shown by the 'services list' command. Enter the number of the service you want to uninstall.
Notification