Versioning

Overview

Version control is important for efficient knowledge modelling. It enables tracking changes, reverting to previous versions, and facilitates team collaboration. This practice helps in risk mitigation, streamlines workflows, and ensures safe deployments.

Creating a version

When editing your knowledge map in the Studio, you will always be working from the draft version. This is the only version that can be edited.

At certain points during the modelling process you may want to create a version, which takes a snapshot of the knowledge map at a specific point in time. This can be useful to:

• mark a milestone in the build,

• allow changes to be tested externally, whilst the draft version continues to be edited,

• keep a backup before making major updates,

• publish it as your live version.

To create a version, click Versions, then + New Version. It is best practice to leave a commit message that describes the changes made.

Taking a snapshot of a KM in development, but creating a version.

• The version number will automatically increment by one each time a version is created.

• The draft version must not contain any errors. If it does, you will be unable to create a version until the errors are fixed.

• The version will be labelled with the account that created it to support collaboration in a shared workspace.

• The version name/description can be edited.

• The contents of the version (i.e. the knowledge map itself) cannot be edited or deleted.

Previewing a version

A version cannot be edited, but it can still be viewed in the Studio and queried to check the behaviour. This can be helpful when:

• Checking versions created by colleagues when working collaboratively

• Referencing old logic that that may have changed

• Trying to find the correct version to restore into your draft, or to export in order to share or move between accounts

• Inspecting and testing a version before publishing it live

• Troubleshooting a live version, without the risk of changing it or making queries that impact the permitted query limit.

To preview a version, click Versions and select the version you want.

In Preview mode, you can view the knowledge map logic, the RBLang, run queries, export the version or restore it to your draft.

You cannot edit the version or access test and publish functionality.

Previewing and querying a version

Restoring a version

Restoring a version enables you to copy a specific version back into your editable draft, so you can make changes to it.

This might be because you made changes that introduced unwanted issues and need to revert back to a working version.

To restore a version, click Versions, select a version to preview (take the opportunity to check it's the correct version), click Restore, confirm you are happy to overwrite your draft, or cancel.

Preview and restore

Important points to note when restoring:

1. This will overwrite your draft. If necessary you could snapshot your draft as a version, before restoring an older version, or export the draft version, so you don't lose it.

2. When a version (e.g. version 4) is restored, version 4 will remain in your version list as the original snapshot. It can therefore be used as a restore point in the future.

3. Minor versions are not supported. If you restore, edit and create a new version of this change, the version number will be automatically assigned. Therefore if you have 20 versions, restore version 4 to make changes, then create a version, this will become version 21.

Setting a version live

When publishing a knowledge map, you can flag a particular version as 'Live', which ensures any systems integrated into your knowledge map will use this version by default. Details for publishing your knowledge map can be found in additional sections.