Backups

SyncriTab automatically backs up its configuration and data every night. Administrators can also trigger a backup at any time.

What is backed up

Each backup is a single ZIP file that contains a snapshot of the five data folders and the embedded Derby database:

Folder in the ZIP	What it contains
`config/`	Server configuration files, including data source definitions, user accounts, and all settings.
`logs/`	SyncriTab's server log files.
`QueryHistory/`	Each user's recent query history.
`SavedQueries/`	Saved queries and workbooks for all users.
`SavedSessions/`	Saved workspace sessions for all users.
`db/`	A consistent snapshot of the embedded Derby database, which stores user login activity, scheduled tasks, task run history, and login audit records.

A folder is silently skipped if it doesn't exist yet, for example QueryHistory on a fresh installation. The backup still completes successfully.

Backup schedule and retention

SyncriTab runs a backup automatically once a day, around midnight server time. Each backup file is named after the day of the week on which it was created, for example Friday.zip. Because the same file name is reused every week, SyncriTab keeps at most seven backup files — one per day. The previous week's copy for that day is overwritten.

Seven daily backups covering one week is the built-in retention. If you need longer retention, copy the backup folder to a separate location on a schedule of your own, using your operating system's task scheduler or a third-party backup tool.

Where backups are stored

Backup files are written to the Backups folder inside SyncriTab's installation directory by default. A system administrator can redirect them to any path by setting the syncritab.backup.path JVM system property before SyncriTab starts. The folder is created automatically if it doesn't already exist.

Running a backup manually

Administrators can trigger a backup at any time without waiting for midnight:

Open a browser and navigate to your SyncriTab server's address followed by /?operation=a&st=manualBackup. You must be signed in as an Administrator.
SyncriTab runs the backup immediately, using today's weekday name for the file. If today is Wednesday, the backup is written to Backups/Wednesday.zip, overwriting last Wednesday's file.
A JSON response confirms success: {"status":"ok","data":{"message":"Backup completed successfully."},"error":null}. If something goes wrong, the response contains an error code and message.

Only one backup can run at a time. If a nightly backup is already in progress when you trigger a manual one, the manual request returns an error with the code BACKUP_IN_PROGRESS. Wait a few minutes and try again.

Restoring from a backup

Restoration is a manual process that requires direct access to the server's file system. SyncriTab must be stopped before you restore, because the files and database are in use while it runs.

Stop SyncriTab.
Locate the backup file you want to restore, for example Backups/Monday.zip.
Extract the ZIP file. Each top-level folder in the archive (config/, logs/, QueryHistory/, SavedQueries/, SavedSessions/, db/) corresponds to a folder in the installation directory.
Copy the extracted folders over the corresponding folders in the installation directory, replacing the existing contents.
Start SyncriTab.

Restoring overwrites the current data. Any changes made after the backup was taken — new queries, users, sessions, or scheduled task history — will be lost. Make sure you are restoring the right backup file before you proceed.

If something goes wrong

Problem	What to do
The `Backups` folder is empty or the backup file is very small.	Check the SyncriTab server logs for a line containing `BackupService`. An error message there explains what went wrong. Common causes are a full disk and a permissions problem on the backup directory.
The manual backup URL returns `BACKUP_IN_PROGRESS`.	A backup is already running. Wait a few minutes and try again.
The manual backup URL returns `DERBY_BACKUP_FAILED`.	The database snapshot could not be taken. Check that the embedded Derby database is running normally and that there is enough disk space in the system's temporary directory.
The manual backup URL returns a 401 or redirects to the sign-in page.	You are not signed in, or your account doesn't have the Administrator role. Sign in as an Administrator and try again.
The backup ZIP opens but the `config/` or other folders are missing.	The folders may not have existed at the time of the backup (normal on a new installation) or the backup path was misconfigured. Verify the `syncritab.backup.path` setting and check the server logs.