Backup and Restore FAQ

From CommitCRM-Wiki
Jump to: navigation, search
FAQ > Backup and Restore FAQ


How can I backup my data within the CommitCRM system?

When using the CommitCRM system, users can perform a partial backup, which backs up the CommitCRM database only, or a full backup, which saves the entire CommitCRM system.

CommitCRM comes with a special utility to back up the CommitCRM databases (providing a partial-backup which saves the the database only). To access this backup utility, go to Tools > Backup menu, and follow the steps. This process will back up the database files that are located in the <server>\CommitCRM\Db and <server>\CommitCRM\DbSys folders.

Note: This backup creates a zip file in the <server>\CommitCRM\Utils folder that contains CommitCRM-specific files only. It does not back up your linked documents, which should be backed up separately.

We also recommend that users occasionally perform a full backup, which saves the entire CommitCRM server folder and all its subfolders. This type of backup must be done using external tools. A full backup will enable you to restore the files much faster should you need to do so in an emergency situation.

It is recommended to copy the backup file to another hard disk, computer, or media.

Can I backup CommitCRM using external tools?

Yes. It is recommended to back up the entire CommitCRM server folder and all its subfolders on occasion. This will enable you to restore the files much faster should you need to do so. Any backup utility/program should work, such as the standard tape backup, zip, rar, etc.

Note: Make sure that no one is using CommitCRM during a full backup.

Is there a way to perform a live backup (Backup your data while the system is in use)

Yes, CommitCRM comes with a Live Backup option, when using SQL Database for CommitCRM.

When using the Live Backup, there is no need to stop users and services from working while performing a backup. Everyone can continue working as usual while the backup is performed in the background.

Note that the Live Backup requires SQL Database.

To perform a live backup administrators should run the \CommitCRM\Utils\CommitBackup.exe with a special parameter which tells the system to perform a live backup.

In order to fully automate Live Backups you should use Windows Task Scheduler procedure and add a recurring Task that runs the backup utility.

For more details and instructions, refer to \CommitCRM\Utils\CommitBackup.ini

Important: Live back does not come instead of other backup methods. You still need to backup your CommitCRM system as you have so far.

Which folders should be backed up?

Back up all folders under <server>\CommitCRM. The most important folders are called “CommitCRM\Db” and “CommitCRM\DbSys,” which is where all CommitCRM-specific data is stored. You should also back up all your documents.

How do I restore a backup?

You can restore the CommitCRM system using the partial-backup files (database only) or the full-backup files.

To restore the full system using full-backup files:
To restore from a full backup (i.e. a backup file which includes the CommitCRM installation folder and all sub-folders), please follow these instructions. This includes restoring the files and installing any services if they were used.

CommitCRM will now be ready for use at the exact point when the backup was done.

To restore the full system using a partial-backup (database-only) files:

  1. Download and install a fresh trial version of CommitCRM. Make sure to use the exact same version as you have been using until now, otherwise there will be version mismatch when restoring the database.
  2. Install it to the original path where CommitCRM was installed on your server originally.
  3. Run the CommitCRM application once (use any user as this is a fresh setup)
  4. Close the CommitCRM session.
  5. Rename the <server>\CommitCRM\Db folder to <server>\CommitCRM\Db-Not-In-Use.
  6. Rename the <server>\CommitCRM\DbSys folder to <server>\CommitCRM\DbSys-Not-In-Use.
  7. From the backup, copy the \CommitCRM\Db and \CommitCRM\DbSys folders to <server>\CommitCRM\Db and <server>\CommitCRM\DbSys.

CommitCRM will now be ready for use at the exact point when the backup was done.

To restore from a backup only in order to revert changes in the database:
Should you need to restore a backup to revert changes, your current CommitCRM installation can still be used. You just need to replace the database files.

To restore a partial backup:

  1. Rename the <server>\CommitCRM\Db folder to Db-Not-In-Use.
  2. Rename the <server>\CommitCRM\DbSys folder to DbSys-Not-In-Use.
  3. From the backup-file, copy the Db and DbSys folders to <server>\CommitCRM\Db and <server>\CommitCRM\DbSys.

CommitCRM will now be ready for use at the exact point when the backup was done.

I've just restored CommitCRM onto a new computer, and the client gives me an error when I log in; What am I doing wrong?

Procedure halted due to data server error.
Verify server is operating and this computer has access to the server folder.

When restoring CommitCRM onto a new computer from a backup archive, the next step is to verify that the path in the error message exists, and has the database files in it and test a single CommitCRM client application from the server that CommitCRM is installed on. If running the client from the server itself produces an error report like the error above, then the issue may very well be caused by not installing the CommitCRM SQL Database.

If your system is licensed for the CommitCRM SQL Database, then follow the steps in the CommitCRM SQL Database installation page, and then continue to the this Troubleshooter to resolve it.