Backup

This backup feature works only with H2 and Apache Derby. If you use another database, use that database's backup features. You can change the time in the Scheduler.

ManualWorks backs up the database as follows. You can see the backup history in the <Admin | Servers | Backup> menu.

For security, ManualWorks does not let you download backup files. Download them with tools provided by the server where ManualWorks is installed, such as FTP.

H2

Every day at 4:00 a.m., the entire database is backed up to a daily_yyyy-MM-dd.zip file.
By default, the three most recent backup files are kept. You can set the number of backup files to keep with the following command in the Console.

set-preference -name BACKUP_KEEP_COUNT -value 5

Apache Derby

Every Sunday at 4:00 a.m., the entire database is backed up to a base_yyyy-MM-dd.jar file. After the full backup, the previous backup files are deleted.
On other days, the changes of the day are backed up to a daily_yyyy-MM-dd.jar file at 4:00 a.m.

Restore

Restore the ManualWorks database as follows.

This restore feature works only with H2 and Apache Derby. If you use another database, use that database's restore features.

H2

First, check the 1location of the backup file to restore in the <Admin | Servers | Backup> menu.

Check the location of the database directory with the 2following command in the Console.

get-preference -name DB_DIR

If a relative path is shown, the database files are in the 3RABBITZ_HOME/data/h2 directory.

Restore as follows.

Stop ManualWorks.
In case something goes wrong during the restore, copy and keep all files in the ManualWorks installation directory.
Go to the database directory you checked above.
Back up the database.mv.db file by copying it to another location.
Extract the most recent backup file (the daily_yyyy-MM-dd.zip with the latest date) into the database directory.
Create an empty file named restore in the ManualWorks installation directory.
Start ManualWorks.
When you access ManualWorks with a web browser, the restore screen appears. Click the <Start> button to restore the data.

The restore applies the change log recorded after the extracted backup. Older change logs are deleted when a new backup is created, so if you extract an older backup, the changes between that backup and the most recent backup are lost. If you click <Start> without extracting a backup, the change log is applied again to the current database. The restore screen shows which backup file to extract.

H2 restore works in this order starting with ManualWorks 6.0.26. In earlier versions, clicking <Start> with an extracted backup might be blocked with a message that data already exists.

Apache Derby

Stop ManualWorks.
In case something goes wrong during the restore, copy and keep all files in the ManualWorks installation directory.
Create an empty file named restore in the ManualWorks installation directory.
Start ManualWorks.
When you access ManualWorks with a web browser, the restore screen appears. Click the <Start> button to restore the data.

If you select the "Include File Restore" option on the restore screen, the upload directory in the backup directory is copied to the upload directory in the data directory.

If the restore succeeds, delete the archive files created during the restore. The previous data is kept under the following names during the restore.

Database files: database_2025-03-03t11-45-51.777
Image files: upload_2025-03-03t11-45-51.777

With the default installation, the ManualWorks data directory is 3RABBITZ_HOME/data.