You have to back up the configuration data on the engineering server at regular intervals or after a configuration change. The recommended interval is at least once a week. Furthermore, the data on the runtime server and on the OIS server must be backed up, too.

You can also use a VMware snapshot for the data backup for the runtime, engineering and OIS server, if VMware is installed. Furthermore, the data on the runtime server must be backed up, too.

The data backup concept does not support data migration. Data that was backed up can be reimported only with the same version from which the backup was made. Check the release number.

Backing Up Data

The call parameters are:

sc backup [file name or path] [database name]

Default for [file name or path] is /backups.

Default for [database name] is viewpoint.

The default backup file name is generated from the hostname and the current time stamp.

  • You are logged in as user root.
  1. Open a console window.
  1. Enter the following command to back up the data:
    vagrant@engineering:~$ sc backup
  • The following is displayed (example):
    Backing up database into /backups/scrt252-RUNTIME-2.7.999.15421078.82667716-20220720-100508-UTC.tar...
  • If you specify a path, it must be ensured that this path exists and that you have the necessary access rights.
  • If you specify a file name with path, the backup is performed in the path and with the specified file name.
  • If you specify only a file name, the backup is performed in the path /backups with the specified file name.
  • If you specify only a path name, the backup is performed in the path with the generated file name.
  • A backup is created for the selected site, for example /backups/scrt252-RUNTIME-2.7.999.15421078.82667716-20220720-100508-UTC.tar.
  1. Export this file to an external storage to ensure that the data is not lost.

Backing Up Data on the Engineering Client

  • You are logged on to the Siveillance Control engineering client.
  • The path to back up configuration data has been defined. For more information refer to: Configuring Server Settings.
  • In the menu bar, select Tools > Create Data Backup.
  • The data backup is created, and a confirmation message is displayed in the info line.
  • The data backup file is saved to the directory you specified.
  • In the operator log, an entry is logged about the start and finish of the data backup creation.

Backing Up User Data from the Runtime Server

The runtime server supports backing up of user data that includes user groups, user names, user preferences and passwords.

The command name is sc backupUsers.

The default backup directory is /backups.

The default backup file name is generated as backup-users_[site type]_[version number].tar.gz, for example backup-users_RUNTIME_3.2.0_20240216083456.tar.gz.

  • You are logged in as user root.
  1. Open a console window.
  1. Enter the following command to back up the data:
    vagrant@runtime:~$ sc backupUsers
  • A backup is created for the selected site with the required data, for example
    /backups/backup-users_RUNTIME_3.2.0_20240216083456.tar.gz.
  1. Export this file to an external storage to ensure that the data is not lost.

Restoring Data

The backed-up configuration data can be reimported only with the same Siveillance Control product version. If the product version was updated, which involves a change of the release number (for example from MP1.3 to MP1.3.3 or from MP1.4 to MP 2.1), the backed-up configuration data cannot be imported again.

The command name is: sc restore file name

  • You are logged in as user root.
  1. Open a console window.
  1. To restore data using a backup file, complete the following steps:
  • Enter the following command (example):
    viewpoint@scrt252:/backups$ sc restore scrt252-RUNTIME-2.7.999.15421078.82667716-20220720-100508-UTC.tar.gz
  • The following is displayed (example):
    CREATE ROLE
    Restoring database backup from scrt252-RUNTIME-2.7.999.15421078.82667716-20220720-100508-UTC.tar.gz into database viewpoint...
    unzipped backup from scrt252-RUNTIME-2.7.999.15421078.82667716-20220720-100508-UTC.tar is found and restore was successful
  • The server stops automatically
  • The database is imported and existing data is overwritten.
  • The server is restarted.

Restoring User Data in the Runtime Server

Restoring user data is only possible with a newly created empty runtime site. The backed-up user data can be re-imported only with the same Siveillance Control product version. If the product version was updated, which involves a change of the release number (for example from MP 3.2.0 to MP 3.2.1 or from MP 3.2 to MP 3.3), the backed-up user data cannot be imported again.

The command name is: sc restoreUsers [File name with path]

  • A new runtime site is created.
  • You are logged in as user root.
  • The backup file is available in the machine where the user data needs to be restored.
  1. Open a console window.
  1. To restore user data using a backup file, enter the following command (example):
    root@runtime:/home/vagrant# sc restoreUsers /backups/backup-users_RUNTIME_3.2.0_20240216083456.tar.gz.
  • The server stops automatically.
  • The user groups, usernames, passwords, and user preferences are restored, and the server is restarted.