The "Revisions" module provides users with the ability to easily work with the change history: view the field changes history in the pop-up and restore previous values from the change history.
In order to install the "Revisions" module to your system, go to
Administration > Module Manager, find this module in the "Store" list and click
Select the desired version in the installation pop-up window that appears and click the
Install button. The module background will turn green and it will be moved to the "Installed" section of the Module Manager. Click
Run update to confirm its installation.
Please, note that running the system update will lead to the logout of all users.
To update/remove the "Revisions" module from the system, use the corresponding options from its single record actions drop-down list in the Module Manager.
After the "Revisions" module is installed, users will be able to see the change history of audited fields and restore these changes.
To enable storage of the change history for a particular field, perform the following actions:
Open the fields list of the desired entity in the Entity Manager and select the field in the "Name" column:
On the field detail view page that opens, activate the
Auditedcheckbox and save the field changes to enable its updates logging:
For reviewing the changes in the Stream on the entity record page,
Stream must be activated for the desired entity settings. To open the entity settings page, click
Edit for the desired entity record in the Entity Manager:
Removing a Record from the Stream
Administrator only has access to the single record actions for change history records displayed in the Stream.
To remove a change log entry, select this record in the Stream and select the
Remove option from its single record actions list:
Beware that this action is irreversible.
After removing the entry from the Stream, it also disappears from the change history pop-up.
Restoring Values from the Stream
Select the desired change in the stream and select the
Restore option from its single record actions list:
Confirm your decision by pressing the
Restore button in the pop-up warning that appears:
The revert itself is logged similarly to manual changing of this field, i.e. a new change entry is added to the stream (with the information about the date and time, old and new field values and the user who made the revert).
By design, user has access to the revision functionality for the field and attribute values only, but not the Stream.
Changing the History Pop-Up Display
In order to see the change history of a certain field, click the clock icon located in the top right corner of this field on the entity detail view page:
Then the pop-up opens with the list of changes in this field, if any:
The following data is displayed in the "List" pop-up:
- the date and time of the change;
- the user name who made the change;
- the values of the field before (
Old Value) and after (
New Value) the change;
- the locale name, if a multilingual field was changed.
To learn more about multilingual fields and locales, refer to the "Multi-Languages" module description.
The be able to see the field history you need the editing right for this field.
Restoring of an Old Field / Attribute Value
To revert any change made to the audited field, click the
Restore button for the desired change in the change history pop-up:
Additionally, change history tracking and value restoration are available for product attribute values. For this use the
Show changes option from the single record actions drop-down menu of the desired attribute on the "Product attributes" panel:
Get the "Revisions" module now to benefit from the change history functionality!