Modifying Connector service parameters

The cqconnector.properties file contains the parameter settings under which the ClearQuest® Gateway and the synctool command-line utility run.

About this task

The ClearQuest Synchronizer Setup Wizard updates the cqconnector.properties file based on the choices that you make in the wizard. If you intend to deploy the ClearQuest Synchronizer on the same computer where you run the wizard, you do not need to edit the cqconnector.properties file. If you intend to deploy the ClearQuest Synchronizer on a different computer, such as one that runs Linux, copy the cqconnector.properties file to that computer and then edit the file so that any computer path names specified in parameters are correct.

The following table describes the ClearQuest Synchronizer parameters.
Table 1. ClearQuest Synchronizer parameters
Parameter Description
com.ibm.rational.interop.pollingPeriod Polling period, which controls how frequently the ClearQuest Gateway polls for changes to the ClearQuest user database. The default polling period is 60 seconds.
com.ibm.team.uris Jazz™ server Uniform Resource Identifier (URI). The default URI is https://cqconnector:cqconnector@localhost:9443/ccm. Use a semicolon (;) to separate entries for multiple Jazz servers. You must either create a Jazz user named cqconnector or replace cqconnector with the name of another Jazz user. The Jazz user (cqconnector or other) must have a Jazz ClearQuest Synchronizer or Developer license. If you use cqconnector as the user ID, be sure to change the password from the default of cqconnector.
cq.createOslcLinkClearQuest Optional. Set this to true to have the ClearQuest Synchronizer add Open Services for Lifecycle Collaboration (OSLC) links to ClearQuest records that it synchronizes with work items. The links are Related Change Request links that go to the corresponding work items. See Configuring the ClearQuest Synchronizer to create OSLC links for details.
cq.createOslcLinkJazz Optional. Set this to true to have the ClearQuest Synchronizer add Open Services for Lifecycle Collaboration (OSLC) links to work items that it synchronizes with ClearQuest records. The links are Related Change Request links that go to the corresponding ClearQuest records. See Configuring the ClearQuest Synchronizer to create OSLC links for details.
cq.dbSetDbName ClearQuest schema repository and user database. The default schema repository is sample_schema_repo. The default user database is SAMPL. The format is schema-repository-connection-name/user-database-name.
cq.orderedProperties.record-type A comma-separated list of fields that indicates the order in which the ClearQuest Synchronizer should set the values of those fields during outgoing synchronization operations. You can set the parameter for each record type that has a synchronization rule. Fields that you do not specify in the list are processed after those in the list. You might need to specify the order if your ClearQuest record types contain hooks that establish dependencies between fields.

Another way to specify the order is to use the Web Dependent Fields property on fields in the form definition in the ClearQuest Designer. If you specify both the Web Dependent Fields property and the cq.orderedProperties parameter, the ClearQuest Synchronizer uses the order specified with the cq.orderedProperties parameter.

cq.password Password for logging into the ClearQuest user database. The ClearQuest Gateway and the batch synchronization tool use this password and the user name that you specify with the cq.userId parameter to log into the ClearQuest user database and retrieve records that you want to import into a Jazz repository. The default value is cqconnector. Be sure to change the password from the default value.
cq.recordTypeDbId.record type name=record type dbid The ClearQuest record type database ID. This is required only if you specify cq.createOslcLinkJazz. See Configuring the ClearQuest Synchronizer to create OSLC links for details.
cq.rootServices The ClearQuest OSLC root services URI. This is required only if you specify cq.createOslcLinkClearQuest or cq.createOslcLinkJazz. The value 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.
cq.userId User name for logging into the ClearQuest user database. The ClearQuest Gateway and the batch synchronization tool use this user name and the password that you specify with the cq.password parameter to log into the ClearQuest user database and retrieve records that you want to import into a Jazz repository. The default value is cqconnector. This user must have SQL editor permission.
cq.queryTreeRoot Full path name of the root folder that contains the project area-specific folder or folders of queries that you use to filter the records to be synchronized with IBM® Engineering Workflow Management (EWM) items. You can specify a query for each record type that you synchronize per project area. You must write the queries in such a way that they do not select a ClearQuest record to be synchronized with more than one project area on the same Jazz Team Server.

The root folder can be at any level of the folder hierarchy under Public Queries or Personal Queries, but its hierarchy must be as follows: root-folder/project-area-name-folder. Queries must be stored directly in the project area folders. You can have multiple project area folders. The name of each project area folder must match its corresponding project area name in the Jazz repository.

You must specify a value for this parameter. The root query folder that you specify must exist and it must contain a folder for each project area with which you plan to synchronize records and work items. If a project area folder does not contain a query for a record type that has a synchronization rule, the ClearQuest Synchronizer attempts to synchronize all records of that record type.

   

Procedure

To modify the parameters:

  1. Navigate to the install-directory\gateway folder. Open the cqconnector.properties file.
  2. Modify the parameter values as necessary to match your environment.
    1. Edit the com.ibm.team.uris parameter value to point to the location of the Jazz server or servers. By default, the ClearQuest Gateway attempts to log in to the Jazz server as the cqconnector user. You must either create a Jazz user named cqconnector or replace cqconnector with the name of another Jazz user. The Jazz user (cqconnector or other) must have a EWM ClearQuest Synchronizer or Developer license. To specify a different user, insert user_name[:password]@ before the host name. For example: https://chris:chris_pw@localhost:9443/ccm. Use a semicolon (;) to separate entries for multiple Jazz servers.
    2. Edit the cq.dbSetDbName parameter value to identify your schema repository and user database.
    3. Edit the com.ibm.rational.interop.pollingPeriod parameter value if you want to change the default polling period of 60 seconds.
    4. To filter the ClearQuest records to be synchronized, create queries for each record type that has a synchronization rule. Store the queries in project area-specific folders under the root folder. Edit the cq.queryTreeRoot parameter to identify the full path name of the root folder. For example: Public Queries/Jazz CQ Connector. Even if you do not want to filter records, you must create a root folder, and you must create a project area folder for each project area with which you plan to synchronize records and work items.
    5. Specify the user names and passwords for logging into ClearQuest with the cq.userId and cq.password parameters. The user that you specify with the cq.userId parameter must have SQL editor privileges.
    6. If any of the fields in the ClearQuest record types that you plan to synchronize have hooks that establish dependencies with other fields, and you do not use the Web Dependent Fields property in the ClearQuest form definition to specify the order in which the values of fields should be set, set the cq.orderedProperties.record-type parameter. A hook associated with one field might use the value that a user enters into that field to determine how to set the value of another field. In this scenario, you must identify the order in which the hooks should be executed during outgoing synchronization operations to ensure that the ClearQuest record fields are set to the correct values. For example: cq.orderedProperties.Defect=Headline,Type,Product,Component. This example specifies that the Headline field in the Defect record type should be set first, followed by the Type, Product, and Component fields.

      If you specify both the Web Dependent Fields property and the cq.orderedProperties parameter, the ClearQuest Synchronizer uses the order specified with the cq.orderedProperties parameter.

    7. Close and save the cqconnector.properties file.

What to do next

Note: Because the cqconnector.properties file contains login names and passwords for ClearQuest and Jazz user accounts, be sure to set the permissions on that file so that it is readable only by authorized users. Passwords stored in the cqconnector.properties file are obfuscated, not encrypted.

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