Trigger actions

The action creates a new remap for an asset when it is fired. The short URL is a combination of the asset’s site and its ID. An example is http://www.example.com/1234 (where 1234 is the ID of the asset where the trigger was fired).

This action adds another URL to the asset.

This action adds another web path to the asset.

The following fields are available:

This action allows you to add the current user (that is, the user who fired the event) to a specified user group or list of groups. The user group linking settings section allows you to configure the linking settings to use when assigning the user to the specified user groups. The fields available in this section are as follows:

The user groups to join by name section allows you to specify the user groups to assign the user by asset name. The fields available in this section are as follows:

This action calculates the average percentage rating for all comment assets under a particular root node and the total comments that have been added. The values are then stored in the specified metadata fields on the root node.

Select in which metadata fields to store the values. For this to work, the metadata schema that contains the metadata field needs to be applied to the root node.

This action allows communication with web services exposing themselves using representational state transfer (rest) methods.

Read the Web services assets documentation for more information on these fields and the functions of the call REST resource trigger action.

This action clears the cache for one or more assets. For example, if you have an asset listing showing all of your documents, you may want to clear its cache when a new document is added to your site. You can select to clear the cache for the asset on which the event is fired and any other assets in the tree.

The following fields are available:

This action clears Squid Cache on the URL(s) of the asset that fired the event. The setup of the clear squid cache command run on this trigger is specified in the Squid Cache preferences section of the External tools configuration screen. Please note that these settings must be configured before using this trigger action.

Review the Clear Squid cache tool chapter for more information.

This action clears existing sandbox session variables on your Matrix system.

To clear all session variables, select the Clear all session variables field. Please note that selecting this option will override any other settings on the clear session var trigger action.

Alternatively, you can choose to identify particular session variables to clear using the clear session variable(s) with the field, specified by either name or prefix. Select the attribute to match against and enter the value that will be evaluated. For example, you can select the prefix option and input the value soap_ to clear session variables that begin with soap_ (this could be session variables generated by a Make SOAP call form submission action).

This action creates another asset. The following fields are available:

This action creates a clone of the asset that fired the event and links it to another asset.

The following fields are available.

This action will create a design customization of a design.

The fields provided allow you to change the name of the design customization. By default, the design customization name will have the format of %asset_name% - customization. To use additional keyword replacements, select the keyword replacement from the list provided. It will appear within the second field.

This action will create a file asset of a specific type, for example, an image.

The following fields are available.

This action creates an image variety, which is a different-sized version of an image within the system. For example, you could use this trigger action to create an image variety when an image is created within the system.

To see an example of how this trigger action works, check out the tutorial on how to create image varieties using a trigger.

The following fields are available.

This action links the asset that fired the event to another asset.

The available fields are:

This action decreases the hit count for an asset by one. You would use this action in conjunction with the hit count listing page.

Please note that this action will only appear when you have the data module installed in your system.

This action allows you to delete bulkmail users from your system based on their email address.

The available fields are:

GET, POST, and SESSION values can be set as the root node, emails, and link under node parameters of this trigger action.

This action deletes a link between the asset that fired the trigger and an asset specified within this action. When the trigger is fired, a scheduled job will be set up to remove the link at the specified time.

The available fields are:

This action allows you to delete any future permission scheduled jobs that have been created for the asset that has fired the trigger.

Select which type of permission change you want to delete on the scheduled job. For example, if you want to delete any future permission jobs for write permission, select write in the list provided.

This action removes any future status jobs of a certain status for the asset.

For example, you may want to remove any future status jobs that will set the asset to Live if it has been made Live manually.

From the list provided, select the status for the future status job that you want to delete.

Use this action in conjunction with the Set future status action to delete any jobs that exist before creating a new one.

Using the Delete future status action, you can delete the existing future status job and create a new one with updated date and time. Therefore, the home page will only be reviewed if its status has not been changed to live within the last three months.

This action removes either a single image variety or all varieties under a specified image asset.

The available fields are:

This action allows you to set a SQL query for a selected database.

In the connection type field, select which type of connection to use, enter the account and database details into the connection setup fields and enter your query into the SQL query field. Within the query, you can use keyword replacements and global keyword replacements. For more information on these keyword replacements, refer to the Keyword replacements manual.

Please note that this action will only appear when you have the data module installed in your system.

This action will increment the hit count of the asset by one. You would use this action in conjunction with the hit count listing page.

Please note that this action will only appear when you have the data module installed in your system.

This action will increment the version number of the asset that fired the event.

Select which version number will be incremented from the list provided. You can increment the major, minor or micro version number.

This action issue a unique counter integer to a session variable. This can then be used in conjunction with the counter number issued event to apply the issued integer within your system, for example, as a metadata or asset attribute value.

The issue counter value action can be used for various applications, such as assigning member ids to newly created user accounts.

The fields available are as follows:

This action will dynamically link the current user to a user group for the remainder of the sign-in session.

In the available fields, specify the user group to which to link the current user dynamically. This user group is identified by asset ID, either selected through the asset tree or retrieved through a keyword replacement.

When the trigger is fired, the currently logged-in user will be linked to the user group for the remainder of the sign-in session. This allows a user to be associated with a user group without being physically linked to it.

Select the Remove user from previously joined session groups field to remove the current user from any previously joined session groups before being linked to the specified user group.

This action will temporarily remove the current user from one or more specified user groups for the remainder of the sign-in session.

When the trigger is fired, the currently signed-in user will be temporarily removed from the specified user groups for the remainder of the sign-in session. This allows a user to be disassociated from a user group to which they would otherwise be linked.

This action will send a message to a remote SOAP server when the trigger is fired.

The make SOAP call trigger action supports both SOAP 1.1 and SOAP 1.2 standards. Please note, however, that this trigger action does not currently support ws-security features and mime multi-part attachments.

The Make SOAP call trigger action works similarly to the custom form’s Make SOAP call submission action. For more information on how to configure these settings, refer to the form contents chapter of the custom form manual.

This action allows you to morph an asset into a new compatible asset type.

The asset types available to morph to will be dependent on the original asset type of your asset.

Only user and file type assets can be morphed.

This action will allow Matrix to integrate with Parse, mobile backend-as-a-service (MBaaS) provider, to send push notifications to a mobile device application.

The Parse API details section provides the configuration options of the Parse API. Please consult the parse documentation during the application setup process for more information on retrieving the keys, strings, and tokens required in this section.

The following fields are available in this section:

The following fields are available in this section:

This action will allow you to redirect the user to the specified URL.

In the field provided, enter the URL to which the user is directed.

This action releases any locks held on the asset that fired the event. For example, you could use this trigger action to release a user’s locks when they log out of the system.

Select this action to release the locks for the asset that fired the trigger or for the assets that the trigger locked. The second option only works for user accounts such as user and backend user.

This action reloads a user if external authentication variables are present. This is best used to keep someone from logging themselves out and logging in as another user when authenticated by external means by using this action in conjunction with the user logout event.

This trigger action removes any future lineage scheduled jobs on the asset that fired the event. This will effectively cancel any future links on the asset.

In the Type field, select whether to remove future lineage scheduled jobs of type Create or Delete. This allows you to specify whether to remove future jobs only when a link is either created or deleted. Alternatively, you can specify to delete all of these scheduled jobs, regardless of the future link type, by selecting Create/Delete.

This action removes the links between the asset that fired the trigger and its parents. You can limit which links to remove based on the type of link, the link value, and asset types. For example, you can delete a link between an asset and its parent if the parent is a standard page and it is a menu link.

The fields available are as follows:

This action removes either one or all metadata schemas from the asset that fired the event.

Either select the metadata schema to remove in the asset finder field provided or click Remove all metadata schemas (optional) to remove all metadata schemas. To cascade the change to the child assets for the asset, select the Cascade schema changes option.

This action deletes any remaps that match the URL of the asset that fired the event.

Select the first option to delete all remaps where the remapped URL matches the URL of the asset. Select the second option to delete all remaps where the original URL matches the URL of the asset.

This action removes a URL from the asset that fired the event.

The following fields are available:

This action removes non-running workflow schemas on the asset that fired the event.

Select the workflow schema to remove and determine whether or not to cascade this removal to all children of the asset.

This action replaces the content of a file asset type with a file that is stored on the server. Please note that this action will only work when the asset that fired the event is a file type asset (that is, file, image, PDF file, MS Word document) and will otherwise fail for all other asset types.

Enter the full path of the file with which to replace the content of the asset.

This action resets the hit count. You would use this action in conjunction with the hit count listing page.

Please note that this action will only appear when you have the data module installed in your system.

This action schedules a bulkmail job to run when the trigger is fired.

The following fields are available:

This action will send an email when an event occurs. For example, you may want to send a user an email notification when their account details have changed.

To learn more about how this trigger action works, refer to the Configuring a trigger to email a site administrator example in this manual.

The following fields are available:

You can select the Add new file attachment checkbox to configure file attachments on the email. Once you have selected this field, select Save; the file attachment settings section will be displayed on the screen.

The fields available in this section are as follows:

This action allows you to send a custom HTTP response header as part of the Matrix page build request. This can be useful when using the action in conjunction with an asset accessed trigger event.

This trigger action will only fire in the front end and won’t be fired if the asset is accessed through the admin or edit interface URLs.

The following fields are available:

This action sets an attribute value of a particular asset type.

By default, no asset type is selected. To use this action:

Selecting the Replace keywords in the set value field will replace any keyword replacements specified in the attribute value field with the firing asset’s corresponding values.

This action will set the time for the cache to expire for the asset that fired the event. For example, you can set up a trigger to set the cache expiry ten minutes after a standard page’s content is changed.

The following fields are available:

This action allows a cookie to be set for the asset that fired the event.

The following fields are available:

This action sets the design for an asset, either as a default or override design.

You can also choose whether to set it as a frontend, sign-in, or user-defined design.

This action is used within import scripts and should not be used within the administration interface.

This action is used within import scripts and should not be used within the administration interface.

This action sets the contents of a file asset.

The following fields are available.

This action sets the force secure setting for the asset that fired the event.

In the force secure field, select either Allow all protocols, Force secure protocol (HTTPS), or Force insecure protocol (HTTP). Read the Asset screens documentation for more information on these options.

This action sets a future linking job for the asset that fired the event.

The following fields are available.

This action sets a future permission job for the asset that fired the event.

The following fields are available.

This action sets a future status job on the asset that fired the event.

Select the status for the future status job and specify when it should be set. The options available are as follows:

You can specify an offset for any of the above options, before or after the specified value, in days, hours, and minutes. This means, for example, if you have selected the immediately when this trigger is fired option, configuring an offset of 2 hours after would mean that the future status would not be set until two hours after the trigger is fired.

Select the cascade field to also apply the status change to all children of the firing asset.

The error message field allows you to configure a custom error message to display if the date of the future status job is set in the past. For example, when a user causes a trigger to fire, the trigger attempts to set the future status job on the asset. If the specified date is not in the future, you cannot set this job - you can configure this error message to be displayed under these circumstances.

The treat as fatal error option allows you to treat any errors on the set future status action (where the date of the future status job is set in the past) as fatal errors. This means that if you cannot set the job, the trigger will fail and stop the script execution. For example, if the event used to fire the trigger is before the asset is created, a fatal error will prevent the asset from being created.

This action sets the index page of a site.

Select the asset to use as the index page of the site.

This action sets the date and time for a metadata date field.

Select which metadata date field to set and enter the number of months, days, hours, and mins from which you want to set it. For example, if you enter 5 days, the date-time will be set to five days from when the event was fired. When a metadata field is set, the set value in this context field will appear. In this field, select a configured context in the system to set the date-time value.

+ For example, setting this field to an alternate context will only set the metadata value for that specific context. By default, the option uses currently active context at the time of firing is selected. For more information, refer to the contexts manual.

This action is commonly used in conjunction with the metadata time trigger event and trigger action.

This action will apply a metadata schema to the asset that fired the event.

Select either apply or deny from the list provided and choose the metadata schema. Select whether or not you want to cascade the schema to the child or dependant assets of the asset that fired the event.

This action will set the value of a metadata field.

Select the metadata field to set in the field provided and select Save - additional fields will appear. Set the value of the metadata field in the field provided. Alternatively, you can use the parameter and source fields to populate the metadata field with information from the asset that fired the event.

You can also select a specific context to set the metadata value in. In the Set value in this context field, select a configured context on the system to set the value in. For example, setting this field to an alternate context will only set the metadata value for that specific context. By default, the option uses currently active context at the time of firing is selected.

Read the Using contexts documentation for more information.

This action applies a paint layout to the asset that fired the event.

Select the paint layout that you want to apply to the asset in the top field. If you want to override a paint layout, select the paint layout in the second field. Alternatively, you can use the parameter and source fields to select an alternative asset ID for either field.

This action sets the permission of the asset that fired the event.

Select to either grant, deny or delete read, write or admin permission for a particular user, user group, or role. Alternatively, you can use the parameter and source fields to set the user’s permission that fired the event.

You can also select only to update the dependant assets or the parent asset of a dependant asset. For example, if a bodycopy asset fired the event, the standard page would be updated, as it is the parent asset.

This action applies a role to the asset that fired the event.

To add a new role, select the role in the first field and select either a user or user group in the second field. You can add additional users or user groups by clicking on the More…​ button. The user who fired the trigger can be assigned to the role by selecting the use current user (one who fires the trigger) field.

The Cascade roles to dependents field allows you to cascade the role to all child assets of the asset that fired the event. The Delete all the users from the role before assigning new one field allows you to delete any existing users on the role before the new user(s) is(are) added.

Matrix allows you to store values in a session-level array, which can be used in turn in a dynamic parameter (that is, parameter map). These values can only be set using this trigger action.

Enter the session variable name and value into the fields provided. Please note that the current asset parameter source refers to the asset that fired the trigger.

Once set, you can access the session variable using the global keyword of %globals_session_<variable>% where <variable> is the name of your session variable entered into the text field of this trigger action.

This action allows you to set the asset that fired the event as the special page of a site.

Set the asset that fired the event as either the index, not found, or archived asset page of a selected site. Any existing special pages can be overridden by selecting the override the existing special page field. The Use the direct parent sites of the broadcasting asset field allows you to set the asset as a special page of its direct parent site(s).

This action sets either the created, last updated, published, or status last changed asset date for the asset that fired the event.

The following fields are available:

This action sets the status for the asset that fired the event.

Select the status to set the asset to from the list provided. You can also select only to update the parent asset of a dependant asset. For example, if a bodycopy asset fired the event, the standard page would be updated, as it is the parent asset.

This action allows you to set a new SugarCRM record ID attribute for a Matrix user asset.

The following fields are available:

This action allows you to tag the asset that fired the event with a thesaurus term.

Select the thesaurus term with which to tag the asset. Alternatively, you can choose to remove the tag from the asset by selecting remove instead of setting this tag or cascade the changes to all child assets for the asset that fired the event. Multiple thesaurus term tags can also be assigned, generated by array-based selections sourced from either GET, POST, or SESSION variables. For example, tags generated by checkbox submissions.

This action is used within import scripts and should not be used within the administration interface.

This action will take an asset ID of an image asset sourced from either GET, POST, or SESSION variables and apply it as the thumbnail for the asset that fired the event. This action will also override any current asset used as the thumbnail image.

This action will apply a workflow schema to the asset that fired the event.

Select either apply or deny from the list provided and choose the workflow schema. Select whether or not you want to cascade the schema to the child or dependant assets of the asset that fired the event.

This action lets you sort asset children of the asset that the trigger is firing on. For example, you could set up a trigger action that fires on asset-created events to always put newly created assets at the top of the asset tree order.

This action allows you to sync a Matrix user asset to a SugarCRM record ID by assigning the ID as a special attribute on the user. The SugarCRM record ID attribute gets stored on the Details screen of the user asset the trigger fires on.

When this trigger action fires on a user asset, it will first try and search for a record within the nominated SugarCRM system to see if it already exists. If it exists, it will return that record data and assign the ID of it to an attribute on the Matrix user.

If it doesn’t find the record, it will make another call to the SugarCRM system and create a brand new record. This will, in turn, return the data of the new record and assign the new ID to the Matrix user.

You must have a configured and connected SugarCRM token asset to use this trigger action.

The Sync settings section allows you to configure which SugarCRM token to use and which module and record ID to sync. The following fields are available:

The record linking settings section allows you to configure record to record linking if the record exists in multiple modules. Matrix will use the SugarCRM linking rest API call to perform this action.

The following fields are available:

This action allows you to generate a custom error message and optionally block the execution of an event. For example, say you had a rule that says all images should be created within the media folder. To stop a user from creating an image in your site, you can create a trigger that listens for the Before asset created event and checks that the asset is of type image.

This action allows you to update the status of internal messages found within a user’s Matrix inbox. For more information on a user’s inbox, refer to the My account chapter in the concepts manual.

By default, this trigger action will update the status of internal messages for the user who fired the event. You can use the action on the Other assets tool to specify alternate user accounts to which to use this action. For more information on this tool, refer to the adding and maintaining triggers chapter in this manual.

In the Message action field, select the action you want to perform on the user’s internal messages. The following actions are available:

The Message source field allows you to select which internal messages will be affected by this action. The options available are:

Alternatively, you can configure a dynamic parameter to set the messages that this trigger will action on through a comma-separated list of message IDs.

This action allows you to update the link type and value of a link.

In the Link characteristics section, specify the link to update by entering its ID in the Link ID field.

OR

Alternatively, you can configure a set of attributes to match a link against the firing asset of the trigger. The attributes that can be identified are link type, link value, side of link, and asset type. Please note that if you have configured a set of attributes to match against, the Update link action will only execute if exactly one link match is found.

In the new Link characteristics section, enter the new link type, and link value attributes for the link. You can use both regular and global keyword replacements when setting the link value in these fields.

This action will POST a 'tweet' on a Twitter account, based on the asset’s content that fired the event.

This action allows Matrix to integrate with Urban Airship, a push messaging and marketing solution, to send push notifications to a mobile device application.

The Urban Airship API details section provides the configuration options of the Urban Airship API. Please consult your Urban Airship documentation during the application setup process for more information on retrieving the keys, strings, and tokens required in this section.

The following fields are available in this section:

The Push notification details section allows you to define the settings of the push notification sent to mobile devices. The following fields are available in this section: