Creating and maintaining credentials for HCL Compass database sets

The UCM integration with HCL Compass supports multiple database sets (connections). Each connection for each user database on a system requires credentials: the user name and password for access to the HCL Compass user database. If a user of the integration performs an action that requires the login to a different database, the integration accesses stored credentials and attempts to perform the login. You or the developer can register the credentials.

The usage of credentials differs between the HCL VersionVault command line interface (CLI) and the graphic user interface (GUI). For a CLI user, if the credentials are not registered, the user sees a message requesting that the credentials be created. For a GUI user, a login window is displayed for the credentials to be supplied. The GUI stores the credentials for that user database after a successful login. After credentials are registered, the user does not have to enter credentials to subsequently use the integration on that system for that database set.

In environments where multiple database sets are used with the integration, the user may need to be logged in to a different user database. Credentials are required for a change in login in the following usages:

  • The project manager enables a UCM project to use the integration.
  • A user displays or sets project policies related to the integration.
  • A developer works on an activity in a project that is enabled for the integration.
  • A user displays properties of an HCL Compass activity record that has contributions from a project that is connected to another HCL Compass user database.
  • A developer who accesses multiple UCM projects that are connected to different HCL Compass database sets does one of the following operations:
    • Starts a delivery in one project while working in another project.
    • Delivers changes in a stream in one project to a stream in another project.
  • A developer transitions an HCL Compass activity record.

Create and maintain the credentials on the user's system for each database set. The credential information is stored on the system so that the user can be logged in by the integration server when a different user database is accessed. If no credentials exist for a user when a connection to another user database is required, an error message is generated.

Use the crmregister command for the following purposes:

  • Create a new entry or overwrite an existing entry. For example: 
    crmregister add -database MY_DB -connection 07.00 
-user jsmith -password mypassword
  • For a UCM-Compass integration that uses a remote Compass Web server, configure the integration by registering the Compass database and create a new entry. For example:
    crmregister add -database TEST -connection CQMS.UCMCQ_DBS.EXAMPLE 
-url http://lakota/cqweb/oslc -username akp -password mypassword
  • Delete an entry or all entries. For example: 
    crmregister remove -database MY_DB
crmregister remove -all
  • Modify the specified fields for a specified user database. For example: 
    crmregister replace -database MY_DB -password mynewpassword