Prerequisites

• Review all system requirements thoroughly
• Download required software:
  • Latest Zephyr Enterprise version 5.X installation file
• If your Zephyr server has SSL setup, backup these files:
  • server.xml (%Zephyr_Home%/tomcat/conf)
  • setenv.sh (%Zephyr_Home%/tomcat/bin)
  • You will replace these files with your backup once the upgrade is complete
• Backup any file that has been manually customized after the original Zephyr installation. These files will be overwritten during the upgrade process.

It is recommend that you read the entire upgrade instruction set prior to beginning the upgrade process. If you have any questions, please contact our Technical Support team. The time taken to complete the upgrade mode process is mainly dependent on the size of your instance data.

The process of upgrading your Zephyr On-Premise instance consists of four parts:

1. Create a full backup with attachments. This will not be used in the upgrade process but to revert back to if any issues arise.
2. Stop the Zephyr server
3. Run the setup file as administrator and select the 'Upgrade' mode
4. Run the installer setup to completion

Backup and Verifying Data

Step 1: Create a full backup with attachments

Open a command line and run:

• backupAll.sh <backup_directory> Y
• Store the backup file that is created in a safe location
• Stop the Zephyr server to ensure no new data is created during the upgrade process

Step 2: Launch the Setup utility as you would normally (./zephyr_5_0_14587_linux_setup.sh), select Upgrade and hit Next.

Step 3: Identify location of the current Zephyr installation location and hit Next.

Step 4: The upgrade process will start by uninstalling the current version of Zephyr. This can take several minutes.

Step 5: After the current version of Zephyr is uninstalled, you will be asked to give a location to install the new version of Zephyr Enterprise. This can be the same as the old location or a new location. Once you have entered an installation location, hit Next.

Step 6: Wait for the installation to complete. This can take several minutes.

Step 7: Once the installation is finished, the upgrade will be complete. Your users can now use Zephyr again as normal with the new features, enhancements, and bug fixes that come with the newest version of Zephyr Enterprise.

Step 8: Stop the server and replace any manually customized files that were backed-up before upgrading. You can start the server again after the files have been replace. Ignore this step if you did not back-up any files.

Post Upgrade Tasks:

Client-side Notes:

When upgrading to the latest Zephyr Enterprise version 5.X, each client browser should clear their browser cache and cookies and perform a hard refresh of Zephyr by using Ctrl+F5 in your browser. This will ensure a smooth transition to the newest version. Internet Explorer is especially sensitive to history settings.

Automation Notes:

If your company has utilized automation integration with ZBots, you will need to download and install 5.0 ZBots. These can be accessed via the Zephyr Client Logon Screen by clicking on the ZBot image. If you use a custom ZIP with your ZBot, this ZIP may need to be recompiled with the latest Zephyr API library (found in the ZBot 5.0 directory).

Index Notes:

After upgrading, please re-index your database so that the search functionality will perform as expected. To do so, log in as the test manager, navigate to the Department area, click on the Administration Module, select the Customization Tab and click on the Re-Index button. Note this should be done during a low-use time period as it is a resource intensive process.

Back to Top ^