crmregister
Create, change, or list HCL Compass user database connection information used by UCM operations that originate on the local host.
Applicability
Product |
Command type |
|---|---|
VersionVault |
command |
Platform |
|---|
Windows® |
UNIX® |
|
Linux® |
Synopsis
- Display the help.
- crmregister help [ –graphical ] [ command_name ]
- Register a new HCL Compass user database
in the local cache.
- crmregister add { –database crm-database-name –con/nection crm-connection –url Web-URL –user/name crm-user-name [ –pass/word password ] | –gui –database crm-database_name –connection crm-connections-name }
- Remove locally cached information about HCL Compass user databases.
- crmregister remove { –database crm-database-name | –all }
- Change connection or user credentials information for an
HCL Compass user database already registered
in the local cache.
- crmregister replace –database crm-database-name [–con/nection crm-connection-name ] –url Web-URL [–user/name crm-user-name ] [–pass/word password ]
- List information about an
HCL Compass user database.
- crmregister list [ –database crm-database-name ]
- Exit the crmregister utility.
- crmregister quit
Description
The UCM integration with HCL Compass supports multiple database sets (connections). Each connection for each HCL Compass user database on a local host requires a valid HCL Compass user name and password. If a user of the integration performs an action that requires a login to an HCL Compass user database, the integration requires database, connection, and user credentials before it can attempt the login.
The crmregister utility provides a way for a user to create, add, or change the connection and credential information that UCM operations use in a UCM project that has been enabled for HCL Compass. The information is registered (stored on the local host) and used by UCM operations when they need to access an HCL Compass user database.
The crmregister utility affects locally cached information only. It has no effect on the HCL VersionVault registry.
Restrictions
None.
Options and arguments
The crmregister utility has several subcommands. The following sections describe options and arguments supported by each of the subcommands.
Getting help
Use crmregister help to display product help or the synopsis of a crmregister subcommand.
- Default
- None.
- –graphical
- Starts the product help system.
- command-name
- Displays the synopsis of the specified subcommand.
Adding a new registration
Use crmregister add to register connection information for an HCL Compass user database.
- Default
- None.
- –database crm-database-name
- Creates an entry for crm-database-name in the local CRM information registry. An HCL Compass user database named crm-database-name must be accessible from the local host over the connection specified with the –connection option.
- –con/nection crm-connection
- Specifies a database connection to be used when accessing the database specified by crm-database-name. A connection named crm-connection must exist on the local host.
- –url Web-URL
- Specifies the base URL for the Compass OSLC CM REST API. Use this option to configure the UCM Compass integration to use a remote Compass Web server.
- –user/name crm-user-name
- Specifies a valid HCL Compass user name to use for authentication when accessing the database specified by crm-database-name. This must be a name that maps to the current UCM user. The user name is not validated by crmregister.
- –pass/word password
- Specifies a password that is valid for crm-user-name. The password is not validated by crmregister.
- –gui
- Start the graphical user interface.
Removing an existing registration
Use crmregister remove to remove an entry from the local CRM registry.
- Default
- None.
- –database crm-database-name
- Removes the entry for crm-database-name from the local CRM registry. Returns an error if no entry for crm-database-name exists.
- –all
- Removes all entries from the local CRM information registry.
Replacing an existing registration
Use crmregister replace to replace connection information for an HCL Compass user database that is already registered in the local CRM registry.
- Default
- None.
- –database crm-database-name
- Replaces the connection and, optionally, user name and password information for crm-database-name in the local CRM registry. Returns an error if no entry for crm-database-name exists.
- –con/nection crm-connection
- Specifies a database connection to be used when accessing the HCL Compass user database specified by crm-database-name. A connection named crm-connection must exist on the local host and be a valid connection for the specified crm-database-name.
- –url Web-URL
- Specifies the base URL for the Compass OSLC CM REST API. Use this option to configure the UCM Compass integration to use a remote Compass Web server.
- –user/name crm-user-name
- Specifies a valid HCL Compass user name to use for authentication when accessing the HCL Compass user database specified by crm-database-name. This should be a name that maps to the current UCM user. The user name is not validated by crmregister.
- –pass/word password
- Specifies a password that is valid for crm-user-name. The password is not validated by crmregister.
Listing information about an HCL Compass user database
- Default
- None.
- –database crm-database-name
- Specifies the database about which information is to be listed.
Exiting the crmregister utility
- Default
- None.
- quit
- Exits crmregister.
Examples
- Register a new database and connection.
crmregister add -database TEST -connection CQMS.UCMCQ_DBS.EXAMPLE -username akp - Configure the UCM Compass integration to
use a remote Compass Web server.
crmregister add -database TEST -connection CQMS.UCMCQ_DBS.EXAMPLE -url http://lakota/cqweb/oslc -username akp - Change the password for the user name associated with database TEST.
crmregister replace -database TEST -password N09b6tyP Updating Compass login information for user akp, Compass database TEST.