Installing the Latest Patch on Windows

Percussion CM1 version 5.3 or greater support a Patching mechanism to apply updates and defect corrections to CM1 servers between releases.  Patches are cumulative and specific to the release of CM1.  After completing a CM1  or Delivery Tier Server (DTS)installation using the product installer, customers should check the Page for that version on the support portal for any available Patches.   The Current Patch Level section of the Release Download Page will contain the latest Patch available for download.  If no Patch is listed, there is no Patch available for the given release. 

There are 3 files for each Patch download:

Read Me File - This file contains the Patch installation instructions, and a list of the issues addressed included the Patch.

Patch Archive  - This Zip archive contains the Patch itself.

Patch MD5 Checksum - This is an MD5 checksum of the Patch Archive that can be used to optionally verify the patch zip file for file corruption after download.

When installing a Patch, if the Production DTS or Staging DTS is installed in the same directory as Percussion CM1, then all components will be updated when the patch is installed.   If the DTS or Staging DTS is installed in another directory, or on another server (such as the Web Server), then the Patch must be applied to the DTS as well as the CM1 server.

Step by Step Patch Installation Instructions - Windows 

  1. Create the Patch directory if it does not exist <PercussionInstallRoot>\Patch.
  2. Extract <Patch Download File>.zip into<PercussionInstallRoot>\Patch. For example, if Percussion is installed to C:\Percussion,  you would unzip the Patch to C:\Percussion\Patch. This will leave three files: <Patch Number>.zip, InstallToolkit.zip, and the Readme.txt within the Patch directory.  Select Yes to overwrite files if prompted.
  3. Unzip the newly extracted <Patch Number>.zip into the Patch directory. Make sure that when extracting, the extraction path appears as: <PercussionInstallRoot>\Patch\ This avoids nested directories.
  4. Unzip the patch installation toolkit zip into the same directory ensuring the path is: <PercussionRoot>\Patch\InstallToolkit.zip If there is an existing InstallToolkit directory in this directory, you may overwrite it. a. At this point, there should be the two directories: <PercussionInstallRoot>\Patch\InstallToolkit and<PercussionInstallRoot>\Patch\<Patch Version>
  5. Run a command prompt: Start->Run->cmd.exe
  6. Change to the drive that Percussion is installed on.  For example if Percussion is installed on the E drive type "e:" and press the enter key.
  7. Change to the Percussion Patch directory.  For example "cd E:\Percussion\Patch\<PatchVersion>" and press the enter key.
  8. Open the Windows Service Manager and Stop the Percussion Service if it is running.
  9. Verify the Percussion Service shutdown cleanly by right-clicking and the Task Bar and running Task Manager.  On the Processes tab, verify that there are no java.exe processes running in the Percussion installation directory. e.g. e:\Percussion\JRE\bin\java.exe.  If they are still running, select each Java process and click the End Task button.
  10. Once you have confirmed that Percussion is completely shut down, run the patch installation by typing: "install.bat" and pressing the enter key at the Command Prompt. 
  11. During the Patch installation the following warning message will be seen in the console: "Unable to locate tools.jar. Expected to find it in "<PercussionInstallDir>\lib\tools.jar." This message is expected and can be ignored.  The Patch may fail to install if it detects lock files in the Derby database directory, if this occurs, follow the instructions that the patch displays to remove the locks.  The Patch is complete when it displays a Success message. 
  12. Using the Windows Service Manager, start the Percussion Service. 

Step By Step Uninstall of a Patch - Windows

If a Patch introduces an undesired or unexpected behavior in your installation, the Patch can be Uninstalled. 

  1. Run a command prompt: Start->Run->cmd.exe
  2. Change to the drive that Percussion is installed on.  For example if Percussion is installed on the E drive type "e:" and press the enter key.
  3. Change to the Percussion Patch directory.  For example "cd E:\Percussion\Patch\<PatchVersion>" and press the enter key.
  4. Open the Windows Service Manager and Stop the Percussion Service if it is running.
  5. Verify the Percussion Service shutdown cleanly by right-clicking and the Task Bar and running Task Manager.  On the Processes tab, verify that there are no java.exe processes running in the Percussion installation directory. e.g. e:\Percussion\JRE\bin\java.exe.  If they are still running, select each Java process and click the End Task button.
  6. Once you have confirmed that Percussion is completely shut down, run the patch installation by typing: "uninstall.bat" and pressing the enter key at the Command Prompt. 
  7. During the Uninstall the following warning message will be seen in the console: "Unable to locate tools.jar. Expected to find it in {installation root}\lib\tools.jar." This message is expected and can be ignored.  The Patch may fail to install if it detects lock files in the Derby database directory, if this occurs, follow the instructions that the patch displays to remove the locks.  The Patch Uninstall is complete when it displays a Success message. 
  8. Using the Windows Service Manager, start the Percussion Service.