Configuring the Rational ClearQuest Bridge as your defect provider

You can integrate with IBM® Rational® ClearQuest® web, using the Rational ClearQuest Bridge, so that you can use Rational ClearQuest for tracking defects.

Before you begin

Before you begin the integration, make sure that you have met the following requirements:

  • You have installed the Quality Management application and configured the Jazz™ Team Server.
  • You have installed the Rational ClearQuest Web Server component from Rational ClearQuest version 8.0 or later on the computer where you plan to set up your web server. You can install the ClearQuest Web Server on the same machine as the Quality Management application or on a remote machine. For more information, see the Rational ClearQuest product documentation.
  • You have followed the instructions at Configuring ClearQuest Web to configure the integration from Rational ClearQuest, including applying the OSLCLinks package to your ClearQuest schema.
  • If you previously integrated with earlier versions of Rational ClearQuest (7.1.1 or 7.1.2, for example), you must complete these steps before setting up the new integration:
    1. Install the Quality Management application version 3 or later.
    2. Upgrade to Rational ClearQuest version 8.0 or later.
    3. Remove the existing link to the Engineering Test Management database from the project area administration page.
    4. Remove the existing Engineering Test Management friend entry from the cross server communication settings.
  • You have a Engineering Test Management - Quality Professional Client Access License (CAL).
  • You are using public host names rather than aliases or proxies.
  • You have disabled pop-up blockers in your browser.
Note: To include Rational ClearQuest defects that are associated with test artifacts in defect reports, you must use Rational Insight® for reporting. .
Note: If you have been using the Rational ClearQuest Connector and want to configure Rational ClearQuest as your defect provider instead, you must first turn off synchronization with Rational ClearQuest. For details, see Permanently Decommissioning the RTC/CQ Synchronizer.


  1. Set up cross-server communication with Rational ClearQuest.
    1. Point your browser to https://[fully qualified hostname]:9443/qm/admin.
    2. In the Communication pane, click Friends (Outbound). The Friends page opens.
    3. Click Add. The Add Friend window opens.
    4. For Name, type the name that you want to use to identify the Rational ClearQuest web server.
    5. For Root Services URI, type the concatenation of the public URI and the Rational ClearQuest discovery context information. For example, https://<cq-hostname>/cqweb/oslc/repo/<schema-repository>/discovery, where <cq-hostname> is the name of your ClearQuest web server and <schema-repository> is the name of your ClearQuest schema repository.
    6. For OAuth Secret, enter a code of your choice to be associated with the new OAuth consumer key of the server.
      Note: In this step you do not enter the key itself; you enter a shorter phrase that will be associated with the actual key.
    7. In the Re-type Secret field, retype the OAuth Secret code phrase.
    8. Select Trusted to designate this as a Trusted consumer. Trusted consumers can share authorization with other trusted consumers and do not require user approval to access data.
    9. Click Create Friend.
    10. Click Next. If the connection to the root services URI was successful, you will see a message confirming that the Friend was added and that a provisional key was generated.
    11. Click Next.
    12. Click the Grant access for the provisional key link to log in to the Rational ClearQuest web server as an Administrator and approve the provisional key.
    13. Click Finish.
  2. If you have not already done so, follow the instructions in Section II.B. - Configuring the ClearQuest Web server for cross-server communication of the following document to configure the integration from Rational ClearQuest: Configuring ClearQuest Web.
  3. In the Quality Management application, set up a link between the Rational ClearQuest user database and the Quality Management project area.
    1. Click the Administration icon (Administration), and then click Manage Project Areas.
    2. Click to open the project area that you want to configure.
    3. Scroll to the bottom of the page and in the Associations section, click Add. The Add Association page opens.
    4. In the Application list, select your Rational ClearQuest web server and log in to the server when prompted.
    5. In the Association list, select Uses - Defects to list the Rational ClearQuest databases on your server.
      Important: Do not select the Provides - Change Management option.
    6. In the Artifact Container section, click to select your Rational ClearQuest databases.
    7. Click OK and then save the changes to the project area.
    Note: You can also use Rational ClearQuest to manage task-quality work items, in addition to defects. To set up this association, complete step 3 again, but select Uses - Quality Management Tasks in the Association list.
  4. Initialize the connection.
    1. Connect to the project area by pointing your browser to https://[fully qualified hostname]:9443/qm/web.
    2. In the main menu, click Change Requests > Create Defect.
    3. Select Rational ClearQuest as your change management provider.

      A connection window opens.

    4. Type the user ID and password for the Rational ClearQuest repository and database.
    5. Click Log In.

      A defect submission form is displayed.

    6. Complete the form and click Save to submit the defect.

video icon Video channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community forums library

support icon Support

IBM Support Community
Deployment wiki