Starting in the version 4.0 products for the Rational solution for Collaborative Lifecycle Management (CLM), administrators can change the public URI of a Jazz Team Server or a Rational solution for CLM application after deployment by using the server rename operation. Such changes require corresponding updates to the Rational solution for CLM resources that are based on the URI. For the ClearQuest Bridge, these artifact links for the Rational solution for CLM product resources (IBM Rational Team Concert, IBM Rational Quality Manager, and IBM Rational DOORS Next Generation) are stored in ClearQuest Web server configuration files and in OSLCLinks records in the ClearQuest user database.
ClearQuest provides the clm_server_rename.pl tool to remap URI structural links that are stored in ClearQuest Web configuration files and in OSLCLinks records. Use the tool to remap the protocol, host name, port number, and application context of structural links.
Running the tool
You must have local administrator privileges and ClearQuest Super User privileges to run the clm_server_rename.pl tool.
The tool is located in this directory in the cqweb.war file:
The cqperl.exe program is located in the directory where ClearQuest is installed.
Before running the clm_server_rename.pl tool, it is a good practice to set the TEMP environment variable to a directory where you have write access. Otherwise, ensure that you have write access in the directory where you are running the tool.
You must run the tool several times.
For example, if ClearQuest is integrated with IBM Rational Team Concert and IBM Rational Quality Manager, and both the Jazz Team Server for Rational Team Concert and the Rational Quality Manager server are renamed, then you must run the tool with the -remapconfigfiles option twice: once for remapping the URIs for the Rational Team Concert artifact links, and once for remapping the URIs for the Rational Quality Manager artifact links.
For example, if ClearQuest is integrated with IBM Rational Team Concert and IBM Rational Quality Manager, and both the Jazz Team Server for Rational Team Concert and the Rational Quality Manager server are renamed, then you must run the tool with the -update option twice: once for remapping the URIs for the Rational Team Concert artifact links, and once for remapping the URIs for the Rational Quality Manager artifact links.
See Remapping URIs after renaming a CLM server for complete procedure details.
See the Options and arguments section for a description of the command-line options.
The clm_server_rename.pl tool only remaps structural links that are stored in ClearQuest Web server configuration files and in OSLCLinks records. The tool does not remap embedded links that are stored in ClearQuest records. Such embedded anchor links can be included in record attachments or in fields such as descriptions or notes. Depending on the schema, these fields might become read-only after submission or after a note is added. This means that the embedded anchor links will remain broken after running the tool. You can write code to fix these links, if required.
An example of an embedded anchor link that remains broken after running the tool involves the Rational solution for CLM integration between Rational ClearQuest and Rational Quality Manager. When a Rational Quality Manager artifact is linked to a ClearQuest record, Rational Quality Manager inserts a URI link to the artifact in the record-description field.
Remaps Jazz Team Server public URI artifact links for the Rational solution for CLM applications. Specifically, this option remaps URIs that are stored in ClearQuest Web server configuration files. The tool makes a copy of the configuration files before remapping the URIs.
After running the tool with this option, you must restart the ClearQuest Web server. Then, cross-server communication on the web server is reconfigured and users can create new URI links to the Rational solution for CLM artifacts. However, following existing links to the Rational Solution for CLM artifacts will not work until you run the tool again with the -update option.
When the tool is run with the this option, the tool captures the changes to OSLCLinks records in a log file. If the TEMP environment variable is set, the log file is written to the specified directory; otherwise, the log file is written to the directory from where you are running it, provided you have write access. The following file-naming convention is used for the log file:
where:
For example, clm_server_rename_20120405_211711.
C:\was_profiles\MyCQWebServer\installedApps\Node02Cell\TeamEAR.ear\cqweb.war\WEB-INF\classes>cqperl clm_server_rename.pl -username admin -password secret -dbset 7.0.0 -dbname SAMPL -oldprefix https://clm7.mycompany.com/ccm/ -newprefix https://clm7.mycompany.com/jazz/ -remapconfigfiles
Started: Remapping URIs in config file friendsconfig.rdf.
Completed: Remapping URIs in config file friendsconfig.rdf.
Started: Remapping URIs in config file project-area-links.rdf.
Completed: Remapping URIs in config file project-area-links.rdf.
Started: Remapping URIs in config file oauth-consumers.rdf.
Completed: Remapping URIs in config file oauth-consumers.rdf.
cqperl clm_server_rename.pl -username admin -password secret -dbset 8.0.0 -dbname SAMPL -oldprefix https://servername.com:9443/jazz/ -newprefix https://servername.com:9443/ccm/ -preview 5
cqperl clm_server_rename.pl -username admin -password secret -dbset 8.0.0 -dbname SAMPL -oldprefix http://servername.com:9443/jazz/ -newprefix https://servername.com:9443/jazz/
cqperl clm_server_rename.pl -username admin -password secret -dbset 7.0.0 -dbname SAMPL -oldprefix http://servername.com:9443/jazz/ -newprefix https://newservername.com:9443/jazz/