Preserve the CM Server configuration before customizing the MBean attributes or upgrading from or reinstalling ClearCase and ClearQuest

This tech note describes maintenance and upgrade installation best practices for the CM Server WAN support components of ClearCase and ClearQuest.

The information in this technote supplements the information in the ClearCase and ClearQuest Information Centers. For information on setting the available CM Server MBean attributes and additional information on using the wsadmin utility, see the ClearCase and ClearQuest 7.1 Information Centers:

ClearCase Information Center:

https://publib.boulder.ibm.com/infocenter/cchelp/v7r1m0/topic/com.ibm.rational.clearcase.cc_admin.doc/topics/cm_server/admin_console.htm

ClearQuest Information Center:

https://publib.boulder.ibm.com/infocenter/cqhelp/v7r1m0/topic/com.ibm.rational.clearquest.webadmin.doc/topics/cm_server/admin_console.htm

If your ClearCase and ClearQuest 7.1.0.x installation includes the WAN support packages, then the CM Server components are also installed. To determine if the WAN support packages are installed, check if the CM subdirectory is installed in the Rational common directory.

On Windows: %RATIONAL_INSTALL%\%RATIONAL_COMMON%\

On the UNIX system and Linux: $RATIONAL_INSTALL/$RATIONAL_COMMON/

where the variables have the following meanings:

• RATIONAL_INSTALL: Directory where the Rational software is installed
• RATIONAL_COMMON: Rational common directory

Attention: Before upgrading from or reinstalling ClearCase and ClearQuest 7.1.x.y, you must preserve the CM Server MBean configuration because the installer does not. If you do not perform this task before upgrading or reinstalling, any customizations that you have made are lost.

It is also a good practice to export the MBean configuration prior to modifying any of the CM Server MBean attributes by using the wsadmin scripts included with the installed CM Server components. This allows you to restore the MBean values to a known working configuration if the new settings produce undesirable results.

You must run the wsadmin scripts while the CM Server components, including WebSphere Application Server, are running. Note that you can automate the procedure of capturing the CM Server MBean configuration on a periodic basis by creating an AT job on Windows or a cron job on the UNIX system or Linux.


Procedure for exporting and importing MBean configuration settings

Attention: If only ClearCase or only ClearQuest is installed, then you must follow the instructions in the next section "Procedure for Manually Preserving the MBean Configuration Settings" instead of using the instructions in this section.

Following is the default location of the CM Server wsadmin utility scripts:

• On Windows: C:\Program Files\IBM\RationalSDLC\common\CM\scripts
  
• On the UNIX system and Linux: /opt/rational/common/CM/scripts

1. In a command prompt window, set the default directory to the location of the CM Server wsadmin utility scripts. For example:
   
   On Windows:
   # cd "C:\Program Files\IBM\RationalSDLC\common\CM\scripts"
   
   On the UNIX system and Linux:
   # cd /opt/rational/common/CM/scripts
   
   
2. Set the path to the wsadmin utility by using the syntax appropriate for your shell. For example:
   
   On Windows:
   # set WAS_BIN="C:\Program Files\IBM\RationalSDLC\common\eWAS\bin"
   
   On the UNIX system and Linux:
   # WAS_BIN=/opt/rational/common/eWAS/bin
   
   
3. Start the wsadmin utility by specifying the CM Server profile name. By default, the CM Server profile name is cmprofile. For example:
   
   On Windows:
   # %WAS_BIN%\wsadmin -profileName cmprofile
   
   On the UNIX system and Linux:
   # $WAS_BIN/wsadmin.sh -profileName cmprofile
   
   
4. Load the JACL scripts, which include the exportToFile and importFile commands, into your wsadmin command shell:
   
   wsadmin> source teamAdminUtils.jacl
   
   
5. Export the MBean configuration to a file that is outside the CM Server installation directory structure.
   
   Attention: On Windows, when you run a JACL script from the wsadmin command shell, you can use forward slashes '/' in the path specification that you pass to the JACL script. Alternatively, if you choose to use backslashes '\', you must escape each backslash character with an additional backslash. For example:
   
   On Windows:
   wsadmin> exportToFile C:/temp/CmServer_backups/MBean.bck
   
   On the UNIX system and Linux:
   wsadmin> exportToFile /tmp/CmServer_backups/MBean.bck
   
   You can specify the same path specification and file name each time you run the exportToFile command. The exportToFile command automatically detects when the named file already exists and creates a new version by appending the date and time to the file name when the exportToFile command is run.
   
   
6. After upgrading ClearCase and ClearQuest, ensure that the CM Server components are running and repeat steps 1 through 4. Then use the importFile wsadmin command to import the files that you created in step 5. For example:
   
   On Windows:
   wsadmin> importFile C:/temp/CmServer_backups/MBean.bck
   
   On the UNIX system and Linux:
   wsadmin> importFile /tmp/CmServer_backups/MBean.bck
   
   You can use the importFile command to restore a saved MBean configuration, for example, after you upgrade or reinstall the CM Server components or after you make MBean configuration changes and then want to roll back to a previous configuration.
   
   

Procedure for Manually Preserving the MBean Configuration Settings

If only ClearCase or only ClearQuest are installed, you must follow the instructions in this section. Otherwise, if ClearCase and ClearQuest are both installed, use the instructions in the previous section "Procedure for exporting and importing MBean configuration settings."

1. In a command prompt window, set the default directory to the following location, replacing the following variables, as appropriate:
   
   * Replace cmprofile if the default profile name is not used
   * Replace <computer-name>CMProfileNode01Cell, dfltCell, <computer-name>CMProfileNode01, or dfltNode with the cell name and node name
   
   For example:
   
   On Windows:
   # cd "C:\Program Files\IBM\RationalSDLC\common\CM\profiles\cmprofile\config\cells\
   <computer-name>CMProfileNode01Cell\nodes\<computer-name>CMProfileNode01\servers\server1\stp"
   
   
   On the UNIX system and Linux:
   # cd /opt/rational/common/CM/profiles/cmprofile/config/
   cells/dfltCell/nodes/dfltNode/servers/server1/stp
   
   
2. Copy all .dat files from the default directory to a temporary directory outside the CM Server installation directory structure. For example:
   
   On Windows:
   # copy *.dat C:\temp\CmServer_mbean_config_files
   
   On the UNIX system and Linux:
   # cp *.dat /tmp/CmServer_mbean_config_files
   
   
3. After upgrading ClearCase and ClearQuest, ensure that the CM Server components are not running. Follow the instructions at either of the following links to stop the CM Server components:
   
   https://publib.boulder.ibm.com/infocenter/cchelp/v7r1m0/topic/com.ibm.rational.clearcase.cc_admin.doc/topics/cm_server/t_stop_and_restart_cmserver.htm
   
   or
   
   https://publib.boulder.ibm.com/infocenter/cqhelp/v7r1m0/topic/com.ibm.rational.clearquest.webadmin.doc/topics/cm_server/t_stop_and_restart_cmserver.htm
   
   
4. Open a command prompt window. As the root user, set the default directory to the location described in step 1. Then copy the saved .dat files from the temporary directory used in step 2 into the default directory. For example:
   
   On Windows:
   # copy C:\temp\CmServer_mbean_config_files\*.dat .
   
   On the UNIX system and Linux:
   # cp /tmp/CmServer_mbean_config_files/*.dat .
   
   When the CM Server components are started, the data from the restored .dat files are used to initialize the MBean attributes.