Configuring the Rational ClearQuest user database for the ClearQuest Synchronizer

Before you can use the ClearQuest® Synchronizer, you must configure your Rational® ClearQuest user database so that it can communicate with a Jazz™ project area. This part of the wizard walks you through that process.

About this task

The wizard applies the JazzInterop package to a schema and then upgrades a user database to the new version of that schema. The schema and user database must exist before you can use the wizard. The JazzInterop package adds a global Perl script, ChangeHistoryScripts, and the following record types to the schema:
  • JazzConnectorChangeEvents
  • JazzConnectorQueryInfo
  • JazzConnectorProperties
  • JazzConnectorSyncHistory

You also need to create a ClearQuest user account, or designate an existing user account, for use by the ClearQuest Synchronizer. The ClearQuest Synchronizer uses that user account to create and modify records in the ClearQuest user database.


  1. Select the schema repository that contains the schema and user database that you want to enable for synchronization.
  2. Select the user database that you want to enable for synchronization.
  3. Enter the Login name and password of an account with administrative privileges that the wizard can use to login to the ClearQuest user database.
  4. Enter the Login name and password of an account that the ClearQuest Synchronizer uses to create and modify records in the ClearQuest user database. The user account must have SQL editor privileges. This account should be used only by the ClearQuest Synchronizer. If you have not previously created an account for the ClearQuest Synchronizer, click Create New Account. Complete the fields in the Create New CQ Connector User dialog and click OK.

    After you finish the steps in the wizard, identify the users who will work in the configured environment. Ensure that the Login field of their ClearQuest user records contains the same value as the User ID in their Jazz user records. If you want the ClearQuest Synchronizer, during incoming synchronization operations, to be able to create Jazz user records that correspond to ClearQuest user records, make sure that the ClearQuest user records contain values in their Name and E-mail fields. When creating a Jazz user record, the User ID, Name, and Email Address fields are mandatory. Use the ClearQuest User Administration tool to modify ClearQuest user records.

  5. Click Next.
  6. Select the record types to enable for synchronization. It is not practical to map every record type to a work item type. The two types should be similar in their purpose, required fields, and state transition model. Before you complete this step, review all record types defined in the schema for the user database that you want to connect to a Jazz project area, and identify which record types are good candidates for synchronization. Click Next.
  7. The ClearQuest Synchronizer uses queries to filter the ClearQuest records to synchronize with IBM® Engineering Workflow Management (EWM) work items, and to determine which project areas to connect with the ClearQuest user database. Select or create the root folder that will contain these queries. The root folder can be anywhere in the Public Queries folder hierarchy. Do not place the root folder in the Personal Queries hierarchy.

    For each project area that you enable for synchronization, the wizard creates a folder with the same name as the project area. The project area folders are directly under the root folder.

    For example, in the figure below, the root folder is named Jazz ClearQuest Synchronizer. The two project area folders are named Hawaii Project and Trinidad Project. The Defect_query1 query selects the records of the Defect record type to be synchronized with work items in the Hawaii Project project area.

    This picture shows the hierarchy of query folders under the Public Queries folder.

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