Working with Revision Tags
In Model Settings > Revision Tags, you can:
- Add a revision tag to a model
- Create a model from an existing revision tag
- Revert to the most recent revision tag
- Compare revision tags in the same model
Before you add a revision tag, make sure you understand:
- The differences between a model's structural information and production data.
- How revision tags work and when to use them.
- The differences between Standard and Deployed modes.
Revision tags can only be added to models in standard mode.
Although revision tags are recorded in a model's change history, they don't contribute towards workspace size.
Add a Revision Tag to a Model
- In Model Settings > Revision Tags, click Add Revision Tag.
- Give the revision tag a title and a description (optional).
- Click Save.
A new revision tag is added to the first row in the revision tags table.
Create a Model from a Revision Tag
If you're a Workspace Administrator, you can create a model from the latest or any previous revision tag in a given model. The new model:
- Contains the same structural information as your chosen revision tag, but no production data.
- Is created in the workspace you're currently working in.
The new model will only work as a sync source if it was created from the latest revision tag on the original model.
To create a model from a revision tag:
- In Model Settings > Revision Tags, select a revision tag from the table. The latest revision tag is selected by default.
- In the toolbar, click Create Model From Revision.
- In the Create Model From Revision dialog, enter a name for the new model.
- Click Create Model.
- If the new model was successfully created, you can click Open New Model to open the model in the same browser tab.
Revert to the Most Recent Revision Tag
You can revert a model back to the most recent revision tag, discarding any unsaved structural changes made by you or other users. The model's production data, such as the contents of production lists, is not affected. This feature is useful if you need to revert unwanted changes made in a development model.
To revert to the most recent revision tag:
- In Model Settings > Revision Tags, click Revert to Last Revision.
- In the dialog that appears, click Revert to Last Revision.
- Wait for a few moments while the unsaved structural changes are discarded.
Compare Revision Tags in the Same Model
Understand changes made over time by comparing two revision tags in a single model. You can compare a later revision tag with an earlier one, and vice versa.
- In Model Settings > Revision Tags, locate a revision tag to use as the basis for the comparison, then click Compare. This is Revision A.
- In the Compare Revisions dialog, select the revision tag you want to compare with Revision A, then click Next. This is Revision B.
- Review summarized results of the structural data in Revision B compared with that in Revision A, including a count of new, modified, and deleted items. You can also:
- Compare different revision tags: select them from the dropdowns then click Update.
- Download a more detailed comparison report as a tab-delimited .txt file. For more information, see "About the Comparison Report" in The Compare and Synchronize Process.
What Happens to Revision Tags when you Copy or Import a Model?
We recommend you always add a revision tag just before you copy a model.
- When you copy a model containing unsaved structural changes, a new revision tag is automatically added to the original model and then copied to the new model. This ensures that no structural changes are lost in the copy process. A revision tag that was created by copying a model is entitled “Copy Model”.
- When you copy a model that doesn’t have any unsaved structural changes, the latest revision tag in the original model is copied to the new model. The name of the revision tag is unchanged.
The same process applies when you import a model, except that a revision tag created by importing a model is entitled "Import Model".
About the Synchronized Icons
In Model Settings > Revision Tags, the icons in the Synced column indicate the synchronization status of a particular revision tag.
|The structural information in the revision tag has been synchronized to a compatible target model.|
|The structural information in the revision tag has been synchronized from a compatible source model.|
Hover over an icon to view a summary of its synchronization status. If the Synced column is empty, then the model has never been synchronized at that revision, either from a source model or to a target model.
What Information is Stored in a Revision Tag?
As well as capturing a model's structural information, each revision tag stores the following extra information, accessible in Model Settings > Revision Tags.
|Synced||Whether the revision tag has been used in a Compare and Synchronize operation, as either a source or target.||Synchronized with "Demand Planning Dev" on 10 Jan 2018 09:30 by John Doe|
|Title||A summary of the revision tag.||1.1, 1.2, 2.0
Budget FY 2018
|Description||A user-entered description of the structural changes.||
"Minor changes for v1.1"
"Release of v2.0"
"Added Consolidation module for Budget FY 2018"
|Created By||The name of the user who added the revision tag.||John Doe|
|Created On||When the revision tag was added.||10 Jan 2018 09:30|
About Revision Tags in Change History
The change history of a model includes information on revision tags and related actions involved in ALM. Use the table below to help you interpret this information.
|When you...||This text appears in the "Description" column...||This text appears in the "New Value" column...||Notes|
|Add a revision tag||"Revision added manually by user"||The title of the revision tag||-|
|Copy a model||"Revision added automatically"||The title of the revision tag||If you copy a model containing unsaved structural changes, "Revision added automatically | Copy Model" appears in the change history of both the original and the new models.|
|Import a model||"Revision added automatically"||The title of the revision tag||If you import a model containing unsaved structural changes, "Revision added automatically | Import Model" appears in the change history of both the source and the target models.|
|Create a model from a revision tag||"Model created from revision"||The title of the revision tag||"Model created from revision" appears in the change history of the target not the source model. This is followed by a list of all model changes against a single change ID.|
|Synchronize changes to or from a model||"Revision synced"||The title of the revision tag||"Revision synced" appears in the change history of the target not the source model.|
Because these actions don't constitute model changes, they don't have a change ID. So, it's not possible to restore a model to a previous revision tag or related action using the Restore to ID feature.
Revision Tag Inheritance
Revision tags are inherited from parent models. Where a model has not been synced, or had revision tags applied to it, the information displayed in the Revision Tag grid may not be what was expected. This situation is usually the result of copying a parent model several times, causing the same structural information—and consequently the same revision tag—to be copied to each child model.
This description explains how revision tag inheritance works and illustrates how revision tags are copied between models.
A sample site
In this image, you can see a site which has two workspaces. A template model has been used to create a parent model, from which a hierarchy of three layers of child models has been created. Each model is created via a copy action, except the model imported into Workspace 2 (Child model 1.1).
This configuration may be more complex than that of many customers, but it serves to illustrate revision tag inheritance.
The models to which changes were made while creating the hierarchy are:
- Child model 1—a revision tag was applied.
- Child model 1.1—structural information was changed but no revision tag was applied.
We can now overlay the revision tag structure on this configuration:
This is how the Revision Tags screen will display information about each model.
Revision Tags screen for Child Model 1
When hovering over the sync icon in the Revision Tags screen, the tooltip will display Synchronized with: “Template model”, rather than Synchronized with: “Parent Model”. This is because no revision tag was applied to Parent model so Child model 1 inherited its revision tag from Template model.
Revision Tags screen for Child Model 1.2
When hovering over the sync icon in the Revision Tags screen, the tooltip will display Synchronized with: “Child Model 1” because Child model 1 had a revision tag applied to it before it was copied to Child model 1.2.
Summary Revision Tags
A single revision tag can summarize several copy or import actions resulting in the tooltip displaying multiple entries. However, there is no indication of the relationship between those models.
In this example, once the hierarchy is set up, when hovering over the sync icon in the Revision Tags screen, the tooltip displays these entries, ordered by the time their respective copy or import action was performed.
Revision Tags screen displays “Unknown Model”
Where a source model is deleted from a workspace, when hovering over the sync icon in the Revision Tags screen, the tooltip will display “Unknown Model”, rather than the name of the deleted model, making it difficult to identify the model’s relationship to other models. This occurs at all levels of the hierarchy, not just at the lowest level.
Here, Child model 1.1.1 displays “Unknown model” in the entry representing the copy from Child model 1.1, which has now been deleted.
Here, Child model 1, the parent of Child model 1.1, displays “Unknown model”, in the entry representing the import to Child model 1.1, because that model has now been deleted.