Document Revision History and Restore
Each time a document is published, it will be stored as a new revision, and the document's earlier states can be accessed as revisions as well.
The Revision History window for a document can be opened and used in two ways:
- In the Hierarchy View: hover the mouse over a document, then select Revision History in the context menu. In this mode you can only view the revision history and the list of changes for each revision.
- In the Single Document view-edit window: select a document in the hierarchy so that it opens for viewing in the editor at the right.
Click the View Revision History button
in the top menu.
In this mode you can view the revision
history, and load the content of a selected revision into the document editor's data fields (the data is read-only because data
in revisions cannot be changed). You can also
Restore a document revision, i.e., the current ('Latest') content of the document
will be replaced by the content in a stored revision.
Revision History window
The Revision History window lists the document's revisions, the date of each revision, and the user responsible for the editing. The Comment value will have been input into the Change Record when the document was Published. If the revision has been tagged, the revision tags will be listed in the Tags column.
If you click in a revision row (or click the 'right arrow' '>'), the detailed contents of the revision will be shown. This shows all of the changes that were made to variables. Click in the revision row (or click the 'down arrow') to hide the details.
You can use the Revision history filter to filter the information displayed. Click the calendar icon for Enter a filter range to set a date range. Or make selections in the Variables list to select revisions that have made changes to specific variables: only revisions that contain a change to at least one of the selected variables will be shown. Click the Reload button to apply the filter.
Click Reset to delete the filter, followed by Reload to refresh the display.
View the content of a revision in the Single Document editor
Open a document to view in the Single Document editor panel.
Click the View Revision History button in the top menu to open the document's Revision History.
You can load the content of a revision into the document editor's data fields; the data is read-only, except for 'Latest',
because data in historical revisions cannot be changed. Select a revision by clicking its Change Date; the data fields will
be populated with data from this revision, and the revision number and date will appear in the top menu (next to the
View Revision History button ).
To return to the 'Latest' revision, click the button and select the latest revision.
Restore a Revision in the Single Document editor
You can Restore a document revision, that is, the current ('Latest') content of the document can be replaced by the content in a stored revision.
To do this, load the content of a revision into the document editor's data fields, as explained above. This will add a Restore button to the top menu. Click this button to perform a Publish operation on the document (it is not necessary to start Edit mode to do this); fill in the Change Document dialog and click Publish.
The document will be published with its revised content based on the revision, and a new revision will be created. The new revision Comment will have the content "[Restore Document] - Document(s) restored from historic revision" plus the comment text that was input into the Change Document dialog.
Note: if the document's 'Latest' state and the selected revision have identical content, then no new revision will be created, although the Publish operation will run.