Prerequisites

• Review all system requirements thoroughly
• Download required software:
  • Zephyr version 5.0 (Build 14587) installation file
  • Zephyr Upgrader Utility
• 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 Zephyr 4.7+ backup, but shouldn’t take more than 3 hours to complete.

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

1. Create a full backup with attachments
2. Verify that the backup file can be migrated to version 5.0 (build 14587)
3. Uninstall the current version of Zephyr Enterprise and install Zephyr Enterprise Server version 5.0
4. Upgrade then restore the 4.7+ backup file to 5.0 (build 14587)

Backup and Verifying Data

Step 1: Create a full backup with attachments

Open a command line and run:

• backupAll.bat Y
• Store the backup file that is created with the above command where the upgrade utility is located
• Any work done in Zephyr after this backup is made WILL NOT be migrated to the new Zephyr Enterprise 5.0 instance
   

Step 2: Launch the Upgrade Utility (Run as Administrator for Windows 7/8/10 or Windows 2008/2012)

 Step 3: Identify location of the backup file.

Step 4: Upgrade utility confirms installation location of Zephyr (during the verification process, no actual upgrade will occur) 

Step 5: Select “Check Mode” to ensure the integrity of the backup file 

Step 6: Click “Next” to begin verification 

Once verification is completed, the following dialog box is displayed identifying either a successful or un- successful verification of the backup files. If unsuccessful, view the logs, identify and address the issue or contact Zephyr Support for assistance. 

Installing Zephyr Enterprise Server 5.0

• Uninstall current version of Zephyr using uninstall.exe
• Install Zephyr Enterprise Server 5.0 (Build 14587) using the instruction found here

Upgrading and Restoring the Backup file

• Launch the Upgrader as Administrator. Once the Upgrader is launched, follow steps 2 through 4 above.
• Select “Upgrade Mode” in Select Mode dialog box to run the upgrade utility 

Click Next to begin upgrade. 

The upgrade process will complete a series of steps to migrate your Zephyr 4.7+ data to Zephyr Enterprise Server 5.0 (Build 14587). Once completed, the following dialog box will be displayed. The time taken to complete the data migration will be dependent on the size of your Zephyr 4.7+ data set and could be as short as a few minutes to as long as a few hours. 

At the end of upgrade, the results summary will be returned including the time it took for each of the above processes to complete. You may now use your new Zephyr Enterprise 5.0 instance after following the below 'Post Server Upgrade Tasks'. If any issues arise based on the verification check, please reach out to Technical Support.

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 ^