Backup properties
Below is a list of backup properties and their functions. These properties are located in the spectrum-container.properties file.
General backup properties
| Property | Description | |
|---|---|---|
| spectrum.backup.enabled | Enable or disable all system backups | |
| spectrum.backup.cron | Quartz cron configuration for scheduled backups: For more information on the cron configuration, visit https://freeformatter.com/cron-expression-generator-quartz.html. |
Configuration database backup properties
The following properties in the spectrum-container.properties file must be changed when running a database backup in a separated configuration database environment.
| Property | Description | |
|---|---|---|
| spectrum.backup.repository.enabled | Enable or disable the backup of the configuration database, specifically: Overrides the general enabled flag (spectrum.backup.enabled). To enable, uncomment the property and set the value to True. | |
| spectrum.backup.repository.databaseURL | URL/Host of the machine where Neo4j repository runs; Do not modify unless Neo4j is running on a different machine than the server | |
| spectrum.backup.repository.directory | Directory where Neo4j backup files are stored. By default, this location is ../server/backup/repository. In clustered setups, we suggest that you point this directory to a network share location. This location has changed from the default location in previous releases, which was ../server/app/repository/store/backup. |
Index backup properties
| Property | Description | |
|---|---|---|
| spectrum.backup.index.enabled | Enable or disable the backup of the Search Index index repository, specifically: Overrides the general enabled flag (spectrum.backup.enabled) | |
| spectrum.backup.index.directory | Directory where backup files are stored: By default, this location is ../server/backup/index. IMPORTANT: In a clustered environment, this property must point to a network share location. |
To restore an Elasticsearch snapshot, invoke the restoreSnapshot operation using the Index Snapshot/Backup Manager in the JMX Console:
MBean: com.pb.spectrum.platform.common:manager=IndexSnapshotManager