Displays information about the rules and rule groups within
a rule file.
Synopsis
Attention: This command can only be run from
the
cqdiagnostics.pl script. This script contains
variables that correspond to all the parameters required by the command.
Edit the script to specify the
describe command
and the values for the rules or rule groups to be described and run
the script. The script is installed to Rational® ClearQuest® installation directory. The
default location is
cquest–home–dir\diagnostic\cqdiagnostics.pl.
For more information about using the script, see
Using the Rational ClearQuest Diagnostics
utility
- describe –rulefile rule_file [ –rulenames rule_names... | –rulegroups rule_groups... | –allrules ]
[ –locale locale_name ]
Description
The
describe subcommand
provides information about the rules and rule groups in a rule file,
which are used by the
validatedb subcommand. Depending on the
options specified, the subcommand supplies information about individual
rules, a list of rules within a specified group, or information about
all the rules in a rule file. A rule file contains all the rules and
rule groups that may be used to test against a database. Each rule
represents a constraint used to determine the integrity of a database.
A rule group is a collection of rules. The results contain the following
properties:
- Rule Name. The name of the rule.
- Description (if applicable). The constraints the rule uses to
validate a database.
- Type. A category for the rule that is based on the kind of constraints
it applies. Examples of Types are, Table Existence, Column Existence,
and Field Value Verification.
The description is written only to the console and is not written
to a log file.
Options and arguments
- -rulefile
- Specifies the rule file that contains the rules to describe. This
option writes a list of all rules in the rule file and a brief description
of each. The full path to the rule file must be specified.
- -rulenames
- Specifies the name of one or more rules within the rule file to
describe. This option writes a brief description of the rule to the
console. To specify multiple rules in one command, insert a single
empty space between each rule name.
- -rulegroups
- Specifies one or more rule groups within the rule file to describe.
This option writes a list of all the rules within the rule group.
To specify multiple rule groups in one command, insert a single empty
space between each rule group name.
- -allrules
- Describes all rules in the rule file. This option writes all the
rules in the rule file with a brief description.
- -locale
- Specifies which language to use in the output. The results file
and console offer alternative languages. The log file is only written
in English.
Examples
You must be in the
following location to run the
describe command:
cquest–home–dir\diagnostic\.
Attention: This command can only be run from the cqdiagnostics.pl script.
- Displays information for all the rules in the rule file, rules.xml
describe -rulefile cquest–home–dir\diagnostic\configuration\rules.xml
- Displays information for the rules, m_fielddef_type_rule and Master_links_link_type_rule in
the rule file, rules.xml.
describe -rulefile cquest–home–dir\diagnostic\configuration\rules.xml -rulenames m_fielddef_type_rule Master_links_link_type_rule
- Lists all the rules that belong to rule groups, table-existence and referential.
describe -rulefile cquest–home–dir\diagnostic\configuration\rules.xml -rulegroups table-existence referential