Backup the ServiceControl Data

ServiceControl uses an embedded RavenDB for data storage. To backup or restore the database instance, follow these procedures:

Backup and restore ServiceControl primary or audit instances using RavenDB 5

For ServiceControl instances using RavenDB 5, refer to the official RavenDB documentation on how to perform a backup and restore data.

Backup ServiceControl primary or audit instances using RavenDB 3.5

For ServiceControl instances using RavenDB 3.5, the following steps outline how to perform a data backup:

1. Open ServiceControl Management to view the list of ServiceControl service instances
2. Stop the service using the action icons
3. Click the link under data path to go to the data directory
4. Copy or archive the contents of the data directory
5. Start the service again once the copy is complete

Restore

1. Open ServiceControl Management to view the list of ServiceControl service instances
2. Stop the service from the action icons
3. Click the link under data path to go to the data directory
4. Replace the contents of this directory with the previously copied data
5. Start the service again once the copy is complete

Important notes and restrictions

Care should be taken when planning to move ServiceControl from one server to another. Moving databases between servers can be problematic. The embedded RavenDB does not support moving from a new versions of Windows back to older versions of Windows. See Getting error while restoring backup file in raven DB for more details.

The ServiceControl database should not be restored to older copies of the ServiceControl service. This is not supported as both the database structure and the version on RavenDB may change between versions. These changes aren't always backward compatible.

When restoring a ServiceControl database, the name of the ServiceControl Windows Service must be the same on the target machine as it was on the source machine.