Manage configuration versions

In BRIX, you can manage workspace versions: create, store, and restore them.

A workspace version is a set of versions of the structures included in the workspace: apps, pages, widgets, and processes. When you capture a workspace version, new versions of its structures are captured as well.

By default, a workspace version is created automatically only after the workspace is imported, updated, or copied. If you are developing a new workspace from scratch and adding it to the system left menu, or have modifiied the structures inside the workspace, a new version is not automatically created.

You can manually capture a version of a workspace, for example, to save the first working version of a new workspace and then continue developing it.

Note that a version is not created automatically for a workspace that is part of a solution when the solution is imported or updated. However, you can capture a version manually.

This article describes how to work with workspace versions. For more information about versioning structures within a workspace, see Versioning of structures in BRIX.

Working with versions in the configuration tree

To manage workspace versions and their structures, go to Administration > Developer Tools and select Configuration Version Management.

Note:

• Structure versioning is available if the allowVersionsSnapshots feature flag is enabled.
• The Configuration Version Management page is available starting from system version 2026.3 if the exp_exchange_enable_packageVersions feature flag is enabled and the exchangeSrv service migration has been completed.

For more information about enabling feature flags in On-Premises deployments, see Modify BRIX parameters. If you use the SaaS deployment, contact your BRIX rep.

The Configuration Tree is displayed on the Configuration Version Management page. It contains system and custom workspaces

Expand a workspace to view the structures it contains. Each structure type is represented by a specific icon in the tree. Hover over an icon to see its type: workspace, app, page, widget, or process.

Click the three dots icon next to a workspace name to open available actions:

• Versions: open the workspace version history.
• Create version:  create a new workspace version.

For structures inside a workspace, only the Versions option is available. This allows you to open the version history of any item in the configuration tree.

Capture a workspace version

By default, the first workspace version is created automatically only when you copy or import a workspace from another company.

You can capture a workspace version manually at any time: while developing a new workspace or before and after making changes to the structures of an existing workspace. To capture a version:

1. On the Developer Tools > Configuration Version Management page, select a workspace in the configuration tree. Hover over the three dots icon and click Capture Version.
2. In the opened window, you can see the name of the current version if one was created previously. Fill in the fields:

• Version*. Enter the name that will be displayed in the workspace version list. When you later export and import the workspace to another company, this name helps identify the version. It is displayed in the import window and in the version list of the imported workspace.
• Comment. Enter additional information that will be displayed in the workspace version list.

3. Click Capture.

View workspace version history and manage versions

To open the list of workspace versions, select the workspace in the configuration tree, hover over the three dots icon, and click Versions. In the opened window, the following information is displayed for each version:

• Version number and name specified when the version was created or edited.
• Date and time when the version was created.
• User who created the version.
• Comment.

Click the three dots icon next to a selected version to open the available actions menu:

• Edit to change the version name and comment.
• Show Contents to display the contents of the workspace version as a tree: apps, pages, widgets, and processes.
• Compare with Current to compare the selected workspace version with the current version.
• Restore Version to make the selected version the current version.

Current workspace version change indicator

In the version history, you can see whether the current workspace version matches the state in which it was created. The current version is marked with:

• A checkmark icon means that the contents and versions of apps, pages, widgets, and processes inside the workspace have not changed since the version was created.
• An exclamation mark icon means that changes have been made to the workspace contents:

• • An app or page was created.
  • The version of an app or page was changed, for example, a property was added to the app context.
  • A widget or process inside the workspace was published.
  • A structure was deleted from the workspace.

If the current workspace version has been changed when restoring an archived version, exporting, or updating the workspace, you will see a warning. To continue working with workspace versions correctly, create a version of the current workspace and then continue the started operation.

Compare workspace versions

When you select Compare with Current, two trees are displayed: the selected workspace version and the current workspace version. The following actions are available:

• Expand the tree structure to compare the contents of the two workspace versions.
• Compare versions of any structure inside the workspace:  the contents of the selected structure from each version are displayed in a separate window in JSON format. To do this, click the three dots icon next to the structure and select Compare.

Restore a workspace version

You can make an archived workspace version current and restore the state of all workspace structures to the state they had when the archived version was created. To do this:

1. In the workspace version list, select the required version. Click the three dots icon and select Restore version. This option is also available in the workspace version comparison window.
2. In the opened window, confirm creating a new version based on the selected version.
3. The system checks whether the current version contains changes. If changes are found, you will see a warning. To ensure correct workspace version management in the future, click Commit Version.

4. The workspace version and the versions of its structures will then be restored..

Information about the restored version will be added to the comments of the created workspace version and the new versions of its structures.

Soft deletion of workspace structures when restoring a version