How do I install an Entuity patch?

Prepare for patch install

Installing an Entuity patch for Entuity v23.0 P01 upwards

To install an Entuity patch on Windows

To install an Entuity patch on Linux

Installing an Entuity patch for earlier versions of Entuity

Merging the default EMS project with your live EMS project

To check if the newly installed patch made changes to the EMS

To merge the new default EMS project with your live EMS project

Entuity releases maintenance patches for software updates. A patch might deliver fixes to issues, improved performance, and new features. Entuity recommends that you read the release notes for each patch before starting the patch installation procedure.

Follow these general steps to install a new patch:

1. Prepare for patch install.
2. Install the patch.
3. Check if the newly installed patch made changes to the Event Management System (EMS).
4. If so, merge the new default EMS project with your live EMS project. 

Prepare for patch install:

1. From the Main Menu, click System Information and review the Version column of the table to check the current Entuity version and patch level. 
   A version number ending with a '(PXX)' indicates a patch has been applied, while a version number without a '(PXX)' indicates no patch has been applied.
   For example, 'Entuity 22.0 (P02)' indicates that patch 02 is applied, while 'Entuity 22.0' indicates no patch is applied and that Entuity is running the GA version.
2. Contact Entuity support to obtain a valid username and password for the secure Entuity FTP site.
3. Using SFTP, navigate to the secure Entuity FTP site, and enter the username and password. 
4. Open the Patches folder and then open the folder of the targeted major version.
5. Download the Entuity image (Entuity v23 P01 upwards) or patch (Entuity v22 or earlier) to a temporary folder.
6. If you downloaded a patch, skip to the next step. Otherwise, if you downloaded an image, use the certutil command-line interface (CLI) utility to check the integrity of the image by validating the checksum.
   • For Windows, the certutil CLI can generate either a SHA1 or MD5 checksum:
     • To generate a SHA1 checksum: certutil -hashfile <file>
     • To generate an MD5 checksum: certutil -hashfile <file> MD5
   • For Linux, the certutil CLI can generate an MD5 checksum:
     • To generate an MD5 checksum: certutil -hashfile <file> MD5
7. Stop the Entuity server and make a full backup of your Entuity installation. 
   If the patch installation fails, for any reason, you can restore to this installation backup.

Installing an Entuity patch for Entuity v23.0 P01 upwards

For Entuity v23.0 P01 upwards, there is no longer an installPatch utility. Instead, each patch is a complete ISO image, and the process to install a patch is the same as the process to install or upgrade to a new Entuity version. Because of this, you no longer need to install patches in the order that the patches are issued, and Entuity supplies the supported upgrade paths in patch notifications for each patch release.

Complete one of the following procedures, based on the operating system of your Entuity server.

To install an Entuity patch on Windows:

1. Decompress the downloaded image.
   Note, when decompressing the image on Windows, WinZip offers to unzip the ISO file contained in the zip file. Do not unpack the ISO file.
2. Mount the decompressed image as a virtual drive on your system.
3. Using Windows Explorer, navigate to the mounted image, and double-click install.exe.
   Note, you must run the installer as administrator.
   This opens a welcome message. The next page asks you to agree to the Entuity terms and conditions.
4. On the following page, select the same location as your previous installation directory.
   If a different directory is selected, it will be treated as a new install of Entuity.
5. On the following page, click Install.
6. After installing the patch, run configure, as the patch is only applied once configure successfully completes.
7. Restart the Entuity server.

To install an Entuity patch on Linux:

1. Navigate to the compressed image. 

   cd /[directory_path]

2. Decompress the image. 

   zcat ./entuity_23_0_P01_red.iso.gz > /tmp/Entuity.iso

3. Create a mount point. 

   mkdir /mnt/EntuityInstaller

4. Mount the image. 

   mount -o loop /tmp/Entuity.iso /mnt/EntuityInstaller

5. Run the installer. 
   Note, the installer must be run as root or using sudo as a regular user. For more information about installing Entuity on Linux, see this article. 

   /mnt/EntuityInstaller/install

6. Accept the terms and conditions with yes or y.
7. Ensure to select the same install directory as your previous install of Entuity. 
   If a different directory is selected, it will be treated as a new install of Entuity. 
   Note, it is important to use an absolute path, not a relative path. This means that every path must start at the root, starting with /.

8. After installing the patch, run configure, as the patch is only applied after configure successfully completes. 
   On Linux, configure runs from the command line, and so responses need to be typed out, and absolute paths must be provided, where applicable. For more information about configuring Entuity on Linux, see this article.

   /[install_path]/install/configure

9. Restart Entuity.

   /[install_path]/bin/starteye

Installing an Entuity patch for earlier versions of Entuity

For Entuity v22.0 and earlier, the process to install a new patch is different from the process to install Entuity. Because a patch might depend on changes delivered in an earlier patch, you must install patches in the order that they are issued. 

To install an Entuity patch for Entuity v22.0 or earlier:

1. From the command line of the Entuity server, run the entuity_home\install\installPatch utility on the downloaded patch.
   For example, with a Windows patch downloaded to the temporary folder c:\temp, enter installPatch c:\temp\ENTUITY_22.0.P02.WinNT.patch.
2. After installing the patch, run configure, as the patch is only applied after configure successfully completes. For more information about configure, see this article.
3. Restart the Entuity server.

Merging the default EMS project with your live EMS project

If a newly installed patch makes changes to the EMS (for example, by introducing new events and incidents), then these changes only become available after you either deploy the new default EMS project, or after you merge the new default EMS project with your current live EMS project. Entuity recommends merging the new default EMS project, as this lets you access the newly installed features and also lets you retain the customizations of your current live EMS project. 

Note, only users belonging to a user group with the Event Administration permission can merge event projects and perform the deployment of projects.

To check if a newly installed patch has made changes to the EMS:

1. From Entuity, go to the Main Menu, and then click Administration. 
   The Administration page is displayed.
2. Click Event Administration, and from the Event Administration page that is displayed, click View all projects in the top-left.
   The Project History page is displayed. 
3. Review the event projects that are listed on the Project History page.
   If you see a new Upgrade: new version entry in the list of event projects, then the patch has made changes to the EMS. Skip to the next procedure to merge the new default EMS project with your live EMS project. Otherwise, if you don't see a new default EMS project listed, then the patch didn't make changes to the EMS, and no further action is required.

To merge the new default EMS project with your live EMS project:

1. On the Project History page, select both the new Upgrade: new version project and your current live EMS project.
2. Click Merge and select your current live EMS project as the base project.
3. View the changes from the newly installed patch by clicking the Merge Details tab on the Event Administration page that is displayed. 
4. Follow the instructions in this article to select the new and updated components in the Upgrade: new version project to be included in your current live EMS project, and then click Save and deploy.