You
can use this API to write code that runs within Rational® ClearQuest® (hook code), or that runs independently
of an instance of the Rational ClearQuest application.
You can also use the API to create an integration with a new or an
existing application (service, tool, or utility) and the Rational ClearQuest application.
- Type of Code
- Example
- Hook scripts for your Rational ClearQuest schema
- Modify records that users submit, and validate
the records before they are committed to the user database. (Rational ClearQuest Designer
provides an editor for you to insert hook scripts.)
- External applications that run outside of Rational ClearQuest
- View or modify the data Rational ClearQuest stores
in the user database and schema repository.
- Integrations with an application and Rational ClearQuest
- Integrate the functionality of a service, tool,
or utility with the capability to view or modify the data Rational ClearQuest stores
in the user database and schema repository. See Considerations
for Rational ClearQuest integrations in the Schema
Developer Help for more information.
Rational ClearQuest runs
your hooks in VBScript or Perl, but not both at the same time. Rational ClearQuest Designer
allows you to switch between scripting languages. For more information,
see the Schema Developer Help.
You can write external applications in any programming environment
that supports OLE automation (such as Visual Basic or Visual C++),
or that can execute Perl scripts.
The
Rational ClearQuest enumerated
constants are preloaded and available for use in field hooks and record
and global scripts. However, to use the constants in an external
application, you must add the constant definitions to your program
before you can use them in the program, or the values will not be
set.