Backing up and restoring Semaphore

This section describes methods that can be used to back-up and restore a Semaphore installation. Please note that it is very important that regular back-ups be put in place to ensure that the system data is protected in case of accidental deletion or system failure.

Backing up Semaphore

An initial back-up of all installations is recommended including:

• All files/subdirectories under “C:\Program Files\Smartlogic” or wherever the product has been installed
• All files/sub-directories within the “Semaphore Workbench Home” folder structure
• All files/subdirectories in which Semaphore data is stored (these directories are set during the installation process in the configuration files) but generally as follows:

Incremental backups should be regularly performed on all of the above directories.

Backing up model data

The model contains the most critical element of the Semaphore installation. All data used by any Semaphore implementation can be regenerated using the information stored in the model, therefore, it is critical that this information be regularly backed-up.

For the “Knowledge Model Management” component of “Semaphore Studio” there is both model data and associated model-based (publisher) configuration as well as custom modifications that may have been made for the installation. A backup of all of this information (data and configuration) can be performed within “Knowledge Model Management” when using a user assigned the “SemaphoreSuperAdministrators” role using the “Backup Models” option from the “Tools” menu:

This the preferred method for backing up, however, if you wish to automate this or perform this operation from the operating system you can use the following methods of backing up both data and configuration:

• Models - The “kmm-backup” tool can be used (see Backing up and restoring Semaphore for details) to backup the models. This process can backup all model data including model history. If you want to backup a specific model without any model history you can use the “Export” function in “Knowledge Model Management” (or via the API). Depending on where the model information is stored you can also do the following to backup model and any history:
  • Jena TDB (the default location for model data) - If you take a copy of the entire “Semaphore Workbench Home” directory structure this will contain the model data as well (in the “workspace/SemaphoreData” sub-folder). Note that you should ONLY copy this data when the “Knowledge Model Management” service has been stopped as the application could have model data in memory while it is running (restarting the service after the copy is complete).
  • MarkLogic - You can use the standard MarkLogic database backup tools to backup the model data in whichever database(s) are configured.
• Model Configuration - This data is stored in the “Semaphore Workbench Home” directory so to backup simply copy this directory structure after first stopping the “Knowledge Model Management” service (restarting after complete).

Fully restoring a Semaphore installation

If a full system restoration is required the preferred option is to use the original application installers as this will correctly install the applications and relevant services. Individual configuration files can be restored from the any back-up made of the installation.

Though not recommended, another option is to restore a back-up made of the server files onto the new server (though it should be noted that individual Windows services would need to be manually installed). To manually restore from a back-up of all installation directories, do the following:

• Restore all files to their original locations
• Manually, re-install (then start) each of the Windows services required on the server - This can be done using tools such as the “nssm” utility (found in the “<Studio Installation Directory>\bin” directory).
• Restore all models - If you have used “Backup Models” from the KMM “Tools” menu use the “Restore Models” option to restore them.