Description of ClearQuest Diagnostics utility processing
The Rational ClearQuest
Diagnostics utility has a command-line interface that consists of two subcommands: validatedb,
which checks the integrity of your schema repository and/or user database,
and describe, which displays information about each rule.
To run these subcommands, first navigate to the directory where the utility
is installed. The default installation directory is \Program Files\Rational\ClearQuest\diagnostic.
Edit the cqdiagnostics.pl file, which sets the classpath environment
variable and invokes the subcommands, to specify which subcommand to run and
which parameters to use. Then run cqdiagnostics.pl.
The utility checks the integrity of the schema repository or user database
by processing a set of rules that are defined in an XML rules file. The scope
of the command can be one of the following:
- All rules in the rules file
- One or more rule groups
- One or more specific rules
A rule group is a collection of rules designed to check a specific aspect
of database integrity. Rational ClearQuest provides
four rule groups:
- Basic — rules that ensure that the appropriate tables and columns are
present.
- Performance — rules that ensure that the keys and indexes required for
acceptable performance are present.
- User — rules that ensure that user and group information is accurate.
- Multisite — rules that ensure that MultiSite information is accurate.
Follow these guidelines when using the utility:
- Make sure that the database server against which you run the utility has
at least 1 GB of free disk space. The utility creates temporary data tables
in the database that it checks, and you need to ensure adequate space for
these tables.
- Do not run multiple Rational ClearQuest Diagnostics
utility sessions against the same schema repository or user database simultaneously
because this might produce incorrect results.
- Although you can run the utility against a production user database or
schema repository, it is preferable to use a backup copy of your schema repository
or user database. The utility can take a long time to complete its diagnosis.
If you run the utility against your production schema repository or user database,
users might notice slow performance. Additionally, modifications that users
make to the production user database while the utility is running against
it might skew the results.