< Previous | Next >

Requirements for using the Rational ClearQuest API

To use the ClearQuest® API, you must have a licensed version of Rational® ClearQuest installed.
The Rational ClearQuest Perl API is implemented as a Perl package (CQPerlExt). 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. 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.

Learning objectives

After completing the lessons in this module you will understand the following concepts:
  • Programming with the Rational ClearQuest Perl API
  • Perl error handling
  • Rational ClearQuest Session and Entity objects

Time required

This module should take approximately 5 minutes to complete.

Prerequisites

A licensed version of Rational ClearQuest must be installed.
< Previous | Next >