Rational Synergy Interim Fix 2 for 7.2.0.1

Installation Instructions

Where to Apply this iFix

Apply this iFix to all Synergy installations (CCM_HOME) and clients. First install to the machine where the Synergy router daemon is running, then install to other server machines, and finally deploy to client machines.

Deliverable Synergy Components Affected (UNIX)

Those marked with (*) have changed since 7.2.0.1 iFix001.

Database files affected by the iFix:

CCM_HOME files affected by the iFix:

Warning:

Before you begin, make sure that you have performed a successful backup of your Synergy installation areas.

This iFix contains modifications to the software that must be installed in the installation directory (CCM_HOME changes).

Once you have installed 7.2.0.1 iFix002, do not install any individual iFix that does not clearly state that it may be installed on top of 7.2.0.1 iFix002, unless informed otherwise by Synergy Support.

1. To install this iFix on UNIX, use the ccm_patch script. If you do not have the ccm_patch script, please download it from the
   Synergy Support web site. If you have previously downloaded a copy of ccm_patch, please check to see if it is still the most up to date version. If not, download the latest version and discard your previous version. At the time of writing, the latest version of ccm_patch is 46. If you have downloaded a newer version, then copy the ccm_patch script to $CCM_HOME/bin in each server installation; make sure it is owned by ccm_root and has execute permission (mode 0755).
2. In preparation for the following steps, ask all users to exit their Synergy sessions.
   
   
3. Login as user ccm_root and set CCM_HOME to point to your Synergy installation. Shut down all Synergy 7.2 databases. Verify that all users have exited by using the ccm monitor command.
   
  $ su - ccm_root
  ccm_root$ CCM_HOME=/usr/local/ccm72  # Adjust as appropriate
  ccm_root$ PATH=$CCM_HOME/bin:$PATH
  ccm_root$ export CCM_HOME PATH
  ccm_root$ ccmdb shutdown <dbpath>    # Repeat per database
  ccm_root$ ccm monitor

   Stop the Synergy daemons using the ccm_stop_daemons command.
   
   ccm_root$ ccm_stop_daemons

   
4. Update the Synergy installation directory.
   
   Use the ccm_patch command. The argument to ccm_patch is the full path to the iFix file that you are installing.
   
   Note that ccm_patch must be run as root, since it needs to set ownership and permissions on the patched files.
   
  ccm_root$ su
  # CCM_HOME=/usr/local/ccm72     # Adjust as appropriate
  # PATH=$CCM_HOME/bin:$PATH
  # export CCM_HOME PATH
   
   If your database runs on Oracle then set ORACLE_HOME.
   
      # ORACLE_HOME=/usr/local/oracle   # Adjust as appropriate
      # export ORACLE_HOME

  # ccm_patch <PATH>/7.2.0.1-RATL-RATISYNE-UNIX-IF002.tar.gz
  # exit

   Repeat this command for each installation directory.
   
   Once the installation directory has been updated, restart the Synergy daemons as the ccm_root user.
   
   ccm_root$ ccm_start_daemons

   
5. Use the ccm_patch command to apply this iFix to one or more databases
   
   If you have a customized model using a custom model database, contact Synergy Support for assistance.
   
   Databases that were shut down in step 3 must be unprotected prior to patching.
   
$ su - ccm_root
ccm_root$ CCM_HOME=/usr/local/ccm72 # Adjust as appropriate
ccm_root$ PATH=$CCM_HOME/bin:$PATH
ccm_root$ export CCM_HOME PATH
ccm_root$ ccmdb unprotect <dbpath>
ccm_root$ ccm_patch -dbonly $CCM_HOME/patches/7.2.0.1.002 <dbpath>.

   
6. Inform users that they can restart their Synergy sessions.
   
   This iFix contains a Windows client component. Users of Synergy Windows GUI will be prompted to download the iFix when they start a session. Users of the Windows CLI will be requested to patch their clients by browsing to
   
   http://<helpserver>:<port#>/client/Update_7.2-0.1.002.exe

   Alternatively, the executable, Update_7.2-0.1.002.exe, can be distributed to Windows CLI users, so they can execute it directly, to update their client installations.

If it is necessary to remove the iFix after it was installed, follow these steps. If you have a Windows client, see Reversing the iFix (Microsoft Windows).

1. In preparation for the following steps, ask all users to exit their Synergy sessions. As 'ccm_root', shut down all Synergy databases that use this installation. Verify that all users have exited by using ccm monitor.
   
  $ su - ccm_root
  ccm_root$ CCM_HOME=/usr/local/ccm72  # Adjust as appropriate
  ccm_root$ PATH=$CCM_HOME/bin:$PATH
  ccm_root$ export CCM_HOME PATH
  ccm_root$ ccmdb shutdown <dbpath>    # Repeat per database
  ccm_root$ ccm monitor

   Stop the Synergy daemons using the ccm_stop_daemons command.
   
   ccm_root$ ccm_stop_daemons

   
2. Restore the installation files from before 7.2.0.1 iFix002
   
   $CCM_HOME contains a save directory structure that contains all files that were removed or replaced during the iFix installation process. The files are saved with a suffix of _p7.2.0.1.002. In addition, the first time a particular file is saved it will also be saved with an extension of _orig. Replace all files that were updated with this iFix. For a complete list of $CCM_HOME files that were changed see section Deliverable Synergy Components Affected (UNIX).
   
   For example $CCM_HOME/lib/ccmjava.jar was replaced. To replace it with the file from before this iFix:
   
   ccm_root$ cp $CCM_HOME/save/lib/ccmjava.jar_p7.2.0.1.002 \
               $CCM_HOME/lib/ccmjava.jar

   Repeat this step for each $CCM_HOME file listed in Deliverable Synergy Components Affected (UNIX).
   
   Create the following directory:
   
   ccm_root$ mkdir $CCM_HOME/jetty/work

   Remove the following directory, if present:
   
   ccm_root$ rmdir $CCM_HOME/jetty/temp

   
   
3. Remove entries in patches.txt and patches.dat
   
   In the $CCM_HOME/etc directory are files patches.txt and patches.dat. Using an editor, for instance vi, edit these files. Remove the lines referencing this iFix.
   
   Save this file and exit the editor. If the resulting files are empty then delete them.
   
   
4. Login as user 'root'. You need to run $CCM_HOME/bin/ccm_install in order to reset the ownership and permissions of the original files you copied back:
   
  $ su -
  # CCM_HOME=/usr/local/ccm72    # Adjust as appropriate
  # PATH=$CCM_HOME/bin:$PATH
  # export CCM_HOME PATH

   If your database runs on Oracle then set ORACLE_HOME
   
       # ORACLE_HOME=/usr/local/oracle   # Adjust as appropriate
       # export ORACLE_HOME

  # ccm_install -c
  # exit

   
5. Reverse iFix 7.2.0.1.002 in databases.
   
   If you have a customized model, using a model database, reinstate your previous model by performing a model install from your original customized model project to each database.
   
   Each database directory contains a save directory structure that contains all files that were removed or replaced during the iFix installation process. The files are saved with a suffix of _p7.2.0.1.002. In addition, the first time a particular file is saved it will also be saved with an extension of _orig. All files that were updated with this iFix should be replaced. For a complete list of database files that were changed see section Deliverable Synergy Components Affected (UNIX).
   
   For example <dbpath>/lib/baselib.a was replaced, to replace it with the file from before this iFix:
   
ccm_root$ cp <dbpath>/save/lib/baselib.a_p7.2.0.1.002 <dbpath>/lib/baselib.a

   Repeat this step for each database file listed in Deliverable Synergy Components Affected (UNIX)
   
   In the database path/db directory of each database is a file named MDL_INFO. Using an editor, for instance vi, edit these files. Remove the lines referencing this iFix.
   
   In the <database path>/etc directory of each database is a file named patches.dat. Using an editor, for instance vi, edit these files. Remove the lines referencing this iFix.
   
   Save these files and exit the editor. If the resulting files are empty then they should be deleted.
   
   
6. Unprotect the databases that were shut down in step 1, using:
   
   ccm_root$ ccmdb unprotect <dbpath>

   Repeat for every database that was patched.
   
   
7. Start the Synergy daemons using the ccm_start_daemons
   command.
   
   ccm_root$ ccm_start_daemons

   
8. Inform users that they can restart their Synergy sessions.

Deliverable Synergy Components Affected (Microsoft Windows)

Those marked with (*) have changed since 7.2.0.1 iFix001.

Database files affected by the iFix:

CCM_HOME files affected by the iFix:


%CCM_HOME%\bin\util\ccm_ess.exe
%CCM_HOME%\bin\util\ccm_helpsrv.exe
%CCM_HOME%\bin\util\ccm_objreg.exe
%CCM_HOME%\bin\util\ccm_router.exe
%CCM_HOME%\bin\util\ccm_websrv.exe
%CCM_HOME%\lib\ccmjava.jar (*)
%CCM_HOME%\lib\ccm_merge.jar
%CCM_HOME%\lib\copytools.jar
%CCM_HOME%\etc\ccm_ja.properties
%CCM_HOME%\etc\ccm_zh.properties
%CCM_HOME%\etc\ccm_resource_ja.properties
%CCM_HOME%\etc\ccm_resource_zh.properties
%CCM_HOME%\etc\CcmError_ja.properties
%CCM_HOME%\etc\CcmError_zh.properties
%CCM_HOME%\etc\landing\devlanding_ja.htm
%CCM_HOME%\etc\landing\devlanding_zh.htm
%CCM_HOME%\etc\landing\bmlanding_ja.htm
%CCM_HOME%\etc\landing\bmlanding_zh.htm
%CCM_HOME%\etc\welcome\documentation_ja.htm
%CCM_HOME%\etc\welcome\documentation_zh.htm
%CCM_HOME%\etc\welcome\index_ja.htm
%CCM_HOME%\etc\welcome\index_zh.htm
%CCM_HOME%\etc\welcome\nav_general_ja.htm
%CCM_HOME%\etc\welcome\nav_general_zh.htm
%CCM_HOME%\etc\welcome\support_ja.htm
%CCM_HOME%\etc\welcome\support_zh.htm
%CCM_HOME%\etc\welcome\welcome_ja.htm
%CCM_HOME%\etc\welcome\welcome_zh.htm
%CCM_HOME%\jetty\webapps\SynergyServer\jsp\database_mapping.jsp
%CCM_HOME%\jetty\webapps\help\synergyhelp.war


Installation Instructions (Microsoft Windows)

Before you begin, make sure that you have performed a successful backup of your Synergy Installation areas.

This iFix contains modifications to the software that must be installed in the installation directory (CCM_HOME changes).

This iFix also contains changes that must be installed in Synergy databases (model changes).

Once you have installed 7.2.0.1 iFix002, do not install any individual iFix that does not clearly state that it may be installed on top of 7.2.0.1 iFix002, unless informed otherwise by Synergy Support.

1. Request that all users exit their Synergy sessions before you begin the installation. Shutdown all Synergy databases using the ccmdb shutdown command. Verify that all users have exited by using the ccm monitor command.
   
  > ccmdb shutdown <dbpath>    # Repeat per database
  > ccm monitor

   
2. To apply the iFix to a Windows Synergy server installation, you must log in as a user in the Local Administrator group on the Main or Additional server machine. Do not install the iFix on your computer if you use a shared network installation; just install the iFix once on the network installation.
   
   
3. Once you have logged in as the appropriate user, run the iFix executable, 7.2.0.1-RATL-RATISYNE-Windows-IF002.exe from the command prompt or by double clicking it. This brings up the Patch Installation Utility which guides you through the steps of installing the iFix.
   
   
4. Patch standard databases.
   
   If you do not have a customized model, apply this iFix to each of your databases. ALL databases must be patched prior to use with this iFix.
   
   If you have a customized model using a custom model database, contact Synergy Support for assistance.
   
   To patch a database on a Windows server, use the batch script that was extracted when you ran the self-extracting patch executable on the server. This script needs to be given the database path of the database(s) to be patched.
   
   Log in as "CM administrator" on the Main or Additional Server machine for the database being patched, and bring up a command window. Repeat the following commands for each database:
   
> set CCM_HOME=c:\ccm72 # Adjust as appropriate
> set PATH=%CCM_HOME%\bin;%PATH%
> ccmdb unprotect <dbpath>
> ccmdb_patch_7201_002 <dbpath>

   
5. Inform users that they can restart their Synergy sessions.
   
   This iFix contains a Windows client component. Users of the Synergy Windows GUI will be prompted to download the iFix when they start a session. Users of the Windows CLI will be requested to patch their clients by browsing to:
   
   http://helpserver:port#/client/Update_7.2-0.1.002.exe.

   Alternatively, the executable, Update_7.2-0.1.002.exe, can be distributed to Windows CLI users, so they can execute it directly, to update their client installations.
   

If it is necessary to remove the iFix after it was installed follow these steps; they must be performed by a Synergy database administrator.

1. Request that all users exit their Synergy sessions before you begin the uninstallation. Shutdown all Synergy databases using the ccmdb shutdown command. Verify that all users have exited with ccm monitor.
   
  > ccmdb shutdown <dbpath>     # repeat per database
  > ccm monitor

   
2. Stop the 7.2 Synergy services. Perform this step as an admin user.
   
   Open the services dialog and stop the Synergy services. If you are unfamiliar with these services refer to the Synergy Administration Guide For Windows for additional details.
   
   
3. Restore the original files replaced by 7.2.0.1 iFix002
   
   Before replacing the original files, remove the hidden attribute from files stored under the %CCM_HOME%\patches\7.2.0.1.002 directory and its subdirectories.
   
   Do this as user who has local admin rights.
   
   Use the attrib command to remove the Hidden attribute from
   the files. From a command prompt:
   
  > cd %CCM_HOME%\patches\7.2.0.1.002
  > attrib -h * /s /d

   The %CCM_HOME%\patches\7.2.0.1.002 directory contains two files and either three or four sub-directories.
   
   The two files are a README file and ccm_bp.ini. You do not need to be concerned with the ccm_bp.ini file.
   
   The three sub-directories that every installation will have are CCM_HOME, util, and WINSYS. If your installation contains the Synergy Database Administration Tools, there will be an additional sub-directory named database. This last directory is not hidden and the files it contains are not hidden.
   
   The util and WINSYS directories are empty, and can be ignored. The database directory may also be ignored at this time.
   
   The CCM_HOME directory contains a directory structure similar to that of your Synergy installation area. Any files that were removed or replaced from your installation area are under this directory.
   
   After removing the hidden attribute from all of the files stored under this CCM_HOME directory and its sub-directories, copy or move all of these files into the Synergy installation area directory structure, replacing the files that are currently there.
   
   For example, the file "ccmjava.jar" was replaced by this iFix.
   
   This file is located in the %CCM_HOME%\lib directory. To replace the iFix version of the file with the original file, copy or move the previously saved "ccmjava.jar" file from the directory
   
   %CCM_HOME%\patches\7.2.0.1.002\CCM_HOME\lib

   to the directory
   
   %CCM_HOME%\lib

   Restore all CCM_HOME files replaced by this iFix. For a complete list of CCM_HOME files replaced, please see the above section titled, Deliverable Synergy Components Affected (Microsoft Windows).
   
   Create the following directory and make sure it is writable by the CM admin user:
   
   %CCM_HOME%\jetty\work

   Remove the following directory, if present:
   
   %CCM_HOME%\jetty\temp

   
   
4. Remove entries in patches.txt and patches.dat
   
   In the %CCM_HOME%\etc directory are files patches.txt and patches.dat. Using a text file editor (such as Notepad.exe), edit these files and remove the lines referencing this iFix.
   
   Save this file and exit the editor. If the resulting files are empty, then delete them.
   
   
5. Remove 7.2.0.1.002 Key from the Registry
   
   On 32 bit systems this key is located at:
   
HKEY_LOCAL_MACHINE\SOFTWARE\Telelogic\CM SYNERGY\7.2\Install\Patches\7.2.0.1.002.

   or
   
HKEY_CURRENT_MACHINE\SOFTWARE\Telelogic\CM SYNERGY\7.2\Install\Patches\7.2.0.1.002.

   On 64 bit systems this key is located at:
   
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432node\Telelogic\CM SYNERGY\7.2\Install\Patches\7.2.0.1.002.

   Start the registry editor program by selecting Run... from the Start menu and typing regedit.exe in the Open text field.
   
   When the Registry Editor starts, browse to the appropriate key listed above. You will see a key labeled 7.2.0.1.002. Select this key by clicking on it with the mouse. Now delete the key by pressing Delete on your keyboard. Exit the registry editor.
   
   
6. Reverse iFix 7.2.0.1.002 in databases
   
   If you have a customized model, using a model database, reinstate your previous model by performing a model install from your original customized model project to each database.
   
   If you used "ccmdb_patch_7201_002.bat" to install iFix 7.2.0.1.002 to your databases, the following three steps were performed when "ccmdb_patch_7201_002" was run:
   
   
• Before the iFix was applied, affected database files were copied to <dbpath>\save\<filename>.p7201.002
• The updated files from the iFix were copied to the database.
• A line was appended to <database path>\db\MDL_INFO as a record of the iFix.
  
  To reverse these actions, perform the following steps for each patched database.
  
  

i. Log in as "CM administrator" on the database server machine, and bring up a command window.



ii. Remove the database files that were changed:

> del <dbpath>\lib\baselib.a


Move the saved copy of the these files back into their original locations:


> move <dbpath>\save\lib\baselib.a.p7201.002 <dbpath>\lib\baselib.a

Repeat this step for each database file listed in Deliverable Synergy Components Affected (Microsoft Windows).

iii. In the <database path>\db directory, there is a file named MDL_INFO. Using a text file editor (like Notepad.exe), edit this file and remove the lines referencing this iFix.

Save this file and exit the editor.

In the <database path>\etc directory is a file named patches.dat. Using a text file editor (like Notepad.exe), edit this file and remove the line referencing this iFix.

Save this file and exit the editor. If the resulting files are empty, delete them.

7. Restart the Synergy services
   
   Restart the services that were stopped in an step 2. Open the services dialog and start the Synergy services. If you are unfamiliar with these services refer to the Synergy Administration Guide For Windows for additional details.
   
   
8. Unprotect the databases that were shut down in step 1
   
   > ccmdb unprotect <dbpath>

   Repeat for every database that was patched.
   
   
9. Inform users that they can restart their Synergy sessions.