│ Grooper Help - Version 25.0
25.0.0029 2,194

scripts

Manage Grooper script execution and SDK-based script project integration from the command line.

Remarks

The scripts command group provides tools for executing Grooper scripts and integrating Visual Studio script projects into Grooper repositories.

This group includes commands for starting scripts, listing available script nodes, and performing SDK-level operations such as updating or compiling script projects.

  • General commands like start and list are designed for Grooper users to automate tasks and interact with script nodes.
  • SDK commands such as update and updateAndCompile are intended for use by the Grooper SDK Visual Studio Extension and internal development workflows.

Use these commands to streamline script execution, integrate external script projects, and support advanced automation scenarios.

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

Commands

Below are the commands in this group

disable <connectionNo> [scriptNo]

Disables one or all script-enabled nodes in the repository.
The disable command disables script execution for one or all script-enabled nodes.

  • If a script number is specified, only that script is disabled.
  • If no script number is specified, all scripts are disabled.

Examples: gcc scripts disable 9 (disable all scripts in connection 9) gcc scripts disable 9 3 (disable script #3 in connection 9)

connectionNo

The connection number identifying the target Grooper repository.

scriptNo

Optional script number from the list output. If omitted, all scripts will be disabled.

disableInvalid <connectionNo>

Disables script-enabled nodes that fail recompilation.
The disableInvalid command attempts to recompile all nodes currently in a compiled state.

  • If compilation succeeds, the node remains published and valid.
  • If compilation fails, the script is automatically unpublished (disabled) by Grooper.
  • This process can take significant time, especially if multiple scripts are invalid.

Purpose: Detect and disable stale or broken compiled scripts caused by upgrades, version changes, or other disruptions.

Example: gcc scripts disableInvalid

connectionNo

The connection number identifying the target Grooper repository.

getLatest <path> <repositoryId> <nodeId>

Update the local script project with files from the Grooper node.

For Grooper SDK extension use. This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It downloads the latest script files from a Grooper script node and updates the local Visual Studio project directory.

Examples:

  1. Download the latest script files to a local project directory:
    gcc scripts getLatest "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.
  • Local files will be overwritten with the latest version from Grooper.

path

The Visual Studio destination project directory. Provide the full path to the local project directory to update.

repositoryId

The Grooper repository id as a GUID. Specify the repository containing the script node.

nodeId

The id of the node to save the script on, as a GUID. Specify the script node to download from.

list <connectionNo>

Lists all script-enabled nodes in the repository.
The list command displays all nodes in the repository that contain script projects.

  • Script-enabled nodes are identified by the presence of a .vbproj or .csproj file.
  • This command is useful for auditing script usage and identifying nodes available for compilation or update.

Example: gcc scripts list

connectionNo

The connection number identifying the target Grooper repository.

mismatch <path> <repositoryId> <nodeId>

Compare local script files to the files stored on the Grooper node.

This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It checks whether the local script files are out of sync with the files stored in the Grooper script node.

Examples:

  1. Check for mismatches between local and Grooper script files:
    gcc scripts mismatch "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.
  • If a mismatch is detected, an exception will be thrown.

path

The Visual Studio destination project directory. Provide the full path to the local project directory to check.

repositoryId

The Grooper repository id as a GUID. Specify the repository containing the script node.

nodeId

The id of the node to save the script on, as a GUID. Specify the script node to compare against.

update <path> <repositoryId> <nodeId>

Save a script project to Grooper from a file system directory.

For Grooper SDK extension use. This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It saves the contents of a Visual Studio script project directory to a script node in a Grooper repository.

Examples:

  1. Update a script node from a local project directory:
    gcc scripts update "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.

path

The Visual Studio project directory to be saved. Provide the full path to the local project directory containing the script files.

repositoryId

The Grooper repository id as a GUID. Specify the target repository where the script node resides.

nodeId

The id of the node to save the script on, as a GUID. Specify the target script node in the repository.

updateAndCompile <path> <repositoryId> <nodeId>

Save and compile a script project to Grooper from a file system directory.

For Grooper SDK extension use. This command is used internally by the Grooper SDK Visual Studio Extension and is not intended for direct use from the command line. It saves the contents of a Visual Studio script project directory to a script node in a Grooper repository and compiles the script.

Examples:

  1. Update and compile a script node from a local project directory:
    gcc scripts updateAndCompile "C:\Projects\MyScript" 12345678-90ab-cdef-1234-567890abcdef 00112233-4455-6677-8899-aabbccddeeff

Notes:

  • This command is typically invoked by the Grooper SDK extension, not by administrators.
  • The repository and node IDs must be valid GUIDs.
  • Compilation output will be displayed in the console.

path

The Visual Studio project directory to be saved. Provide the full path to the local project directory containing the script files.

repositoryId

The Grooper repository id as a GUID. Specify the target repository where the script node resides.

nodeId

The id of the node to save the script on, as a GUID. Specify the target script node in the repository.
Notification