Maintaining your system

The maintenance mode tool within Matrix allows you to disable the functionality of specified assets on the frontend, instead of printing a maintenance message for your users. This mode is useful during system upgrades to prevent users from making any changes to frontend assets such as custom form pages and asset builders.

When you activate maintenance mode, custom messages display on the frontend and Matrix interfaces, informing users that the system will soon be entering or is currently in maintenance mode.

5 1 0 maintenance mode message example
Figure 1. An example maintenance message on the frontend

The maintenance mode settings are available on the System maintenance screen. Access this screen from the Maintenance  System maintenance menu in the toolbar.

Maintenance mode settings

The maintenance mode settings on the System maintenance screen allow you to enable and configure maintenance mode settings within your system.

5 1 0 maintenance mode maintenance mode field
Figure 2. The maintenance mode field

The following fields are available when configuring the maintenance mode settings:

Maintenance mode

Allows you to specify the status of maintenance mode within your system. The options available are:

Disabled

Maintenance mode is disabled. The system runs normally.

Notify

Enable this option to print a notification message on the frontend, and in the admin mode and inline edit mode interfaces. These messages act as a warning to users that the system will go into maintenance mode soon. Apart from these messages, the system runs normally.

Enabled

Enable this option to turn on maintenance mode on your system. A maintenance message displays on the frontend and all Matrix interfaces, informing users that the system is currently in maintenance mode. When maintenance mode is enabled, the system disables the functionality of the specified assets on the frontend.

5 1 0 maintenance mode message fields
Figure 3. The maintenance mode message fields
Back end notify message

Type the message to display on affected assets in the back end when you set the maintenance mode Notify status.

If you do not customize the message, the default message displays to users: "This Matrix system will soon be entering maintenance mode. Please save your work and consult the system owner for further information."

Front end notify message

Enter the message to display on affected assets on the front end when you set the maintenance mode Notify status.

By default, this message reads, "This website will soon be undergoing maintenance. Some website functions are temporarily disabled."

Back end enabled message

Enter the message to display on affected assets in the back end when maintenance mode is enabled.

By default, this message reads, "This Matrix system has entered maintenance mode. Please consult the system owner before making any changes."

Front end enabled message

enter the message to display on affected assets on the front end when maintenance mode is active.

By default, this message reads, "The website is currently undergoing maintenance. Some website functions are temporarily disabled."

5 1 0 maintenance mode affected asset fields
Figure 4. The affected asset types and affected and excluded root nodes fields
Affected asset types

Select the asset types that will be affected when maintenance mode is enabled.

By default, the following asset types are available in this field:

  • Asset builder page

  • Custom form

  • Account manager page

  • Checkout page

Affected root nodes

Select the root nodes that maintenance mode will affect.

Only the asset types selected in the Affected asset types field under the specified root node will be affected.

The root folder (Asset ID #1) is selected as an affected root node meaning that all assets in the system of the specified asset types will be affected.

Excluded root nodes

Select any root nodes to exclude from maintenance mode. No assets under a root node selected in this field will be affected when maintenance mode is enabled. By default, no root nodes are excluded.

Retry-After response header value

When maintenance mode is enabled, affected assets will send a 503 Service Unavailable and a Retry-After response header to the requesting client. This setting indicates that the page is unavailable and to try again after the specified time value. The default for this field is 3600 seconds (an hour). This field also accepts HTTP-date values.

© 2015-2020 Squiz Pty Ltd