Installation and setup requirements

The product installation includes the common CM API component and the HCL Compass CM API subprovider.

Specifically, the following JAR files are installed:
  • HCL CM API component infrastructure JAR files
  • HCL CM API subprovider JAR file for Compass

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

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


    • Common implementation JAR file:


    • Extension for the Compass product:


      The following files are also required:
      • %CCM_INSTALL%\versionvault\web\cmapi\remote_core.jar
      • %CCM_INSTALL%\versionvault\web\cmapi\commons-logging-1.0.4.jar
      • %CCM_INSTALL%\versionvault\web\cmapi\commons-httpclient-3.0.jar
      • %CCM_INSTALL%\versionvault\web\cmapi\commons-codec-1.3.jar
    • Extension for the Compass product:


      The following file is also required: %CCM_INSTALL%\Compass\cqjni.jar

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

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

Accessing the HCL Compass 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.hcl.ccm.stp.cmapi directory in the archive file %HCL_INSTALL%\common\cm\

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 HCL Compass CM API, for example, C:\eclipse\plug-ins\com.hcl.ccm.stp.cmapi. The new plug-in comprises the CM API JAR files and the Compass 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 HCL Compass 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.hcl.ccm.stp.cmapi as a dependency to use the HCL Compass CM API from your plug-in . See for information about creating a plug-in.

You can also import the HCL Compass CM API plug-in into Eclipse as a project.

You must have a licensed and installed version of a HCL 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 HCL Compass CM API from a Java client application

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