Configuring Jazz Team Server in the ClearQuest Synchronizer Setup wizard

Use the server configuration part of the ClearQuest® Synchronizer Setup wizard to configure Jazz™ Team Server and one or more project areas to enable synchronization.


  1. Enter the URL for a Jazz Team Server. For example: https:/host-name:9443/ccm.
    Note: If you need to make a change to any of the server URLs in the Known Jazz Servers list, click Delete Server to delete it, and then enter the correct URL.
  2. Enter the user ID and password of a Jazz user account with administrator privileges that the wizard can use to login to the Jazz Team Server. This user must also have project area permissions to save and delete synchronization rules. To assign these permissions:
    1. Open the project area in the web client (https://host-name:9443/ccm/admin). Click Project Areas > Active Project Areas. Click the project area.
    2. Click Permissions.
    3. Select Show by Operation.
    4. Select Item Connectors > Delete Synchronization Rule Info.
    5. Select a role assigned to the user.
    6. Grant permission for the Delete Synchronization Rule Info operation to that role.
    7. Select Item Connectors > Save Synchronization Rule Info.
    8. Grant permission for the Save Synchronization Rule Info operation to that role.
    9. Save your changes to the project area.
  3. Enter the user ID and password of a Jazz 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. This user account must have a Developer or ClearQuest Synchronizer client access license (CAL). In addition, this user must have project area permissions to perform synchronization operations. To assign these permissions, follow the substeps listed in the previous step but select the Synchronize with External Objects operation. If you do not have a user account for the ClearQuest Synchronizer, click Create New Account and complete the required fields.
    Note: In certain circumstances, the ClearQuest Synchronizer uses the default ADMIN Jazz user account when it synchronizes ClearQuest records with IBM® Engineering Workflow Management (EWM) work items, even if the ADMIN account has been deactivated. To ensure that the ClearQuest Synchronizer can complete synchronization operations successfully, add the ADMIN user as a member to your project area and assign it a role that has permission to perform Item Connectors operations.
    1. Open the project area in the web client.
    2. In the Members section of the Overview page, click Add.
    3. In the Add New Members wizard, enter ADMIN in the search field. Select ADMIN from the Matching users list and move it to the Selected users list. Click Next.
    4. Select a role that has Item Connectors > Synchronize with External Objects operation permission.
    5. Click Finish.
    6. Save your changes to the project area.

    Click Next.

  4. If this is your first time through the wizard, select one or more project areas to enable for synchronization. This page also lists previously-enabled project areas. Select a previously-enabled project area if you made a change, such as adding a field to a ClearQuest record type, and want to regenerate synchronization rules. Click Next.
  5. An external repository connection is a Jazz item whose properties contain information that the Jazz Team Server needs to create a connection to an external repository. You need to create an external repository connection for the ClearQuest Gateway. Enter a name for the external repository connection. If the Tomcat server that hosts the ClearQuest Gateway is configured to require user authentication for its service requests, enter values in the User ID and Password fields. Otherwise, leave those fields blank. The user ID and password that you enter must match those specified in the tomcat-users.xml file in the install-directory/gateway/tomcat/conf directory.

    To use Secure Sockets Layer (SSL) encryption, select Secure Connection. The default port numbers for external repository connections are 8444, for SSL connections, and 8081, for nonSSL connections. You can change the default port number.

    The wizard creates the external repository connection with outgoing synchronization disabled. After you finish modifying , reviewing, and testing your synchronization rules, you need to enable outgoing synchronization.

    Restriction: You cannot use the wizard to modify an existing external repository connection. To edit the properties of an external repository connection, open it in the Synchronization Rules view in the EWM Eclipse client.
    Click Next.
  6. For each project area that you want to enable for synchronization, click one of the following options:
    • Automatic: Have software automatically generate synchronization rules...
    • Template: Generate a template for synchronization rules for each selected and enabled record type
    • Not Needed: Skip synchronization rule generation

    Synchronization rules specify how EWM item properties map to ClearQuest record fields. The mappings are directional. Incoming synchronization defines how changes to a ClearQuest record are propagated to a EWM item. Outgoing synchronization defines how a change in a EWM item propagates to a ClearQuest record. A unique synchronization rule is required for each mapping of a ClearQuest record type to a EWM item type.

    To have the wizard create synchronization rules, select Automatic. 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. To specify additional mappings, you need to edit the generated synchronization rules files in the Synchronization Rule editor in the EWM Eclipse client.

    To have the wizard create templates of synchronization rules, select Template. When you select this option, the wizard creates entries in the synchronization rules for all ClearQuest record type fields but does not map the fields to item properties. To complete the mappings, you need to edit the generated synchronization rules files in the Synchronization Rule editor in the EWM Eclipse client.

    If you do not want the wizard to generate synchronization rules or templates at this time, or you want to create synchronization rules from scratch by using the Synchronization Rule editor, select Not Needed.

    You can have separate synchronization rules for each project area. However, only one synchronization rule for the user record type is allowed per ClearQuest Gateway. Each synchronization rule must have a unique name, even if they belong to different project areas.

    Click Next. You can configure another Jazz Team Server or click Next to continue to the next part of the wizard.

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