How do I install an Entuity patch?

Important note for changes to EMS projects

To install an Entuity patch

Entuity releases maintenance patches for software updates. The process to use when installing a new patch is different to the process of installing Entuity.

A patch may deliver fixes to issues, improved performance and new features. Entuity recommends that you read the notes for each patch before starting the installation procedure.

Important note for changes to EMS projects:

If a patch makes changes to the Entuity Event Management System (for example, by introducing new events and incidents), then these new changes will only become available if you merge the new default EMS project with your own live EMS project. Please see this article for further help and information on merging EMS projects.

To install an Entuity patch:

1. Check the current Entuity version and patch level:
   1. In the Main Menu, click System Information.
   2. In the Version column of the table, a version number ending with a '(PXX)' indicates a patch has been applied, e.g. 'Entuity 19.0 (P02)' indicates that 2 patches have been applied. A version number without a '(PXX)' indicates no patch has been applied, e.g. 'Entuity 19.0'.
2. Download the patch file to a temporary location:
   1. Navigate to the secure Entuity FTP server at ftp.entuity.com. Access to the Entuity FTP site requires a valid username and password that can be obtained from Entuity Support. For added security, the FTP site requires connection via SFTP.
   2. Navigate to the required patch. Patches are stored by Entuity release, e.g. /Patches/19.0.
   3. Download the patch to a temporary folder.
   4. You can use a command line utility to check the integrity of the image by validating the checksum:
      
      • For Windows, use the command line utility 'certutil', which can generate either SHA1 or MD5:
        • To generate an SHA1 checksum, use the following syntax: certutil -hashfile <file>
        • To generate an MD5 checksum, use the following syntax: certutil -hashfile <file> MD5
      • For Linux, use the command line utility 'md5sum'. Use the following syntax to generate an MD5 checksum: certutil -hashfile <file> MD5
3. Stop the Entuity server and take a full backup of the entire Entuity installation. If the patch installation fails, you can restore this entire installation backup.
   
   IMPORTANT: If you are attempting to install patch ENA v17.0 P01, you will first need to copy the install.cfg file provided alongside this patch, into the following directory:
   <Entuity_home>\etc
   
   You will not need to do this for patch P02 or later.
4. Install the patch using the patch installer:
   1. On the command line on the Entuity server, run entuity_home\install\installPatch on the downloaded patch.
      • e.g. with a Windows patch downloaded to the temporary folder c:\temp, enter installPatch c:\temp\ENTUITY_13_5.P02.WinNT.patch.
5. After installing the patch, run configure. The patch is only applied once configure successfully completes.
6. Restart the Entuity server.