Asset Version History

Last Updated: 28 Apr 2020

Overview

The Asset Version History extension is a Matrix package that provides an interface for viewing the version history of an Asset, including its standard fields, attributes and metadata.

Prerequisites

Read the following prerequisites and information before installing and using the Asset Version History.

This page is replaced by the versioned documentation maintained through https://docs.squiz.net/extensions/asset-version-history. Changes made to this page will not be visible once made live.

Key package information

Minimum supported Matrix version

5.5.6.0

Extension type

Matrix package

Extension version

1.0.0

Installation method

.tgz archive

Availability

Admin mode

Installing the extension

This extension is installed using the Matrix package installation process.

You can download the extension package from the Asset Version History Squiz Marketplace listing.

See Matrix Packages for basic installation instructions

Using the extension

Whenever a Matrix Asset version is incremented, the Asset Version History extension takes a snapshot of the state of the Asset at that point of time, including its standard fields, attributes, and metadata.

You can view an Asset’s version history by navigating to the Version History screen of the Asset.

A list of the available version history allows you to select which version you want to view a snapshot of.

Managing the extension

Configuring

The extension is enabled with default settings after installation, and no further configuration is required.

Configuration changes can be made by editing the <matrix_root>/data/private/conf/asset_version_history/config.php file.

The following configuration options may be changed

OptionDescriptionDefaultValues

enabled

Provides a way to enable or disable the extension. This will stop further version history data being collected, however, it will not disable the Version History screen.

true

true

false

pagination_limit

Sets a limit on how many versions are available to view on the Version History screen.

500

0+
(must be an integer)

null
(no limit)

Upgrading

Upgrading this extension follows the same procedure as the installation process.

Uninstalling

To uninstall this extension, you need to have both Matris System Administrator and command-line access to your Matrix instance.

  1. Log in to Matrix as a system administrator and access admin mode
  2. Follow the regular package uninstallation steps described in Matrix Package Management.
  3. To remove all asset version history data, drop the sq_ast_vers_history table from your database.
  4. Delete the configuration directory located at <matrix_root>/data/private/conf/asset_version_history.

Send Feedback

Noticed an error?
Want to suggest an improvement?

Let Us Know

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.