Configuring the Rational ClearQuest adapter on WebSphere Application Server

You can make the IBM® Rational® ClearQuest® shared libraries available to the IBM Rational Publishing Engine Data Services application so that the Rational ClearQuest API is can be used from Rational Publishing Engine.

Before you begin

  • You must have Rational ClearQuest installed on the same computer as your application server.
  • Deploy the Rational Publishing Engine Reporting data services application and the Reporting Data Services Adapters.
  • Correct any firewall warnings or licensing issues before configuring the Rational ClearQuest shared libraries.

Procedure

  1. Add the paths to the shared libraries in your Rational ClearQuest installation to the WebSphere® Application Server node where the Rational Publishing Engine Data Services application is deployed:
    1. In WebSphere Application Server, click Environment > Shared Libraries.
    2. To specify the scope setting, select the Node=RationalPublishingEngineNode01, Server=RationalPublishingEngineServer entry. RationalPublishingEngineNode01 is the default name of the node and RationalPublishingEngineServer is the default name of the server.
    3. To create the shared library reference, click New.
    4. Set the values for Name, Description, and ClassPath. Ensure that your class path refers to the files in their correct locations.
      Table 1. Shared library reference fields
      Description Values
      Name ClearQuest CM API
      Description The shared library for the ClearQuest adapter.
      Class path

      application_files\IBM\RationalSDLC\ClearQuest\cqjni.jar
      application_files\IBM\RationalSDLC\ClearQuest\stpcq.jar
      application_files\IBM\RationalSDLC\Common\stpcmmn.jar
      application_files\IBM\RationalSDLC\Common\stpwvcm.jar

      Note: The default values listed are for Rational ClearQuest 7.1. The actual paths to use depend on where and which version of Rational ClearQuest is installed. Make sure that you are referring to the files in their correct locations. To view the location of your Rational ClearQuest installation, check in IBM Installation Manager by clicking Start > All Programs > IBM Installation Manager > View Installed Packages.
    5. Click OK and Save.
  2. Associate the Rational ClearQuest shared libraries with the Reporting data services application profile:
    1. Click Servers > Application Servers.
    2. Click the server on which you deployed the Data Services application. The default server name is RationalPublishingEngineServer.
    3. Click Server Infrastructure > Java and Process Management > Class Loader.
    4. To create a class loader for the shared libraries, click New > OK.
    5. To associate the shared library references with the class loader, click the hyperlink of the new class loader created in substep 2.d.
    6. For each library to be associated, click Add, select the library, and click OK.
    7. Click Shared library references.
    8. To associate each library, click Add, select the library, and click OK.
    9. Click Save.
  3. Linux icon If you are using Linux, configure the generic JVM argument:
    1. Click Servers > Server Types > WebSphere Application Serviers
    2. Click the server name.
    3. In the Server Infrastructure section, expand Java and Process Management and click Process Definition.
    4. Click Java Virtual Machine.
    5. In the Generic JVM arguments field, enter: Generic JVM arguments -Djava.library.path=/opt/ibm/RationalSDLC/clearquest/linux_x86/shlib
    6. Click OK.
  4. Linux icon If you are using Linux, configure the LD_LIBRARY_PATH environment variable:
    1. In the Process Definition page, click Environment Entries and click LD_LIBRARY_PATH.
    2. Enter a name and enter the library path. Example: /opt/ibm/RationalSDLC/clearquest/linux_x86/odbc/lib:/usr/local/ibm/gsk7/lib
  5. Restart the Reporting data services application.
  6. Verify that the IBM Rational ClearQuest adapter and libraries are configured correctly. Enter a URL for the Rational ClearQuest adapter in a browser.
    • Enter http://host:port/DataServices/ClearQuest. If the installation is correct, you see a list of Rational ClearQuest connections as displayed in the Rational ClearQuest Maintenance Tool.
    • Enter http://host:port/DataServices/ClearQuest/version. If the installation is correct, you see a list of a list of Rational ClearQuest user databases.
    • Enter http://host:port/DataServices/ClearQuest/version/database_name. If the installation is correct, you see a list of queries.

What to do next

Copy a query URL to add to a template or document specification.
Note: The Reporting data services application supports only queries with static result sets. Dynamic queries are not supported.

Example

With the URL for the All Defects query, you see a result set with the number of hits the query would return for the Rational ClearQuest client. Each result is a unique DBID for a particular record type. You can continue with this process until you get a return for the data of a specific record. Retain the query URL for use in Rational Publishing Engine report authoring.

Remove arguments including and after the question mark:

Before: http://localhost:9081/DataServices/ClearQuest/7.0.0/SAMPL/Public+Queries/All+Defects?Type=Query
After: http://localhost:9081/DataServices/ClearQuest/7.0.0/SAMPL/Public+Queries/All+Defects


Feedback