Configuring the ClearQuest Bridge

Configure the ClearQuest Bridge by establishing cross-server communication and linking your ClearQuest user database to your IBM® Engineering Workflow Management (EWM) project area.

Before you begin

Before you configure and use the ClearQuest Bridge, make sure that the following prerequisites are met:

  • Install and configure a Jazz™ Team Server. See Installing the server.
  • Install the ClearQuest Web server component from IBM Rational® ClearQuest V7.1.2 or later on the computer where you plan to run your web server. You can install the server on the same computer as your Jazz Team Server, or on a remote computer. For more information, see the IBM Rational ClearQuest documentation.
  • Follow the instructions to configure the integration from ClearQuest, including applying the OSLCLinks package to your ClearQuest schema.
  • Ensure that you have an EWM Developer License (or a license that contains an EWM Developer License, for example, EWM Developer for IBM Enterprise Platforms) or a ClearQuest Synchronizer Client Access License. You can download a trial of these licenses to evaluate the ClearQuest Bridge.
  • Create a Jazz project area and create Jazz user accounts for team members. See Administering change and configuration management projects.


  1. In EWM, configure Rational ClearQuest as a friend of EWM. Establish this relationship by setting up cross-server communication:
    1. Point your web browser to https://[fully qualified hostname]:9443/ccm/admin.
      Remember: The [fully qualified hostname] is the host name along with the DNS domain reference of the computer where the Jazz Team Server is installed. For example, if the fully qualified host name is, then the link to the administration page uses the following format:
    2. In the Communication pane, click Friends (Outbound). The Friends page opens.
    3. Click Add. The Add Friend window opens.
    4. For the Name, type the name that you want to use to identify the Rational ClearQuest Web server.
    5. For the Root Services URI, type the concatenation of the public URI and the Rational ClearQuest discovery context information. The discovery context information depends on the version of ClearQuest that you are using. For example, in ClearQuest Versions 7.1.2.x and, use: http://[fully qualified hostname]/cqweb/oslc/repo/[database set]/discovery. See the IBM Rational ClearQuest documentation for details.
    6. For the OAuth Secret, enter a code of your choice to be associated with the new OAuth consumer key of the server.
    7. Retype the OAuth secret code phrase in the Re-type Secret field.
    8. Click Trusted to designate this server 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. If the connection to the root services URI is successful, a message appears to confirm that the friend server was added and that a provisional key was generated.
    10. Click Next.
    11. Click the Grant access for the provisional key link to log on to the ClearQuest Web server as an administrator and approve the provisional key.
    12. Click Finish.
  2. In EWM, configure a link between the Rational ClearQuest user database and the EWM project area.
    1. In the administrative web client (https://[fully qualified hostname]:9443/ccm/admin), click the Project Areas tab.
    2. In the Project Area Administration pane, click Active Project Areas.
    3. Click to open the project area that you want to configure.
    4. Scroll to the bottom of the page. In the Associations section, click Add. The Add Association page opens.
    5. In the Application list, select your Rational ClearQuest Web server and log on as an administrator to the server when prompted. The Authorization dialog box closes and the Add Association dialog box opens.
    6. In the Association list, select Provides - Related Change Requests to display the ClearQuest databases on your server. The Provides - Related Change Requests choice enables associations between work items and ClearQuest change requests.
    7. In the Artifact Containers section, select the appropriate ClearQuest database.
    8. Click OK to save the changes to the project area.
  3. If the public URI of the Jazz Team Server or EWM application changes as a result of a server rename operation, then you must follow the ClearQuest instructions on remapping URIs after a renaming a server.

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