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

utils

Miscellaneous utilities for Grooper administration and automation.

Remarks

The utils command group provides a collection of utility commands to support Grooper administration, automation, and troubleshooting. These commands enable you to automate repetitive tasks, synchronize Grooper binaries across machines, analyze custom object libraries, generate unique identifiers, and test external connections.

With the utils group, you can execute batch files of GCC commands for streamlined setup or maintenance, compare and update Grooper installations on remote machines, and display detailed information about the current Grooper environment. You can also analyze object libraries for missing documentation, generate new GUIDs for configuration or scripting, and register type information as needed.

For connectivity testing, the group includes a ping command to verify and monitor the status of Data Connections and CMIS Connections, supporting both one-time and repeated checks. This is useful for troubleshooting integration issues or monitoring external system availability.

These utilities are designed to make Grooper administration more efficient, support automation scenarios, and provide essential tools for both routine and advanced tasks. Use them to simplify environment management, ensure consistency across systems, and quickly respond to operational needs.

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

Commands

Below are the commands in this group

about

Display information about the installed Grooper version.

Shows details about the current Grooper installation, including version, install path, machine name, user name, and supported version upgrades.

Examples:

  1. Display Grooper version information:
    gcc utils about

Notes:

  • Use this command to verify the installed version or troubleshoot environment issues.
  • Supported version upgrades are listed for reference.

analyze <connectionNo>

Analyze custom objects within Object Libraries.

Scans custom classes and properties in Object Libraries for missing documentation comments. Use this command to identify undocumented code and improve maintainability.

Examples:

  1. Analyze object libraries for the first connection:
    gcc utils analyze 1

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • Results include a list of undocumented classes and properties.

connectionNo

The connection number, as shown by the 'connections list' command. Specify the repository connection to analyze.

exec <filename>

Execute a Grooper Command Console batch file.

Runs a text file containing a list of GCC commands, executing each command in sequence. This is useful for automating repetitive tasks or running a series of setup or maintenance commands.

Examples:

  1. Execute a batch file of commands:
    gcc utils exec C:\Scripts\setup.gcc

Notes:

  • Each line in the file should be a valid GCC command.
  • Lines starting with 'rem ' are treated as comments and ignored.
  • If any command fails, execution stops and an error is reported.

filename

The path to a text file containing GCC commands. Provide the full path to the batch file to execute.

newGuid

Generate a new GUID.

Creates and displays a new globally unique identifier (GUID). Use this command when you need a unique ID for configuration, scripting, or development purposes.

Examples:

  1. Generate a new GUID:
    gcc utils newGuid

ping <connectionNo> <name> [interval]

Test a CMIS Connection or a Data Connection.

Pings a CMIS Connection or Data Connection by name, optionally repeating at a specified interval. Use this command to verify connectivity and response time for external connections.

Examples:

  1. Ping a data connection named "MyDB" on the first connection:
    gcc utils ping 1 MyDB

  2. Ping a CMIS connection every 30 seconds:
    gcc utils ping 1 MyCmis 30s

Notes:

  • The connection number is shown in the first column of the 'connections list' command.
  • The name must match a CMIS Connection or Data Connection in the repository.
  • The interval can be specified in seconds (s), minutes (m), or hours (h), e.g., '15s', '5m', '1h 30m'.
  • Press Ctrl+C to stop a repeating ping.

connectionNo

The connection number, as shown by the 'connections list' command. Specify the repository connection to use.

name

The name of a CMIS Connection or Data Connection. Provide the exact name of the connection to ping.

interval

Optional repeat interval. If set, the ping will repeat at the specified interval (e.g., '15s', '5m', '1h 30m').

register <typeId> <info>

Registers type information.

typeId

The type id to register information for.

info

The information to register.

update <machineName> [applyChanges] [rebuild]

Update binaries on another machine to match the local machine.

Compares and optionally updates Grooper binaries on a remote machine to match those on the local machine. Use this command to synchronize installations or verify consistency across environments.

Examples:

  1. Compare binaries on a remote machine (no changes applied):
    gcc utils update MyServer

  2. Apply updates to a remote machine:
    gcc utils update MyServer true

  3. Force a rebuild of the file comparison:
    gcc utils update MyServer true true

Notes:

  • If 'applyChanges' is false or omitted, only a comparison is performed.
  • If 'rebuild' is true, a new file comparison is generated even if one exists.

machineName

The name of the machine to update. Specify the network name or address of the target machine.

applyChanges

If true, updates will be applied to the remote machine. If false or omitted, only a comparison is performed.

rebuild

If true, forces a new file comparison. If false or omitted, uses an existing comparison if available.
Notification