Configuring the ClearQuest Synchronizer to create OSLC links

You can configure the ClearQuest® Synchronizer so that it creates Open Services for Lifecycle Collaboration (OSLC) links in the work items and the Rational® ClearQuest records that it synchronizes. The link in the work item goes to the corresponding Rational ClearQuest record, and the link in the Rational ClearQuest record goes to the corresponding work item.

Before you begin

You must set up the ClearQuest Synchronizer and the ClearQuest Bridge. See Setting up the ClearQuest Synchronizer and Configuring and using the Rational ClearQuest Bridge. The ClearQuest Gateway and the Jazz Team Server must be version 5.0 or later.

About this task

You can use OSLC links to navigate between work items and the Rational ClearQuest records that are synchronized. The ClearQuest Synchronizer adds the OSLC links only to new work items and Rational ClearQuest records that it synchronizes. To add OSLC links to work items and Rational ClearQuest records that are already synchronized, use the syncToBridgeTool command-line utility. For details, see Migrating from the ClearQuest Synchronizer to the ClearQuest Bridge.

Procedure

  1. For each Rational ClearQuest record type for which you want to add OSLC links, find the record type database ID.
    1. In the IBM Engineering Workflow Management (EWM) web client, open a work item that has a ClearQuest Bridge link to a Rational ClearQuest record. The link should be to a Rational ClearQuest record that is of one of the Rational ClearQuest record types for which you want to add OSLC links.
    2. Right-click on the ClearQuest Bridge link and select Copy Link Location.
    3. In a text editor, paste the contents of the clipboard. An example link is: http://fully-qualified-host-name/cqweb/oslc/repo/mySchemaRepository/db/SAMPL/record/16777224-33555184 where the number in bold is the record type database ID.
  2. Navigate to the install-directory\gateway folder. Open the cqconnector.properties file.
  3. Add the following entries:
    • cq.recordTypeDbId.record type name=record type dbid. Specify this entry for each Rational ClearQuest record type database ID that you retrieve in Step 1. For example: cq.recordTypeDbId.Defect=16777224.
    • cq.createOslcLinkJazz=true. To stop adding links in work items, set this option to false.
    • cq.createOslcLinkClearQuest=true. To stop adding links in Rational ClearQuest records, set this option to false.
    • cq.rootServices=ClearQuest OSLC root services URI. The ClearQuest OSLC root services URI is the concatenation of the public URI and the Rational ClearQuest discovery context information. Specify the URL in OSLC format; for example, http://fully_qualified_host_name/cqweb/oslc/repo/mySchemaRepository/discovery.
  4. Save the cqconnector.properties file.
  5. For each Rational ClearQuest record type for which you want to add OSLC links, verify that the corresponding synchronization rule lists the Rational ClearQuest id field as External identifier.
    1. In the EWM client for Eclipse IDE Team Artifacts view, right-click the repository connection and select Administer > Synchronization Rules.
    2. In the Synchronization Rules view, expand the project area. Double-click a synchronization rule to open it in the editor.
    3. In the Property Mappings section, click the row that contains id in the External Property column.
    4. In the Mapping details section, make sure that External identifier is selected.

Results

After you save the modified cqconnector.properties file and restart the ClearQuest Gateway, the ClearQuest Synchronizer adds links to new work items and ClearQuest records that it synchronizes.

What to do next

After you update the cqconnector.properties file, you must restart the ClearQuest Gateway. See Stopping and restarting the ClearQuest Gateway.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki