2024:Grooper Command Console (Application)

Grooper Command Console (or GCC) is an administrative application used to add and remove connections to Grooper Repositories, upgrade existing Grooper Repositories to a newer version, and install and uninstall Grooper Services.

About

FYI	Grooper Command Console (GCC) replaced Grooper Config in version 2024. All setup and configuration previously done in Grooper Config is now done in Grooper Command Console.

Grooper Command Console (GCC) is a command line interface for performing system configuration and administrative tasks. GCC is used to:

• Set up new and connecting to existing Grooper Repositories.
• Install and uninstall Grooper Services, such as Activity Processing services.
  • Be aware: GCC's primary function is to install services. Managing and configuring them should be done from the Machines node in the Design page.
• Installing product licensing

GCC performs system admin operations using command prompts. The syntax for executing a GCC command is as follows:

gcc> group command parameters

• FYI: The GCC documentation lists required parameters in angle brackets <> and optional parameters in square brackets []

There are seven (7) GCC command groups:

• connections - Used to manage Grooper Repository connections
• databases - Used to manage Grooper databases
• services - Used to manage Grooper services
• license - Used to manage licensing for a local Grooper license server
• scripts - Used to manage Grooper scripts
• utils - Various utility commands
• help - Use help commands for more information about commands in a group.
  • help commands should always follow the syntax help groupName.
  • For example, help connections will give you information about the various commands in the connections group.

How To: Grooper Repository Connections

⚠	GCC must be run as an administrator to perform most of its functionality. It performs functions that require elevated access in Windows.

This portion of the article will instruct you how to use Grooper Command Console to do the following things:

• Connect to an existing Grooper Repository
• Create and connect to a new Grooper Repository

Connect to an existing Grooper Repository

If you are using GCC to connect to an existing Grooper Repository, you just need to enter a single GCC command.

1. Open GCC.
   • GCC can be accessed from the Windows Start menu.
   • The executable gcc.exe can be found in the Grooper install directly.
2. Use the following GCC command:
   • connections add <server> <database> [user] [password]
     • <server> is a required parameter. Enter the server name (or IP address) hosting the Grooper database.
     • <database> is a required parameter. Enter the name of the Grooper database. If the database name contains spaces, you must enclose the whole name in quotes (i.e. "database name")
     • [user] and [password] are optional parameters. Windows will pass through the currently logged on user's credentials if not entered.

For example, if I wanted to connect to a Grooper Repository whose database named "2024 Grooper DB" was hosted on a server named "GROOPERSQL01", I would enter the following GCC command.

• connections add GROOPERSQL01 "2024 Grooper DB"

FYI	If you want to verify which Grooper Repositories you are connected to, use the following command: connections list This command will list all current Grooper Repository connections.

Create and connect to a new Grooper Repository

Creating a new Grooper Repository is done with three GCC commands. (1) You will use a command to create a new Grooper database. (2) You will use a command to add the connection to the newly created Grooper Database. (3) You will initialize the new Grooper Repository.