Revisions

The "Revisions" module provides users with the ability to easily work with the change history: view the field and attribute value changes history in the pop-up and restore previous values from the change history.

Tracking of entity changes

The history of changes and the ability to restore values is available for all fields and attributes of any entity by default. To activate all the options of the Revisions module, no additional settings are required.

If you do not want to track changes for a particular entity, you need to disable this option in the entity manager. Go to Administration / Entities -> Edit and select the checkbox Disable Track changes.

Remove From Stream

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:

Remove From Stream

Beware that this action is irreversible.

After removing the entry from the Stream, it also disappears from the change history pop-up.

Restoring Values

After the "Revisions" module is installed, users will be able to see the change history of audited fields and restore these changes.

Restoring of field values

If you have the Revisions module installed in your environment, you will see a clock icon next in the top right corner of each entity field. In order to see the change history of a certain field, click this clock icon on the entity detail view page:

Revision Icon

Then the pop-up opens with the list of changes in this field, if any:

Revision List

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 please read here and here.

The be able to see the field history you need the editing right for this field.

Restoring of Attribute Value

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:

Attributes tracking

Restoring values from the Stream

The stream displays the history of record changes with new and previous values. To see all the changes in one pop-up window, select the Change History option in the right corner of the panel.

Change history

In the table appearing, you will see the date of change, type of change (create, update, delete, or link/unlink for relations), new and old values.

Change history

Two options are available behind the 3 dots menu:

  • Restore - restore a single record
  • Restore all - restore all changes that were made at the same time

You can also restore field and attribute values directly from the Stream without opening the Change history.

Select the desired change in the stream and select the Restore option from its single record actions list:

Restore in the stream

Confirm your decision by pressing the Restore button in the pop-up warning that appears:

Restore warning

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).