2024:Validate Branch (Command)

The Validate Branch command verifies all nodes in a selected branch of the Grooper node tree are configured without obvious errors.

About

Validate Branch helps ensure Grooper nodes are configured correctly. When executed, it checks the property configurations of each child at every level below the selected node. If any node has a "validation error", Grooper will inform the user.

What is a validation error?

Example validation error

A validation error is any Grooper generated warning indicating some required property configuration is invalid or missing.

For example, the Classify activity must have its Content Model Scope property configured. The activity wouldn't be able to do anything without this property configured. So, Grooper generates an error warning the user there is something wrong with the property configuration.

Using the Validate Branch command to catch errors

Validating nodes is a good way to catch misconfigured nodes in Grooper. The "Validate Branch" command can be applied to a Project or any node in a Project. It will validate the selected node as well as all the node's descendants (or in other words that "branch" of the tree).

1. Right-click the branch you want to validate. Here, we've selected a Project.
2. Select "Validate Branch".
3. If any validation errors are found, a window will pop up showing us the validation error.
   • If you double-click an item in the list, Grooper will take you directly to that node in the node tree.

Improperly configured nodes can cause various issues in Grooper, particularly when upgrading to a new version. The Grooper Development Team strongly recommends correcting all validation errors prior to upgrading.

Version 2024Version 2023

Validating an entire Grooper Repository

PLACEHOLDER

Validating an entire Grooper Repository in 2024

Validating an entire Grooper Repository can be done from Grooper Command Console using the connections validate command. This command will display nodes with configuration errors in GCC. It will also write the results to a validation log as a TXT file at C:\ProgramData\BIS\ValidationLogs.

To use GCC to validate a Grooper Repository:

1. Open GCC.
   • GCC can be accessed from the Windows Start menu.
   • The executable gcc.exe can be found in the Grooper install directory.
2. Use the following GCC command to validate the Grooper Repository:

   connections validate <connectionNo>

   • connectionNo is a required parameter. Enter the connection number for the Grooper Repository you want to validate.

After running the command, GCC will give you a list of validation errors for any improperly configured node in the Grooper Repository. It will log these errors in a TXT file found in the following folder location:

C:\ProgramData\BIS\ValidationLogs

FYI

Knowing which Grooper Repository connection number you need to enter is critical to using the connections validate command. If you do not know the connection number to enter, use the following command: connections list This will list all Grooper Repository connections and display some basic information about them. Please note, the first column lists the connection number.