MySource Matrix Resources

Content Tools

Main Content

Upgrading MySource Matrix from v3.20.0 to v3.20.1

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.20.0 installation to version 3.20.1.

This upgrade requires you to have access to:

  • update the MySource Matrix source code
  • upgrade MySource Matrix configuration files

This guide assumes that your MySource Matrix installation is located at /home/websites/mysource_matrix. Please change any commands to the appropriate location if your installation is located elsewhere.

If your system contains the Squiz Supported Version (SSV) modules, please contact Squiz for updated versions of the modules before proceeding with the upgrade.

The modules must be upgraded at the same time as the core system.

Backup

Before starting any upgrade, always backup your MySource Matrix installation. See the MySource Matrix backup management guide for information on how to backup your MySource Matrix system.

Special Backup Note: Log Rotation Changes

Please also back up any Matrix System logs before upgrading as the log rotation scheme has changed, which may result in unexpected removal of the earliest log file.

Getting the New Source Code

The first thing you need to do is update the MySource Matrix source code. You can find out how to download the latest stable version of MySource Matrix on the installation page.

Once you have downloaded the source code, you need replace the existing code with the newer version. This will not reset any configuration options or remove any content from your system.

These steps assume MySource Matrix is installed at /home/websites/mysource_matrix and that a tar.gz archive with the new source code exists within /home/websites 
$ cd /home/websites
$ mv mysource_matrix mysource_matrix_3-20-0
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -r /home/websites/mysource_matrix_3-20-0/data .
$ cp -r /home/websites/mysource_matrix_3-20-0/core/lib/DAL/Oven core/lib/DAL
$ cp -r /home/websites/mysource_matrix_3-20-0/core/lib/DAL/QueryStore core/lib/DAL

Full System Upgrade

Now, the system's installation scripts should be run to ensure the asset types and language translations are up to date.

$ php install/step_02.php /home/websites/mysource_matrix
$ php install/step_03.php /home/websites/mysource_matrix
$ php install/compile_locale.php /home/websites/mysource_matrix

Upgrade Script for Multiple Session Expiry Rules

In addition to the usual minor upgrade steps, a separate upgrade script must be run to convert existing Global and User Group Session Expiry Rules to the new multiple-rule format.

Please run the following from the Matrix System Root Directory:

$ php ./scripts/upgrade_session_expiry_preferences.php `pwd`

Reparse Designs which use Linked CSS Files

It has been brought to our attention that some Design Parse File contents generated between 3.18.0 and 3.18.5 inclusive might be causing issues with expected operation when the "Use Static Cache File" option is used.

It is recommended that the Design Parse Files are regenerated for any Design that uses the Linked Design Area. Candidate Designs would contain the following code (or simiar):

<MySource_AREA id="xx" design_area="linked_css" />

Please regenerate any such Design Parse Files by selecting the "Yes, manually reparse the existing file" checkbox from the "Details" screen and click "Commit".

This particular issue was reported as Bug #3255 - "Cache CSS Files - Fatal Error" and has been resolved from 3.18.6.

Upgrade Complete

Your upgrade to MySource Matrix version 3.20.1 should now be complete.