Versioning is the history of changes that have been recorded against a Component or Structure.
A revision records the previous versions of the item before it has been changed. The user can click view on any of the previous revisions to check the state and information of the item at the time the revision was created and who created the revision.
Click on each of the actions below for information on the key terms displayed during the versioning process.
Note
New revisions can only be created in a finalised component or structure.
Create New Revision
Creating a new revision in Orien involves several steps. Let's review these in some more detail.
- Choose the item in the hierarchy you want to revise, select the Tactics module and then the Revision tab (if required). Select the New Revision button.
- You will be presented with notes screen, which allows you to input a description about what changes will be made. Clicking on Save will put the item into an editable state, allowing you to start making changes.
Note
The notes field can be still be changed later while the revision is still active.
- You will now see that you are working on the next revision of the item. In the figure below, you will notice the revision number has incremented, the item is no longer active (indicating that this is not the current version of the component structure), and that this revision is currently undergoing changes (indicating it is in an editable state).
This will also be reflected in the revisions table to indicate the revisions is in a working state. While in an editable state you can view another revision without losing the changes you have made in the current working revision.Once you are ready to commit the changes, click Finalise. This will show the notes screen one final time to make any adjustments or add any further description to the revision.
Important
If a revision is not Finalised, any changes will not be reflected in the rest of the program (i.e. packaging, budget generation, etc.).
The process of finalising new tactics and changes is also demonstrated in the video tutorial below:
The process of restoring an earlier revision is demonstrated in the video tutorial below:
Viewing Alternative Revisions
Reviewing earlier versions allows you to view previous editions of the Tactics or Component Structure without affecting the currently selected Tactics. To view an alternate revision:
- Choose the item in the hierarchy you want to view, select the Tactics module and then the Revision tab (if required).
- Select View Details on revision you wish to view (right-hand side of the Revisions Card), and then select the Revisions tab (selecting view details automatically redirects you to the tactics tab for that revision).
- You will see the component now references the revision you are viewing is a different version, and that it has been Superseded, indicating it is no longer the most recent and active version.
The revision history card will show the current revision that is being reviewed is not finalized, and that it is not Undergoing Changes. This indicates the revision is not currently being worked on.
Restricting Tactics Revisions
Tactics Revisions can be restricted so they can only be edited by the person who created the revision. Additionally, other users can be added as Contributors. The creator of the revision can also grant contributors the permission to finalise or discard the revision. To add Contributors or to edit their permissions, select the current revision's Contributors option:
If a contributor need to be removed from editing that revision, they can be Deactivated in this window. A user can be added by selecting Create New or their permissions can be edited by selecting the Edit button.