Backing Up the Master Database

Note: The information on this page is applicable to on-premises environments only.

The M-Files master database contains the server login accounts and scheduled backup jobs. For example in case of a hardware failure, the master database can be restored from the backup so that login information and server-specific settings like scheduled backup jobs are not lost.

Complete the following steps to back up the master database:

  1. Open M-Files Admin.
  2. Right-click a connection to M-Files server.
  3. Click Back Up Master Database.
    Result:The Back Up Master Database dialog is opened.
  4. In the Destination section, click ... to browse for the location where you would like to have the backup file placed.
  5. Optional: Click Set Account... to run the task with another account than the Local System account. If the file location is on a network drive that the Local System account cannot get access to, you must set another account. On the Set Account dialog:
    1. Select This account.
    2. In This account, enter the name of the user account.
    3. In Password and Confirm password, enter the password of the user account.
    4. Click OK to close the Set Account dialog.
  6. Optional: Check the Divide to multiple files check box if you want to divide the backup into multiple files of given size.
    Use the File size limit spinner to specify the size of the split backup files.
  7. Optional: Check the Overwrite existing files check box if you want to overwrite any existing backup files in the location you have selected.
  8. Optional: In the Scheduling section, select the Add to scheduled jobs option if you want to specify a recurring schedule for backing up the master database.
    1. Click the ... button.
      Result:The Define Schedule dialog is opened.
    2. Specify the schedule with the available options.
      The schedule option When idle is not supported in M-Files.
    3. Click OK to close the Define Schedule dialog.
  9. Click OK to back up the master database.
The master database backup is stored in the location you have selected.

Restoring the Master Database

Complete the following steps to restore the master database:

  1. Open M-Files Admin.
  2. In the left-side tree view, right-click a connection to M-Files server.
  3. Click Restore Master Database.
    Result:The Restore Master Database dialog is opened.
  4. Click ... to browse for the location of the master database backup file.
  5. Optional: Click Set Account... to run the task with another account than the Local System account. If the file location is on a network drive that the Local System account cannot get access to, you must set another account. On the Set Account dialog:
    1. Select This account.
    2. In This account, enter the name of the user account.
    3. In Password and Confirm password, enter the password of the user account.
    4. Click OK to close the Set Account dialog.
  6. Click OK to restore the master database.
A confirmation message is displayed after the master database has been restored.