Configuring the Compass integration with VersionVault UCM

Before you begin

The Compass integration with VersionVault UCM uses HTTP-based protocols to permit the VersionVault WAN server and the Compass web server to reside on different machines in the network.

About this task

The VersionVault WAN server consults a configuration file to determine how to connect to Compass web servers to process integration requests. By default, this file resides in the VersionVault configuration directory: versionvault-home-dir/config/ccrc/cq-db-mapfile.conf. You can override the default location using the ccrcClearQuestDatabaseMapFile configuration parameter in server.conf. A sample Compass database map file that you can use as a template is installed here: versionvault-home-dir/config/ccrc/cq-db-mapfile.conf.sample.

Each entry in the map file must contain the following parameters:
  • UDB=user-database. The name of the user database can be found in the Eclipse Compass Schema Designer in the properties window of the Compass Database Admin perspective of the repository database. Then name can also be found in the "name" field in the master_dbs table in the repository database.
  • DBSet=connection-name. The name of the connection in the Compass maintenance tool.
  • OSLC-URI=URI. The OSLC URI for the Compass web server hosting the user database; this is the URI that the VersionVault WAN server uses to make OSLC requests. Default: http://CQWeb_server-name/cqweb/oslc.
  • CQ-TEAM-URI=URI. The Compass CM Server URI for the Compass web server hosting the user database; this is the URI that the VersionVault Explorer client will use to make Compass web service requests. Default: http://CQWeb_server-name/TeamWeb/services/Team.
Note: The two URIs should refer to the same logical Compass Web server machine, but will have different paths and possibly different domain names.
The following requirements apply to the connection of the VersionVault WAN server to the Compass web server OSLC:
  • The connection cannot go through an HTTP proxy unless it is a non-authenticating proxy.
  • If the connection is an HTTP/SSL connection and an SSL certificate exception occurs during the connection process, the VersionVault WAN server ignores the exception.

Procedure

  1. Create one entry in the Compass database map file for the Compass user database that is to be used in VersionVault UCM/Compass integration operations by users of that VersionVault WAN server: UDB=user-database,DBSet=connection-name,OSLC-URI=URI,CQ-TEAM-URI=URI
  2. Repeat Step 1 for all other user databases that are to be used in this manner.

Example

If your VersionVault Explorer users go through a firewall or proxy to access the Compass web server, the domain name will typically be that of the proxy, not the Compass web server itself. Here is a sample user database entry: UDB=RATLC,DBSet=RATLC.LEX1,OSLC-URI=http://server1/Compassweb/oslc,CQ-TEAM-URI=http://server1/TeamWeb/services/Team