Exporting from and Importing into the Knowledge Model Management Application

Creating a backup

In Knowledge Model Management (KMM) open the Tools menu and select “Backup Models”. Select which models’ data you want to be stored in the backup or choose “Select all models”. If the model which you chose contains links to other models then those models will be automatically selected as well – note, this only includes models visible in KMM, and it does not include the Semaphore core models; these are considered part of the configuration files. Press the “Download” button. The backup file will be downloaded by your browser. It will also download a corresponding *.md5 file containing an MD5 checksum for the backup file. You can use this file to verify the integrity of the downloaded backup file. The backup will contain data from the selected model(s), with all tasks and recorded history. It will also contain all configuration files from your workspace. This includes:

• Description of users defined in the system
• Custom “TTL” files with user defined edit rules and spin constraints, and shacl shapes
• Publisher’s configuration files (if Publisher is installed on the server)
• Spreadsheet importer templates created by users
• Secure storage file containing password to Marklogic database
• Encryption keys used to encrypt and decrypt access tokens
• Standard configuration files which are present in the workspace

Restoring from backup

You can restore a previously created backup file using one of two modes - model restore and full workspace restore. In Knowledge Model Management (KMM) open the Tools menu and select “Restore Models”. From there you have two options: Restoring models or restoring the entire workspace.

Restoring models

In this mode, KMM will restore all models from the backup file and only the configuration data which is related to these models. That is:

• Users which are mentioned in those models as viewers/contributors/editors/managers or model creators
• Spreadsheet import templates defined for those models
• “TTL” files (standard and custom) which are imported by those models. Note that these files can be imported directly by the model or transitively by other graphs.
• Publisher configuration files

Restoring entire workspace

In this mode, KMM will restore all models from the backup file and all configuration files located in the backup. This should effectively revert the application to the state in which the backup was made. This only reverts the current state of the application, and not the application version itself; Note that all standard configuration files (those not intended to be customized by users) after being restored from the backup file will be automatically upgraded to match the current application version.

Restore options

It is possible to restore data from different versions of KMM. However, care should be taken about the restoration of configuration files - the configuration files within the KMM workspace should not generally be overwritten if restoring from a different version. To help with this we have added a Check Version box - default on. If this is on and you are restoring from a different version, the restore will fail. If this happens and you do want to restore from another version, uncheck this box and ensure that the overwrite settings are what you want them to be.

In both of the already described modes, you can choose a way of resolving conflicts for models and configuration files. If in the current state the application contains a model which is also located in the backup file you can choose one of three options:

• Abort the restore operation - No models or configuration files will be restored
• Recreate - All conflicting models will be deleted and recreated from the backup
• Do not recreate - Conflicting models will remain unchanged.

If in the current state the application contains configuration files which are also present in the backup but their content differs you can choose one of three options:

• Abort the restore - No models or configuration files will be restored
• Overwrite - All conflicting files will be overwritten from the backup file and if necessary upgraded to be compatible with the current version of the application
• Do not overwrite - Conflicting files will remain unchanged