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.0 to v3.24.1

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.24.0 installation to version 3.24.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.

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

Queries for Asset Link Locking

The following database queries must be run in order to add the Asset Link Locking functionality. These steps must be run before step_02. The dropped views will be regenerated by step_02.

The following queries are compatible with both PostGres and Oracle: 

ALTER TABLE sq_ast_lnk ADD locked CHAR(1) DEFAULT '0' NOT NULL;
ALTER TABLE sq_rb_ast_lnk ADD locked CHAR(1) DEFAULT '0' NOT NULL;
DROP VIEW sq_rb_vw_ast_perm;
DROP VIEW sq_rb_vw_ast_role;
DROP VIEW sq_rb_vw_ast_lnk_minor;
DROP VIEW sq_rb_vw_ast_lnk_major;
DROP VIEW sq_vw_ast_perm;
DROP VIEW sq_vw_ast_role;
DROP VIEW sq_vw_ast_lnk_minor;
DROP VIEW sq_vw_ast_lnk_major;

Base Contexts per URL

The following queries need to be executed in order to provide the Base Contexts per URL functionality. These queries are compatible with both PostGres and Oracle.

Rollback must be disabled before running these queries, if enabled, then restored. 

ALTER TABLE sq_ast_url ADD base_contextid INT DEFAULT 0 NOT NULL;
ALTER TABLE sq_rb_ast_url ADD base_contextid INT DEFAULT 0 NOT NULL;

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/compile_locale.php /home/websites/mysource_matrix
$ php install/step_03.php /home/websites/mysource_matrix
$ php install/compile_locale.php /home/websites/mysource_matrix

Verification of existing JS API implementations

Implementations using the "createAsset" action may need to be assessed as the additional arguments for extra attributes has modified the function signature, pushing the callback function out a further two places.

For example, before: 

createAsset(parent_id, type_code, ...  is_exclusive, dataCallback)
after: 
createAsset(parent_id, type_code, ...  is_exclusive, extra_attributes, attributes, dataCallback)

Verification of existing CSS / style references

As the functionality modification HTML Tidy: Deprecated Bold and Italic tag conversion, will modify existing <b> and <i> tags upon committing WYSIWYG content in systems where HTML Tidy is enabled, it is recommended that any style sheets (CSS files) be assessed for any instances of "b" and "i" tag declarations.

These should be converted to "strong" and "em" declarations to ensure continued processing of the related style instructions.

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.1 should now be complete.