clm_server_rename.pl

This tool updates Jazz Team Server public URI artifact links for the HCL Compass solution for Collaborative Lifecycle Management (CLM). Specifically, the tool updates the URIs that are stored in HCL Compass Web server configuration files. The tool also updates the URIs that are stored in OSLCLink records in the HCL Compass user database.

Synopsis

cqperl clm_server_rename.pl -username username -password password [ -dbset dbset ] -dbname dbname -oldprefix oldprefix -newprefix newprefix [ -remapconfigfiles | -preview number | -update ] [ -help ] [ -man ]

Description

There are several types of links for artifacts in the HCL Compass solution for CLM:
  • Structural links describe relationships between resources or artifacts and are required to maintain traceability and data integrity.
  • Embedded links are URIs that can be included in a text field or node of a resource. Embedded links can be either anchored links or plain text links.
    • Anchored links are displayed to a user as navigable hyperlinks. For example, in a rich text widget, these links are declared as such and are usually stored in a structure like <a href=...>.
    • Plain text links are URIs that are typed into a text widget but are not rendered as navigable hyperlinks.

HCL Compass provides the clm_server_rename.pl tool to remap URI structural links that are stored in HCL Compass 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 HCL Compass Super User privileges to run the clm_server_rename.pl tool.

The tool is located in this directory in the cqweb.war file:

WAS_profile_home\installedApps\nodecell\TeamEAR.ear\cqweb.war\WEB-INF\classes

The cqperl.exe program is located in the directory where HCL Compass 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.

  • Reconfigure cross-server communication only on the HCL Compass Web server. For each solution for CLM cross-server friend for which you have reestablished cross-server communication, run the tool with the -remapconfigfiles option. . This updates the HCL Compass Web server configuration files.
    Important: When you use this option, you must run the tool from the directory where the tool is installed.
  • If your deployment includes HCL Compass MultiSite, you must repeat the previous step for each replica where the affected HCL Compass OSLCLinks records are mastered. The tool reports the OSLCLinks records that are mastered remotely.

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.

Limitations

The clm_server_rename.pl tool only remaps structural links that are stored in HCL Compass Web server configuration files and in OSLCLinks records. The tool does not remap embedded links that are stored in HCL Compass 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.

Options and arguments

-username username
Logon name of an administrative user with Super User privileges.
-password password
Password of an administrative user with Super User privileges.
-dbset dbset
Name of the database connection.
-dbname dbname
Name of the user database.
-oldprefix oldprefix
Specifies an existing URI string. The URI format must start with http and include the application context followed by a slash (/).
-newprefix newprefix
Specifies a new URI string to replace the existing URI string specified by the -oldprefix option. The URI format must start with http and include the application context followed by a slash (/).
-remapconfigfiles
Important: When you use this option, you must run the tool in the directory where the tool is installed.
-preview number
Displays a preview of the changes that will be made to the number of OSLCLinks records in the HCL Compass database that contain the oldprefix URI string. Also reports the total number of OSLCLinks records that contain the oldprefix URI string. No changes are made to the user database when this option is used.

See also

Remapping URIs after renaming a CLM server, Changing the public URI using server rename