Versioning an embedded data model
About versions
You can create versions for data models that evolve in parallel. Versions are not to be confused with data model snapshots, which are taken at publication time and kept strictly for historical read-only reference.
Accessing versions
To see the existing versions of your data model, select 'Manage versions' from the data model 'Actions' menu of the data model.
The existing versions are represented in a tree format according to their parent-child relationships. Every data model has a root version by default, with the same name as the data model.
Working with versions
In the workspace, using the down arrow 
menu next to each version, you can perform the following actions:
Access data model version | Go to the corresponding version of the data model. |
Create version | Creates a new version based on the contents of the selected version. The new version is added as a child of the selected version, though its contents bear no relation to those of its parent version after creation. |
Set as default version | Sets the selected version as the default version opened when users access the data model. |
Export archive | Exports the selected data model version to an archive containing the version's content, including its permissions and information. The exported archive is located in the archives directory, which is accessible to repository administrators. Exporting to an existing archive name will overwrite the existing file. See Archives directory for more information. |
Import archive | Imports the content of an archive into the selected version. The archive to import must contain a data model with the same name as the data model associated with the version. |
A version can be deleted by clicking the X button to the right of its entry. A version cannot be deleted if it is linked to a publication or if it has child versions. The root version of a data model also cannot be deleted.
Two versions of the same data model can be compared in the workspace by selecting their checkboxes, then selecting Actions > Compare selected versions. The side-by-side comparison shows structural differences between the version of the data model, with the older version on the left and the newer version on the right.
Known limitations on data model versioning
It is not possible to merge two versions of a data model.
The comparison interface does not display updates on fields, only additions and deletions.
Versioning of data models packaged in modules is not supported.
Resources packaged in a module that are used by an embedded data model are not versioned when a version is created. That is, only the reference of the resources are saved during the creation of a version, and it is the responsibility of developers to ensure that the content of the referenced resources are compatible with any versions that may be using them.
User guide table of contents