Lesson 3.2: Use the Rational® ClearQuest Synchronizer Setup Wizard

In this lesson, you will use the ClearQuest® Synchronizer Setup Wizard to configure your ClearQuest schema and user database and Jazz® project area so that you can synchronize ClearQuest records with IBM® Engineering Workflow Management (Engineering Workflow Management) work items.

About this task

To use the ClearQuest Synchronizer Setup Wizard:


  1. In a web browser, enter the URL to start the wizard. For example: http://example.com:8081/cqconnector/cqsetup.
  2. On the Introduction page of the wizard, click Configure CQ and Jazz.
  3. Select the schema repository and user database that you created previously. Enter admin in the Administrator Account Name field, as shown. This is the account that the wizard will use to log in to ClearQuest to apply the JazzInterop package to the schema.
    This figure is a screen capture that shows the part of the wizard where users specify the ClearQuest schema repository, user database, and user name and password of a ClearQuest administrative user account.

    Click Create New Account to create a ClearQuest user account that the ClearQuest Synchronizer will use to log in to the ClearQuest user database to create and modify records during synchronization operations. Fill in the fields of the Create New CQ Synchronizer User window, as shown. Use a password that is easy to remember. Click OK. Click Next.

    This figure shows the Create New CQ Synchronizer User window with the CQ Account Name, Password, Full Name, and Email Address fields filled in.
  4. Use this page of the wizard to select the record types to enable for synchronization. Select the Project and Defect record types and click Add to move them to the Selected Record Types column. You will use the Project record type to set the value of the Filed Against field in work items. By default, the attachment and users record types are selected, as shown. Click Next.  A message reminds you that the changes to the schema and user database cannot be undone and asks you if you want to continue. Click OK.
    This figure shows the Selected Record Types box containing the attachments, users, Project, and Defect record types.
  5. The ClearQuest Synchronizer uses queries to select the records to synchronize with work items. You need to select or create a root folder for the queries. Select Public Queries and click Create New Folder. Name the root folder CQ Synchronizer Filters, as shown. Click OK. Click Next.
    This figure shows the CQ Synchronizer Filters folder within the expanded Public Queries folder.
  6. Enter the URL for the Jazz Team Server. For example: https://example.com:9443/ccm. Enter the name and password of the Jazz administrator account that you created previously: jazzadmin, as shown. The wizard uses this account to log in to the Jazz Team Server.
    This figure shows the URL, Administrator Account Name, and Administrator Account Password fields filled in.

    You need to specify or create a user account that the ClearQuest Synchronizer can use to log in to the Jazz Team Server and make changes required to synchronize work items with ClearQuest records. Click Create New Account. To make it obvious that this user account is for use by the ClearQuest Synchronizer, name it cqsynchronizer, as shown. Click OK. Click Next.

    This figure shows the Create New Jazz Synchronizer User window with the Jazz Account Name, Password, Full Name, and Email Address fields filled in.
  7. Select the project area that you created previously, CQ Synchronizer Tutorial, as shown. If you have used the wizard to enable other project areas for synchronization, this page lists them. Click Next.
    This figure shows the CQ Synchronizer Tutorial project area selected.
  8. The Jazz Team Server uses an external repository connection to communicate with the ClearQuest Gateway. Enter a name for the external repository connection, such as CQ Synchronizer connection. Click Next.
  9. Select Automatic to have the wizard create synchronization rules, as shown. Synchronization rules specify how Engineering Workflow Management item properties map to ClearQuest record fields. A unique synchronization rule is required for each mapping of a ClearQuest record type to a Engineering Workflow Management item type. For each record type that you selected, the wizard attempts to find an appropriate item type in the project area. The wizard then uses a name-matching algorithm to attempt to map fields from the ClearQuest record type to properties in the item type. Click Next.
    This figure shows the Automatic option selected for creating synchronization rules.
  10. You can use the wizard to configure project areas on additional Jazz Team Server s, but this tutorial uses only one Jazz Team Server, so select No thanks. I have configured all the Jazz servers I need to. This page lists the synchronization rules that the wizard created, one for each of the four record types that you selected, as shown. Click Next.
    This figure shows the No thanks option selected and the names of the four synchronization rules that were created.
  11. This page shows the queries root folder and the project area subfolder, and reminds you that you might want to create queries to select the ClearQuest records to be synchronized, as shown. You do not need to create any queries. If you do not specify a query, all records of the record type are synchronized. Click Next.
    This figure shows the Create ClearQuest Record Filtering Queries page. It lists the name of the project area, CQ Synchronizer Tutorial, and the path of the folder created for storing queries that the ClearQuest Synchronizer uses: Public Queries/CQ Synchronizer Filters/CQ Synchronizer Tutorial.
  12. The last page of the wizard prompts you to reset the ClearQuest Gateway so that it initializes with the changes that you made. Click Reset Gateway Now. The Welcome to the Jazz ClearQuest Synchronizer page opens. The page indicates the status of the ClearQuest Gateway and lists the ClearQuest and Jazz configuration information.
    This figure shows the ClearQuest Gateway status page.