This guide is intended to help users back up and restore ScrumWorks Pro data.
By default ScrumWorks Pro ships with Hypersonic, an embedded database. Please
see our
Support Resources to report problems or questions about the backup process.
Hypersonic - Manual Data Backup
ScrumWorks Pro data may be backed up by the Global Administrator user manually
from within the Desktop Client:
-
Log in as the Global Administrator user.
-
From the "File" menu, select "Create Backup"
-
ScrumWorks Pro will create a backup of your data and will place it in the directory:
INSTALLDIR/server/scrumworks/data/hypersonic/backup-yyyy-mm-dd
NOTE: Attachments are NOT included in this backup process. You must manually copy the
attachments directory to your backup location.
-
To backup the attachments, copy the following directory to your backup location:
INSTALLDIR/server/scrumworks/data/attachments
-
For instructions on restoring a backup, please see the restore section.
Note: During the brief duration of the
actual backup, the desktop client will not be available to Desktop
Client users. This is momentary and users are notified of the outage.
No action is required by the Global Administrator to resume normal operation
afterwards.
Only the Global Administrator can back up the ScrumWorks Pro data via the Desktop client.
Hypersonic - Automated Data Backup
Automated data backups can be done in one of two ways:
-
Running the
INSTALLDIR/utils/ScrumWorks-backup.jar file on the server running ScrumWorks Pro.
cd INSTALLDIR/utils
java -jar ScrumWorks-backup.jar
If you changed the port or protocol (http/https) ScrumWorks Pro runs on, you can append the parameters to the above command line.
- The ScrumWorks Pro server provides a URL for the sole purpose of performing automated
backups:
http://localhost:8080/scrumworks/BC
To prevent abuse, the URL will only accept requests from the local host (i.e.,
localhost/127.0.0.1).
For example, wget (or a similar utility) can be scheduled to contact the URL periodically:
wget http://localhost:8080/scrumworks/BC.
If the backup is successful, the server will return a message providing the
location of the backup.
The location will be of the format
INSTALLDIR/server/scrumworks/data/hypersonic/backup-yyyy-mm-dd.
This backup does not include attachments. You will need to manually backup the attachments by
copying the following directory to your backup location:
INSTALLDIR/server/scrumworks/data/attachments
Hypersonic - Restore from Backup
To restore the ScrumWorks Pro database:
- Make sure the ScrumWorks Pro Server is stopped.
- Copy the files from your backup location to
INSTALLDIR\server\scrumworks\data\hypersonic
- Copy the attachments directory to
INSTALLDIR\server\scrumworks\data\
- Start the ScrumWorks Pro Server again and confirm your data restoration.
Please check our
Support
Resources for additional help with the backup process.
MySQL - Data Backup and Restoration
The ScrumWorks Pro server will not automatically create backups of your MySQL database
or your attachments. Attachments are stored on the ScrumWorks Pro server's file system, not in the MySQL database. While most data will be handled by the MySQL backup process, attachments must be manually backed up following the process below.
Data Backup
- Shut down your ScrumWorks Pro server
-
Backup the attachments by copying the following directory to your backup location:
INSTALLDIR/server/scrumworks/data/attachments
- Follow the instructions listed in the
Backup and Recovery
section of the MySQL manual.
NOTE: The "hot copy" method of backing up the database will not work.
- Start your ScrumWorks Pro server
Data Restoration
- Shut down your ScrumWorks Pro server
- Copy the attachments directory to
INSTALLDIR\server\scrumworks\data\
- Follow the instructions listed in the
Backup and Recovery
section of the MySQL manual.
- Start your ScrumWorks Pro server
Note: Your ScrumWorks Pro license does not provide for MySQL backup or related MySQL support.
Contact MySQL directly for support options.