Installation and setup requirements

The product installation includes the common CM API component and the Rational® ClearQuest® CM API subprovider.

Specifically, the following JAR files are installed:
  • DevOps CM API component infrastructure JAR files
  • DevOps CM API subprovider JAR file for ClearQuest®

By default, the DevOps CM API JAR file and the other required JAR files are installed in the following locations, where the variable RATIONAL_INSTALL represents the directory where the DevOps product files are installed.

  • On Windows™ systems:
    • DevOps CM API interface JAR file:

      %RATIONAL_INSTALL%\Common\stpwvcm.jar

    • Common implementation JAR file:

      %RATIONAL_INSTALL%\Common\stpcmn.jar

    • Extension for the ClearQuest® product:

      %RATIONAL_INSTALL%\clearcase\web\cmapi\stpcc.jar

      The following files are also required:
      • %RATIONAL_INSTALL%\clearcase\web\cmapi\remote_core.jar
      • %RATIONAL_INSTALL%\clearcase\web\cmapi\commons-logging-1.0.4.jar
      • %RATIONAL_INSTALL%\clearcase\web\cmapi\commons-httpclient-3.0.jar
      • %RATIONAL_INSTALL%\clearcase\web\cmapi\commons-codec-1.3.jar
    • Extension for the ClearQuest® product:

      %RATIONAL_INSTALL%\ClearQuest\stpcq.jar

      The following file is also required: %RATIONAL_INSTALL%\ClearQuest\cqjni.jar

  • On the UNIX™ system and Linux™:
    • $RATIONAL_INSTALL/common/stpwvcm.jar
    • $RATIONAL_INSTALL/common/stpcmmn.jar
    • $RATIONAL_INSTALL/clearcase/web/cmapi/stpcc.jar
    • $RATIONAL_INSTALL/clearcase/web/cmapi/remote_core.jar
    • $RATIONAL_INSTALL/clearcase/web/cmapi/commons-logging-1.0.4.jar
    • $RATIONAL_INSTALL/clearcase/web/cmapi/commons-httpclient-3.0.jar
    • $RATIONAL_INSTALL/clearcase/web/cmapi/commons-codec-1.3.jar
    • $RATIONAL_INSTALL/clearquest/cqweb/lib/stpcq.jar
    • $RATIONAL_INSTALL/clearquest/cqweb/lib/cqjni.jar

To use the DevOps CM API JAR files, you must add all their locations to your class path.

Accessing the Rational® ClearQuest® CM API from an Eclipse plug-in

You can create an Eclipse plug-in by using the files listed in the previous section and the files located in the \plugins\com.ibm.rational.stp.cmapi directory in the archive file %RATIONAL_INSTALL%\common\cm\teamapi.zip.

To add the CM API plug-in to your runtime configuration, copy the files into your Eclipse instance or create a new extension installation site. This creates a new directory for the Rational® ClearQuest® CM API, for example, C:\eclipse\plug-ins\com.ibm.rational.stp.cmapi. The new plug-in comprises the CM API JAR files and the ClearQuest® JAR files. After creating the plug-in directory, you must copy each installed JAR file from its installed location to this new plug-in directory. Each subprovider JAR file requires the Rational® ClearQuest® CM API JAR file. The plug-in is available to use the next time that you start Eclipse. Note that if you install a newer product version or a patch, you must verify that the JAR files in the plug-in match the installed JAR files and use the newer JAR files.

You must identify com.ibm.rational.stp.cmapi as a dependency to use the Rational® ClearQuest® CM API from your plug-in . See http://help.eclipse.org/help30/topic/org.eclipse.platform.doc.isv/guide/firstplugin.htm for information about creating a plug-in.

You can also import the Rational® ClearQuest® CM API plug-in into Eclipse as a project.

You must have a licensed and installed version of a DevOps product to use the CM API subprovider for that product. If you install the subprovider JAR files but do not have the corresponding product installed, calls to that Java™ package fail.

Accessing the Rational® ClearQuest® CM API from a Java™ client application

For a client application to make requests to the Rational® ClearQuest® subprovider, the Rational® ClearQuest® product must be installed on the same computer as the client program that is invoking Rational® ClearQuest® CM API.