Applying the JazzInterop package to Rational ClearQuest MultiSite replica schemas

The ClearQuest® Synchronizer Setup Wizard configures your IBM® Rational® ClearQuest environment by applying the JazzInterop package to a schema and then upgrading a user database to the new version of the schema. However, in a ClearQuest Multisite environment, you must manually apply the package to the replica schemas and upgrade the user database replicas. The wizard applies the package to only the replica that is connected to the ClearQuest Gateway.

About this task

The JazzInterop package adds a global Perl script, ChangeHistoryScripts, and the following record types to the schema:
  • JazzConnectorChangeEvents
  • JazzConnectorQueryInfo
  • JazzConnectorProperties
  • JazzConnectorSyncHistory

See the Rational ClearQuest MultiSite Help for details about the sequence of steps to follow when applying packages and upgrading user databases.

Always apply the latest version (the one with the highest number) of the JazzInterop package to the schema. If you previously applied an earlier version of the package to your schema, upgrade incrementally to the latest version. For example, if 1.06 were the latest version, to upgrade from 1.03 to 1.06, perform the following tasks:
  1. Apply JazzInterop 1.04 to your schema.
  2. Upgrade the user database.
  3. Apply JazzInterop 1.05 to your schema.
  4. Upgrade the user database.
  5. Apply JazzInterop 1.06 to your schema.
  6. Upgrade the user database.

Procedure

To apply the JazzInterop package to a schema and upgrade the user database:

  1. On a computer running Windows, copy the install-directory/gateway/cqPackage/JazzInterop folder and paste it into the cq-install-dir/packages folder.
  2. Navigate to the cq-install-dir folder. Use the packageutil command to register the JazzInterop package with ClearQuest. If you need to apply multiple versions of the package to your schema to get to the latest package version, run this command multiple times, specifying a different package version each time before proceeding to the next step. For example:
    packageutil registerpackage JazzInterop package-version "C:\Program Files\Rational\ClearQuest\packages\JazzInterop\package-version"
  3. Run the following command to enable the JazzInterop package to update record types that you might have added to your schema by applying other packages to it.
    packageutil enablepackageediting -dbset dbset_name clearquest_login clearquest_password -enable user
    The user that you specify with the clearquest_password parameter must have schema designer privileges. The admin user account has super user privileges, which include schema designer privileges. For example:
    packageutil enablepackageediting -dbset my_schema_repo admin "" -enable admin
  4. Open ClearQuest Designer by clicking Start > All Programs > IBM Rational ClearQuest > ClearQuest Designer. In the Schema Repository Explorer view, right-click a schema version and select Packages > Apply Package. Expand the JazzInterop folder and select the version of the package to apply. Click Next. Select the record types that you want to enable for synchronization. Click Finish. Check in the new version of the schema.
  5. Use the packageutil enablepackageediting command again with the disable option to return the record types to Read-Only. For example:
    packageutil enablepackageediting -dbset my_schema_repo admin "" -disable admin
  6. Click View > Database Admin. Right-click on the user database that you want to upgrade and click Upgrade Database. The Upgrade User Database window opens. Select the new schema version from the Versions list and click OK.

What to do next

If you decide later to apply the JazzInterop package to an additional stateful record type in the same schema start by running the packageutil enablepackageediting command again with the enable option. Open the ClearQuest Designer and check out the schema. In the Schema Repository Explorer view, expand the Record Types folder. Right-click a record type and select Setup Record Type for Packages. Select the JazzInterop package and click OK. Check in the new version of the schema. Run the packageutil enablepackageediting command with the disable option. Upgrade the user database with the new version of the schema.

You must use a different procedure to apply the JazzInterop package to an additional stateless record type. Open the ClearQuest Designer and check out the schema. In the Schema Repository Explorer view, expand the Record Types - Stateless folder. Expand the folder of the stateless record type. Double-click Actions. Click New Action. Enter Change_History in the Action Name field. Select BASE in the Type field. Close the Action dialog box to save the change. Click in the Notification cell for the Change_History action. Click again and select SCRIPTS > PERL. Double-click the cell to open the script editor. Paste the following line into the editor after the last comment line: JazzCQConnector($actionname, $actiontype);. Save your changes and close the editor. Close the Actions matrix. Check in the schema. Upgrade the user database with the new version of the schema.


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