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 (EWM) work items.
About this task
To use the ClearQuest Synchronizer Setup Wizard:
- In a web browser, enter the URL to start the wizard. For example: http://example.com:8081/cqconnector/cqsetup.
- On the Introduction page of the wizard, click Configure CQ and Jazz.
- Select the schema repository and user database that you
created previously. Enter admin in the Administrator
Account Name field, as shown below. This is the account
that the wizard will use to log in to ClearQuest to apply the JazzInterop package
to the schema.
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 below. Use a password that is easy to remember. Click OK. Click Next.
- 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 below. 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.
- 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 below. Click OK. Click Next.
- 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 below. The wizard uses this account to log in to the Jazz Team Server.
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 below. Click OK. Click Next.
- Select the project area that you created previously, CQ
Synchronizer Tutorial, as shown below. If you have used
the wizard to enable other project areas for synchronization, this
page lists them. Click Next.
- 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.
Select Automatic to have the wizard create synchronization rules, as
shown below. Synchronization rules specify how EWM item
properties map to ClearQuest record fields. A unique
synchronization rule is required for each mapping of a ClearQuest record type to a EWM 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.
- 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 below. Click Next.
- 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 below. 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.
- 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. As shown below, the page indicates the status of the ClearQuest Gateway and lists
the ClearQuest and Jazz configuration information.