Zephyr Server/Data Center Backups and Restore

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-administration-guides/zephyr-server-data-center-backups-and-restore.html

There are currently two objects that can be backed up:

ObjectDescription/Info
DataTypically backed up and stored in a tar.gz file
AttachmentsBy default, these are not stored in the tar.gz file but are on the filesystem under <zephyr_install_dir>/zephyrdata


Please ensure you are logged into the machine on which Zephyr Server is installed to access attachment backup/restore processes. You will need to be logged into your database server to backup the database data separately. Attachment script files must be run with appropriate permissions.

It is highly recommended that you consistently backup your Zephyr Attachments and Database.

Backup & Restore


Additional Note

Linux users note that all utilities must be run as root. Use the sudo command for root permission.

The following steps will need to be followed to Backup, Restore and Schedule your database and attachments:

Step 1: Database Backup

Step 2: Database Restore

Step 3: Scheduling

Step 1: Database Backup

Backup: Instructions take a native backup from the database with out attachment

MySQL

mysqldump -u [uname] -p[pass] db_name > db_backup.sql

Example: mysqldump -u itcc -itcc_backup itcc > itcc_backup.sql

mysqldump -u itcc -itcc_backup dversion > dversion_backup.sql


Oracle

exp ITCC/ITCC_password file=itcc_backup.dmp

Please check Oracle standard schema documentation restore steps for your database version.


MSSQL

Please contact your DBA for instructions or follow the steps mentioned

in the link below for backup

https://technet.microsoft.com/en-us/library/ms187510(v=sql.105).aspx

 

Step 2: Database Restore

Restore: Instructions to Restore the native backup

MySQL

mysql -u [uname] -p[pass] db_name < db_backupfile.sql

Example:

mysql -u root -proot itcc < itcc_backupfile.sql


Oracle

Please check Oracle standard schema documentation restore steps for your database version.


MSSQL

Please contact your DBA for instructions or follow the steps mentioned

in the link below for restore and backup

https://technet.microsoft.com/en-us/library/ms188312(v=sql.105).aspx

Step 3: Scheduling

The sheduling utility that only backs-up the database without backing-up the repository and trend data. Use this utility only if instructed by Zephyr support.

Usage:

schedule.bat [db name] [db username] [db password]

[output file name and path] [zephyr installation path]


Example:

schedule.bat ITCC root root

C:\mybackup\partial-db-backup.sql  C:\Software\Zephyr\