MySource Matrix Resources

MySource Matrix has been superseded by Squiz Matrix. This site will remain available for archival purposes only; it is not intended as a current source of Matrix information. For all the latest on Matrix, including documentation and release information, visit the Squiz Matrix site.

Content Tools

Main Content

Upgrading MySource Matrix from v3.24.4 to v3.24.5

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.24.4 installation to version 3.24.5.

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.

Disable Rollback

At this point, you need to ensure that rollback is disabled before continuing. For help with disabling rollback, see the MySource Matrix rollback management guide.

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-24-4
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -pr /home/websites/mysource_matrix_3-24-4/data .
$ cp -pr /home/websites/mysource_matrix_3-24-4/core/lib/DAL/Oven core/lib/DAL
$ cp -pr /home/websites/mysource_matrix_3-24-4/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.

Please note: The output of step_03 in this upgrade is captured to disk for assessing upgrade steps below. The output will be written to file and displayed in the terminal after execution, so this script will not generate output immediately. Please wait as the script completes and writes its output to the screen.

$ php install/step_02.php /home/websites/mysource_matrix
$ php install/compile_locale.php /home/websites/mysource_matrix
$ php install/step_03.php /home/websites/mysource_matrix >& upgrade.log; cat upgrade.log
$ php install/compile_locale.php /home/websites/mysource_matrix

Run Form Submissions System Integrity script

Previously, when Custom Forms were cloned, any associated Form Submission assets would be linked from the original Form. This led to issues when exporting submissions, and in some cases, prevented cloning of Forms themselves.

This issue, reported as Bug 4119, has been resolved for this release. A System Integrity script has been included in order to clean up any Form Submissions associated with unrelated forms. Please run this script as described below.

To list the Form Submissions affected, please run from the Matrix Root directory: 

$ php scripts/system_integrity_form_submissions.php `pwd` list

In order to permanently delete these linked Form Submissions, please run the script in "delete" mode. Please note that this will not remove the submissions from the original form, just the invalid links. 

$ php scripts/system_integrity_form_submissions.php `pwd` delete

Re-assess JS API implementations - keys changed

The API Keys for all JS API assets was previously set system-wide. Not only is this not recommended for security reasons, this key would change randomly upon upgrade as reported in Bug 4145. This issue has been resolved in this release.

In order to provide unique API keys and to resolve this bug, all JS API assets were assigned a new random API key when running step_03. The new API keys and the asset IDs affected are provided in the output of step_03. In order to display the asset IDs and their new API keys, please run the following command from the Matrix System Root directory: 

$ grep "JS API Asset" upgrade.log

There will be no output if there are no JS API assets in use on the system. If there is output, please assess the relevant JS API implementations. The file upgrade.log can be deleted after assessing these implementations.

Re-enable Rollback

If you needed to disable rollback at the beginning of this upgrade, you may now re-enable it. For help with enabling rollback, see the MySource Matrix rollback management guide.

Upgrade Complete

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