MySource Matrix Resources

Content Tools

Main Content

Upgrading MySource Matrix from v3.18.6 to v3.18.7

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.18.6 installation to version 3.18.7.

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.

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-18-6
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -r /home/websites/mysource_matrix_3-18-6/data .
$ cp -r /home/websites/mysource_matrix_3-18-6/core/lib/DAL/Oven core/lib/DAL
$ cp -r /home/websites/mysource_matrix_3-18-6/core/lib/DAL/QueryStore core/lib/DAL

Run "Trigger Category" Upgrade Queries

Important Information

Additional queries are required as part of the above "Trigger Category" development.

Upgrade Steps

Please run the following queries on your database.

ALTER TABLE sq_trig ADD category VARCHAR(255);
ALTER TABLE sq_rb_trig ADD category VARCHAR(255);
CREATE INDEX sq_trig_category ON sq_trig(category); 
CREATE INDEX sq_rb_trig_category ON sq_rb_trig(category);

Permission Views definition changed

Upgrade Steps

Disable rollback on your system. If you need help with this, please consult the Rollback Management Guide.

Please run the following queries on your database. 

DROP VIEW sq_vw_ast_perm;
DROP VIEW sq_rb_vw_ast_perm;

Enable rollback. Again, consult the Rollback Management Guide if you don't know how to do this.

The dropped views will be re-created when running step_02 in the "Full System Upgrade" section below.

For systems where Global Roles and/or the Roles System was disabled - Part 1 of 2

Roles definitions are reset back to the Matrix default definitions upon upgrade. In order to retain the Roles System settings used prior to the upgrade, these definitions will need to be restored. Please note that the second part of this item is provided after the "Full System Upgrade" instructions.

  1. Please take note of the values of SQ_CONF_ENABLE_ROLES_SYSTEM and SQ_CONF_ENABLE_GLOBAL_ROLES in the data/private/conf/main.inc file. These were the effective settings from the previous installation.
  2. Edit data/private/conf/main.inc to reset these two values to their defaults: 
    define('SQ_CONF_ENABLE_ROLES_SYSTEM', '1');
define('SQ_CONF_ENABLE_GLOBAL_ROLES', '1');

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

For systems where Global Roles and/or the Roles System was disabled - Part 2 of 2

The following steps will restore the Roles views from the previous installation.

  1. Log in to Matrix as "root" and navigate to the "System Configuration" screen.
  2. Set the values "Enable Roles System" and "Enable Global Roles" at the bottom of this screen to reflect the previous settings as noted in Part 1 of these instructions. Set these items to "No" where the previous value was "0", and to "Yes" where the previous value was "1".
  3. Click the "Commit" button to save these values. The appropriate database views for Roles will be restored to match the previous system.

Poll asset enhancements

Please note that there has been a change in the rendering of the Poll asset with regards to the HTML <form> tag and JavaScript actions performed by the "Submit" button. If custom JavaScript is used on any Poll assets, please review the functionality of these assets after upgrading as the HTML output has changed.

Verification of DB Data Source assets

Please note that due to the changes in how the database architecture is accessed - the introduction of Database Abstraction Layer (DAL) in 3.18.0 - it is recommended that queries performed by DB Data Source assets are reviewed, especially in instances where keyword replacements are used as part of the query.

Upgrade Complete

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