Help Center

Menu

Clear Matrix cache tool

The Clear Matrix cache tool allows users to clear or repopulate the Matrix cache for an asset. You can also create a one-off or repeating scheduled job using this tool. These options are similar to the cache manager’s options but are available to all administration interface users.

The tool is available from Tools  Clear Matrix cache in the Matrix toolbar.

Clear Matrix cache

This section allows you to clear the cache for a particular asset, its children, or its dependents. The Clear Matrix cache section of the Clear Matrix cache screen is shown in the figure:

The Clear Matrix cache section of the clear Matrix cache screen

The fields that are available on this screen are as follows:

Choose asset

This field allows you to select which asset’s cache to clear. The additional fields displayed for this option let you clear the cache for this asset only, including its children or its dependants. You can also specify which asset types' caches you want to clear. For example, you can clear the cache for all of the PDF files under your site.

Level

Select whether you want to clear the cache for the asset only, the asset and its dependants, or the asset and its children. The asset that will be used is the asset specified in the Choose asset field.

The dependents of an asset are those that cannot exist without that asset. For example, the page contents asset of a standard page, or the question assets belonging to a custom form. The children of an asset are those that have been created underneath it in the hierarchy.
Asset types

Select the asset type. For example, if you want to clear the cache for all PDF files in your site, you would select your site in the choose asset field, this asset and its children in the level field, and the PDF file in the asset types field. You can select more than one asset type from the list by holding down either the Ctrl or Shift keys on the keyboard and left-clicking on each type. If you want to clear the cache for all asset types, select – All asset types – from the list.

Repopulate

Select this option if you want Matrix to re-cache the asset once its cache has been cleared.

Clear now

Select this option if you want to clear the asset’s cache immediately.

Schedule clear cache scheduled job (Matrix)

This section allows you to schedule a scheduled job to refresh the cache based on the previously selected settings. The Schedule clear cache scheduled job (Matrix) of the Clear Matrix cache screen is shown in the figure:

The Schedule clear cache scheduled job (Matrix) section

You can schedule either a one-off scheduled job or a repeating scheduled job. The fields available are as follows:

Schedule a one-off job

Use the fields provided in this section to schedule a one-off scheduled job. Select the date and times when the cache should be cleared from the list provided, or click on the Next run button to set the date and time to the next run of the scheduled jobs manager. Alternatively, you can set the scheduled job to take place after a predefined time (minutes, hours, days, weeks, months, or years). Enter the number into the text box and select the appropriate time frame from the list provided.

Schedule a repeating job

If you want to repeat the scheduled job, enter the time between runs in the fields provided. For example, if you want to clear the home page’s cache every two days, enter 2 days in this section. Enter the number in the first field and select the appropriate time frame in the second list.