4.12.0 RC1

As of this release, a token parameter is now present in every HTTP POST request to Simple Edit URLs for validation purposes. While this won't affect most users, it could potentially impact custom Simple Edit implementations that involve directly sending POST requests to Simple Edit URLs instead of submitting the Simple Edit form.

The token must be added to all POST requests as a POST parameter. The token can be found in the Simple Edit form element as a hidden input and is valid per session.

If you are using EES/Edit+ please upgrade to build 1858. Prior versions of EES/Edit+ will not save content or be able to upload files as Squiz Matrix now expects this token parameter to exist in HTTP POST requests to Simple Edit URLs. Please review the compatibility guide for more information.

Featured Changes

When a user account is placed up for review within Squiz Matrix, users will be prompted to change their current Squiz Matrix password on a Change Password screen.

Previously, the design of this screen was not configurable. This feature adds new functionality, allowing you to set a custom Change Password design.

The System Defined Password Change Design options can be found on the Settings screen of an asset. These tools work in a similar manner to the System Defined Login Design, enabling you to override the default design of the Change Password screen for the asset, automatically cascaded to any children. 

When users log on to the system and require a password change, the Change Password screen will use the custom design, specified in the System Defined Password Change Design settings.

This feature has been added to complement the other custom log-in designs within Squiz Matrix.  

New Trigger Action to Schedule a Bulkmail Job

A new trigger action has been added to Squiz Matrix to schedule a Job to be run when a trigger is fired.

The Schedule Bulkmail Job trigger action can be configured to override the default settings of a selected Bulkmail Job, allowing you to instead send the asset that fired the trigger (or an asset of your selection), as well as selecting the recipients of the job.  

You are also able to enable the Subscription Filter on the selected Bulkmail Job, specifying whether to use the Bulkmail Job's set subscription filters or to override these filters. This is a new feature to the Bulkmail Package which is outlined in more detail below.

This feature has been added to provide users with additional implementation options for their Bulkmail set ups. 

Bulkmail Job: New Scheduling Settings Screen

Squiz Matrix's Bulkmail Job asset defines the content and recipients of a bulkmail configuration. Previously, for a Bulkmail Job to be run, users would have to manually change the asset's status or use the schedule_bulkmail_job.php script.

This feature adds new settings to the Bulkmail Job asset, allowing you to enable and configure automatic scheduling of your jobs.

The Bulkmail Job Scheduling screen allows you to enable scheduling for the job and provide a start date. You can then specify the frequency of how often the job should be run (either hourly, daily, weekly, monthly, yearly or not at all).  

Once enabled, the Bulkmail Job will be queued to run at the specified start date and time, and then continue to run subsequently at the specified frequency.

This feature has been added to provide users with effortless scheduling of the jobs within their bulkmail configurations.

Bulkmail Job: New User Subscription Screen

We have one more new screen that has now been added to the Bulkmail Job asset, this time allowing you to configure user subscriptions for the jobs within your bulkmail configuration.

The new User Subscriptions screen allows you to enable user subscriptions for your Bulkmail Job. When subscriptions are enabled, categories can be created, comprised of Asset Metadata Field rules to match a user asset's metadata against a specified value. 

User Subscriptions utilise the use of a Search Page asset to query a selection of assets using the matched subscription metadata value. Assets returned on these searches will then be sent (individually) to the users within the corresponding subscription category.

For example, you could create a location subscription category, matching metadata values such as Sydney and Melbourne. The Search Page would search these queries, and return a selection of articles for these users, sending them content appropriate to their location.

Call REST Resource Completion Action on E-Commerce Checkout Page

The Custom Form Page's Call REST Resource submission action is used to communicate with a web service exposing itself using Representational State Transfer (REST) methods, upon submission of a form.

This functionality has been extended to the E-Commerce package's Checkout Page asset via a new Call REST Resource completion action that will call a REST resource server after the checkout process has successfully been completed on an e-commerce order.  

The Call REST Resource action can be configured on a new Checkout Completion Actions screen of a Checkout Page asset. This screen is similar to the Submission Actions screen of a Custom Form.

Like the form submission action, the Call REST Resource allows you to configure the HTTP request to the REST web server, passing details of the e-commerce order within the request body content (incl. the order summary, the delivery form responses and the individual item details).

The completion action also allows you to set custom parameters for Product asset types on a new Order Array keyword, as well as configure the Error Response Notification Email for non-2xx responses from the REST server.

REST Resource JavaScript - V8 JS Engine

Current the REST Resource JavaScript asset only allows you to use the SpiderMonkey JS engine to execute JS commands. This feature introduces the option of using the V8 engine, if the PECL V8js extension installed.

Additional SAML Options for User Linking and Creation

In this month's releases of Matrix, we unveiled federated access management single sign-on and identity verification through our new SAML Account Manager asset. This feature adds further options to this asset, allowing you to set the linking settings for users (automated in current release), as well as allow Matrix to automatically create linked local users during the authentication process.

The Allow Linking to Existing Users and Automatic Creation options are available on the Details screen of the SAML Account Manager. 

By default, linking to existing users is enabled. This means that is a user is logged in to Squiz Matrix and their account is SAML authenticated, the SAML Account Manager will prompt the user to link their accounts, if they have not yet been. This linking allows for federated access to the system, automatically signing the user into their account as part of the SAML authentication process.

The Automatic Creation option handles the creation of linked local users when a user is not logged into Matrix. By default, this is a manual process, with users being allowed to create a new user account during SAML authentication. Enabling this option will automate this creation, skipping this manual process.

This feature has been added to provide users with more options for configuring SAML federated access management on their systems.

OAuth Session: Redirect to Authorise, Store Access Token

Squiz Matrix's REST Resource OAuth assets allow you to define the parameters for OAuth authentication when communicating with an OAuth secure REST web service. This feature introduces additional parameters, allowing you to redirect users to an external authorisation page and providing the option of permanently store the access token.

The Redirect to Authorise and Store Access Token options are available on the Details screen of REST Resource OAuth assets. 

By default, neither of these options will be enabled.

Enabling the Redirect to Authorise option will redirect a user to the service provider's authorisation page to authorise the request token instead of simply nesting the authorisation form within Squiz Matrix.

The Store Access Token option allows you to permanently store the access token. By default, this token is stored in the session, meaning that when a user logs out, the token will be lost. Permanently storing this token will prevent users from having to reauthorise in each user session. Disabling this option will remove any permanently stored tokens.

These features have been added to bring Squiz Matrix OAuth more in line with established authentication standards.

New Keyword to Print the ID of a Paint Layout on an Asset

A new keyword replacement has been added to Squiz Matrix to print the asset ID of the paint layout on an asset.


This keyword will print the asset ID of the Paint layout applicable for the asset on the current URL, whether asset-based, URL-based or user-defined.

This keyword can be used in conjunction with the as_asset keyword modifier which dynamically supplies an asset ID (in this case, of a Paint Layout) on a set asset_keyword. This will allow users to expose the properties and attributes of a Paint Layout within an asset's content.


The above keyword format, for example, would print the name of the asset's Paint Layout.

New Context  Functionality on JavaScript API

Five new operations have been added to provide new Context functionality on the JavaScript API. These functions can get enabled via the new Get Contexts and Set Context options on the Details screen of the JS API. 

The getAlternateContext() operation will retrieve the appropriate alternate context on the system, applicable to the current situation (e.g. site URL) based on an evaluation of a context's conditions.

The getCurrentContext() operation will retrieve the current context active on the system.

The getAllContexts() operation will retrieve all contexts that have been defined on the system.

These three operations each take the following parameters:  

  • all_info: a boolean determining whether to return all information for returned contexts. By default, these operations will return just the name and ID of contexts.
  • dataCallback: the custom callback function.

The setContext() operation sets the system to a supplied context. This operation takes the following parameters:

  • context_id: the ID of the context you want to activate on the system.
  • dataCallback: the custom callback function.

Lastly, the restoreContext() operation restores the system to the previously set context. This can be used, for example, in conjunction with the setContext() operation.

These new operations have been added to enhance the usage of the JavaScript API, providing new functionality for contexts within Squiz Matrix.

Performance Mode Enhancements

The following enhancements have been made to Squiz Matrix's Performance Mode:

  • Performance mode will now display the time spent on queries, together with the number of queries.
  • Fixed issue where some queries (those called with getXX() style functions) were being repeatedly counted. 

Additional Changes and Bug Fixes

Minor Enhancements

  • Minor Enhancement #5728: Improved Error Handling for Invalid Paths on Installation Step Scripts.
  • Minor Enhancement #5730: Rollback Truncation on Automatic System Upgrade.
  • Minor Enhancement #5845: Asset Builder Selectable Create Location Enhancements.
  • Minor Enhancement #5852: Memcache Session Handler Support on Site Network Assets.
  • Minor Enhancement #5861: Improved Error Handling for Malformed PDF Uploads.
  • Minor Enhancement #5875: Update Twitter Status Action Upgraded to Support Twitter API 1.1.
  • Minor Enhancement #5881: Enhancements to the system_integrity_fix_char_encoding.php Script. 
  • Minor Enhancement #5888: Remote Content Asset URL Tunnelling Option Warning.
  • Minor Enhancement #5889: New JS API Function to Return Metadata Schema Info. 
  • Minor Enhancement #5907: Enhancements to the system_integrity_fix_char_encoding.php Script.
  • Minor Enhancement #5913: Contextable Related Asset Metadata Fields.


  • Fixed Bug #5828: The reindexSearchIndex.php script consumes too much memory. 
  • Fixed Bug #5833: Can't download File Assets over HTTPS using IE7 and IE8.
  • Fixed Bug #5844: matrixsqlclient breaks terminal. 
  • Fixed Bug #5871: Matrix emailing the workflow initiator from previous workflow process when asset pushed to Live.
  • Fixed Bug #5876: Issue with Metadata values when Deja Vu enabled. 
  • Fixed Bug #5887: %globals_asset_contents:XXXX% produces different result between protocols.
  • Fixed Bug #5894: import_file.php script errors.
  • Fixed Bug #5895: Cancel Safe Edit status / clone asset via JS API with filter frontend user option turned on does unnecessarily escape HTML to entities.  
  • Fixed Bug #5896: SQ_CONF_REDIRECT_URL_WITH_TRAILING_SLASH redirects infinitely for a ROOT URL which is not listed main.inc.
  • Fixed Bug #5897: Getting count of internal messages does an unnecessary join.
  • Fixed Bug #5898: Viewing an inbox - improvements.
  • Fixed Bug #5900: %created_assetid% is not working with keyword modifier.
  • Fixed Bug #5904: Custom Form current_page_content keyword doesn't do JS frontend validation.
  • Fixed Bug #5906: Matrix ./?a=xxx url does not work when used inside the keywords. 
  • Fixed Bug #5911: Typos in source comments.


  • Fixed Bug #5901: Setting Form Submission asset LIVE can result in loss of all the answers.


  • Fixed Bug #5864: Using special characters in Oracle Search generates unescaped characters in file names.


  • Fixed Bug #5882: Unable to acquire locks on 'Inbox' of LDAP user with \, in CN.


  • Fixed Bug #5866: Events search not sorting when sorting by the asset attribute value.
  • Fixed Bug #5893: Run Level not restored failing to save the attributes of calendar event modification.


  • Fixed Bug #5902: RSS Data Source timeout error for some feeds.

Web Services

  • Fixed Bug #5877: SOAP Server asset sends proper HTTP authentication header.
  • Fixed Bug #5883: Oath and POST REST call problem.
  • Fixed Bug #5884: JS API calls to getAttributes on div content assets that contain keywords get evaluated. 
  • Fixed Bug #5890: JS API throws "Unable to get value of the property '0': object is null or undefined".

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.