Versioning

Owned by Charlotte Reynolds
Last updated: Jun 11, 2019
2 min read

Versioning

Introduction
Finalizing a Data Model

  1. Navigate to the relevant DRAFT data model that is ready to be published.
  2. Click the "Data Model" menu button from the top menu bar and select "Finalize" from the dropdown menu.


3. Fill in the following fields in the Finalize Data Model pop-up box:

  • Semantic Version: enter the version number.
  • Revision Notes: describe any changes made or further notes.


4. When complete click on "Finalize".  A further window will pop up as the Data Model is finalized. Any errors preventing the model from being finalized will be listed here. If successful, "JOB Finalizing Model [1314965@0.0.1] (DRAFT:DataModel:1314965) COMPLETED SUCCESSFULLY" will be displayed. 

5. The data model is now successfully finalized.

Creating a New Version (DRAFT) of a Data Model

  1. Navigate to the relevant FINALIZED data model that you wish to create a new DRAFT version from.
  2. Click the "Data Model" menu button from the top menu bar and select "New Version" from the dropdown menu.

3. Fill in the Semantic Version number field in the pop-up window.

4. When complete, select "Create New Version".  A further window will pop up as the New DRAFT version is created. Any errors preventing the model from being finalized will be listed here. If successful, "JOB Create new version of Example Model 1 [1314965@0.0.2] (FINALIZED:DataModel:1314965) COMPLETED SUCCESSFULLY" will be displayed. 
5. A new DRAFT model has been created.

Deprecating a Data Model

  1. Navigate to the relevant FINALIZED data model that you wish to deprecate.
  2. Click the "Data Model" menu button from the top menu bar and select "Deprecate" from the dropdown menu.


     3. A pop-up box will appear, asking if you wish to deprecate the data model. Select "OK"

      4. The Data Model will now be marked as deprecated.

Restoring a Data Model

  1. Navigate to the relevant DEPRECATED data model that you wish to restore.
  2. Click the "Data Model" menu button from the top menu bar and select "Restore from the dropdown menu.


      3. A pop-up box will appear, asking if you wish to restore the data model. Select "OK".

      4. The Data Model will now be restored to a FINALIZED state.

Further Information

Read Versions (Key Concept) Article for further information.