Common Keywords

Last Updated: 25 Sep 2017

This chapter lists the default keyword replacements that are available within Squiz Matrix. These keyword replacements can be used on a majority of the assets.

Bookmarks

Asset Information

Keyword ReplacementInformation Shown
%asset_assetid%The ID of the asset. 
%asset_name%Full name of the asset.
%asset_short_name%Short name of the asset.
%asset_name_linked%The name of the asset, linked to the asset.  
%asset_short_name_linked%The short name of the asset, linked to the asset. 
%asset_type%Asset type.
%asset_type_code%Asset type code.
%asset_type_icon%Asset Map icon of the asset being displayed. 
%asset_type_icon_url%URL of the Asset Map icon of the asset being displayed.
%asset_version%Version of the asset being displayed.
%asset_version_major%Major version number of the asset being displayed.
%asset_version_minor%Minor version number of the asset being displayed.
%asset_version_micro%Micro version number of the asset being displayed.
%asset_url%URL of the asset.
%asset_url_<context>%URL of a context of an asset, where <context> is the name of the context. For example, %asset_url_Default_Context% will display the asset URL on the Default Context.
%asset_url_path%The relative URL path of the asset based on the website domain. For example, if the URL of the asset is https://www.site.com/dev/section/page, this keyword would print /dev/section/page.
%asset_url_site_path%The relative URL path of the asset based on the URL applied to the Site asset. For example, if the URL of the Site asset is https://www.site.com/dev and the URL of the asset is https://www.site.com/dev/section/page, this keyword would print /section/page.
%asset_urls%All URLs available on the asset, printed as an array.
%asset_web_path%The shortest web path assigned to the asset.
%asset_href%Relative href of the asset from the requested URL.
%asset_sibling_prev%The ID of the previous TYPE_1 or TYPE_2 asset in the Asset Tree.
%asset_sibling_next%The ID of the next TYPE_1 or TYPE_2 asset in the Asset Tree.
%asset_sibling_prev_type_1%The ID of the previous TYPE_1 asset in the Asset Tree.
%asset_sibling_next_type_1%The ID of the next TYPE_1 asset in the Asset Tree.
%asset_sibling_prev_type_2%The ID of the previous TYPE_2 asset in the Asset Tree.
%asset_sibling_next_type_2%The ID of the next TYPE_2 asset in the Asset Tree.
%asset_parent%Returns the current parent asset ID based on the current asset in its lineage context.
%asset_parents%Returns an array of asset IDs for all direct parents of the asset
%asset_children%Returns an array of asset IDs for all the direct children of the asset. You can also specify specific link types to be brought back using %asset_children_link_type_X%. For example, to return all child assets of link type 1 and 2, use: %asset_children_link_type_1_2%.
%asset_linking_info%Returns the linking information of the asset in a JSON array. This is the same information that is available on the asset's Linking screen.
%asset_linking_info_current%A JSON object of the linking information of the current asset's link only, based on its current lineage context. You can use the ^index keyword modifier to print a specific value. For example, to get the link type of the current link of the asset: %asset_linking_info_current^index:link_type%
%asset_linking_lineage%Returns the current asset lineage based on the current asset in its lineage context.
%asset_charset%The character set for the asset,
%asset_languages%The language the asset has been set to. This value can be found on the Settings screen of an asset.
%asset_data%A JSON object of the asset including its standard fields, attributes, and metadata.
%asset_data_attributes%A JSON object of the asset's attribute fields and values.
%asset_data_metadata%A JSON object of the asset's metadata fields and values.

Contents

Keyword ReplacementInformation Shown
%asset_contents%The contents of the asset. Note that this will also include the content of the Paint Layout applied based on the current URL context.
%asset_contents_raw%The contents of the asset excluding any Paint Layouts that are applied to the asset.
%asset_contents_raw_containers%The contents of the asset excluding any Paint Layouts that are applied to the asset, as well as excluding any Paint Layouts applied to the asset's Content Containers. For example, through the use of Content Container Templates.

Creation Details

Keyword ReplacementInformation Shown
%asset_created%The date and time that the asset was created. The format that will be used is YYYY-MM-DD HH:MM:SS.
%asset_created_short%The date that the asset was created. The format that will be used is YYYY-MM-DD.
%asset_created_readable%The date and time that the asset was created. The format that will be used is DD M YYYY H:MM[AM/PM].
%asset_created_readabledate%The date that the asset was created. The format that will be used is DD-MM-YYYY. 
%asset_created_readabletime%The time that the asset was created. The format that will be used is H:MM[AM/PM].
%asset_created_relative% When the asset was created, relative to the current date. For example, 3 days ago or 1 week ago.
%asset_created_relative-dow%When the asset was created, relative to the day of the week. For example, 5pm on Tuesday.
%asset_created_iso8601%The date and time that the asset was created. The format that will be used is ISO8601. 
%asset_created_rfc2822%The date and time that the asset was created. The format that will be used is RFC2822.
%asset_created_ical%The date and time that the asset was created. The format that will be used is iCalendar.
%asset_created_by_name%Full name of the user that created the asset.
%asset_created_by_first_name%First name of the user that created the asset.
%asset_created_by_last_name%Surname of the user that created the asset.
%asset_created_by_email%Email of the user that created the asset.
%asset_created_by_assetid%The asset ID of the user that created the asset. 
%asset_created_by_url%The URL of the user that created the asset. 
%asset_created_by_thumbnail%The related thumbnail of the user that created the asset. This keyword respects the various permutations of the existing asset_thumbnail keywords, outlined below.
%asset_created_X%The configured date and/or time that the asset was created, where X is a PHP date character. For example, the keyword replacement %asset_updated_F% would display the month when the asset was created (January, February etc). Please visit http://php.net/date for a full list of the date characters available. 

Last Updated Details

Keyword ReplacementInformation Shown
%asset_updated%The date and time that the asset was last updated. The format that will be used is YYYY-MM-DD HH:MM:SS.
%asset_updated_short%The date that the asset was last updated. The format that will be used is YYYY-MM-DD.  
%asset_updated_readable%The date and time that the asset was last updated. The format that will be used is DD M YYYY H:MM[AM\PM].
%asset_updated_readabledate%The date that the asset was last updated. The format that will be used is DD-MM-YYYY.  
%asset_updated_readabletime%The time that the asset was last updated. The format that will be used is H:MM[AM/PM].  
%asset_updated_relative%  When the asset was last updated, relative to the current date. 
%asset_updated_relative-dow%  When the asset was last updated, relative to the day of the week.  
%asset_updated_iso8601% The date and time that the asset was last updated. The format that will be used is ISO8601.  
%asset_updated_rfc2822% The date and time that the asset was last updated. The format that will be used is RFC2822.  
%asset_updated_ical% The date and time that the asset was last updated. The format that will be used is iCalendar.  
%asset_updated_by_name% Full name of the user that last updated the asset.  
%asset_updated_by_first_name%First name of the user that last updated this asset.  
%asset_updated_by_last_name%Surname of the user that last updated this asset.  
%asset_updated_by_email% Email of the user that last updated this asset.  
%asset_updated_by_assetid%The asset ID of the user that last updated this asset.  
%asset_updated_by_url%The URL of the user that created the asset.
%asset_updated_by_thumbnail%The related thumbnail of the user that last updated this asset. This keyword respects the various permutations of the existing asset_thumbnail keywords, outlined below.
%asset_updated_X% The configured date and/or time that the asset was last updated, where X is a PHP date character. For example, the keyword replacement %asset_updated_l% would display the day the asset was last updated (Monday, Tuesday etc). Please visit http://php.net/date for a full list of the date characters available.  

Last Published Details

Keyword ReplacementInformation Shown
%asset_published%The date and time that the asset was last published. The format that will be used is YYYY-MM-DD HH:MM:SS.
%asset_published_short% The date that the asset was last published. The format that will be used is YYYY-MM-DD.  
%asset_published_readable% The date and time that the asset was last published. The format that will be used is DD M YYYY H:MM[AM/PM].
%asset_published_readabledate%The date that the asset was last published. The format that will be used is DD-MM-YYYY.  
%asset_published_readabletime%The time that the asset was last published. The format that will be used is H:MM[AM\PM].  
%asset_published_relative%  When the asset was last published, relative to the current date.  
%asset_published_relative-dow% When the asset was last published, relative to the day of the week.  
%asset_published_iso8601% The date and time that the asset was last published. The format that will be used is ISO8601. 
%asset_published_rfc2822% The date and time that the asset was last published. The format that will be used is RFC2822.
%asset_published_ical% The date and time that the asset was last published. The format that will be used is iCalendar.
%asset_published_by_name% Full name of the user that last published the asset.
%asset_published_by_first_name%First name of the user that last published this asset.
%asset_published_by_last_name%Surname of the user that last published this asset.
%asset_published_by_email% Email of the user that last published this asset.
%asset_published_by_assetid%The asset ID of the user that last published this asset.
%asset_published_by_url%The URL of the user that last published this asset.
 %asset_published_by_thumbnail%The related thumbnail of the user that last published this asset. This keyword respects the various permutations of the existing asset_thumbnail keywords, outlined below.
%asset_published_X% The configured date and/or time that the asset was last published, where X is a PHP date character. For example, the keyword replacement %asset_published_Y% would display the year the asset was last updated (2008, 2009 etc). Please visit http://php.net/date for a full list of the date characters available.

Please note that last published means that last time theStatusof the asset was changed toLive, for example fromUnder ConstructiontoLive.

Last Status Change Details

Keyword ReplacementInformation Shown
%asset_status_changed% The date and time that the Status of the asset was last changed. The format that will be used is YYYY-MM-DD HH:MM:SS. 
%asset_status_changed_short%The date and time that the Status of the asset was last changed. The format that will be used is YYYY-MM-DD. 
%asset_status_changed_readable%The date and time that the Status of the asset was last changed. The format that will be used is DD M YYYY H:MM[AM/PM]. 
%asset_status_changed_readabledate%The date and time that the Status of the asset was last changed. The format that will be used is DD-MM-YYYY. 
%asset_status_changed_readabletime%The date and time that the Status of the asset was last changed. The format that will be used is H:MM[AM/PM]. 
%asset_status_changed_relative% When the Status of the asset was last changed, relative to the current date and time.  
%asset_status_changed_relative-dow% When the Status of the asset was last changed, relative to the day of the week. 
%asset_status_changed_iso8601% The date and time that the Status of the asset was last changed. The format that will be used is ISO8601. 
%asset_status_changed_rfc2822% The date and time that the Status of the asset was last changed. The format that will be used is RFC2822. 
%asset_status_changed_ical% The date and time that the Status of the asset was last changed. The format that will be used is iCalendar.
%asset_status_changed_by_name% The name of the user who last changed the Status of the asset. 
%asset_status_changed_by_first_name%First name of the user who last changed the Status of the asset.
 %asset_status_changed_by_last_name%Last name of the user who last changed the Status of the asset.
 %asset_status_changed_by_email%Email of the user who last changed the Status of the asset.
 %asset_status_changed_by_assetid%The asset ID of the user who last changed the Status of the asset.
 %asset_status_changed_by_url%The URL of the user who last changed the Status of the asset.
%asset_status_change_by_thumbnail%The related thumbnail of the user who last changed the Status of the asset. This keyword respects the various permutations of the existing asset_thumbnail keywords, outlined below.
%asset_status_colour% The colour that corresponds to the current Status of the asset. 
%asset_status_description% The description of the current Status of the asset.
%asset_status_code% The status code (value) of the current Status of the asset. For example, if the current Status of the asset is Live, this will print 16.

Permissions

Keyword ReplacementInformation Shown
%asset_read_permission% A comma-separated list of the full names for the users who have read access to the asset.
%asset_write_permission% A comma-separated list of the full names for the users who have write access to the asset. 
%asset_admin_permission% A comma-separated list of the full names of the users who have admin access to the asset. 
%asset_read_permission_assetid%A comma-separated list of the asset IDs of users who have read access to the asset. 
%asset_write_permission_assetid%A comma-separated list of the asset IDs of users who have write access to the asset.  
%asset_admin_permission_assetid%A comma-separated list of the asset IDs of users who have admin access to the asset.  
%asset_read_permission_email%A comma-separated list of email addresses for the users who have read access to the asset. 
%asset_write_permission_email%A comma-separated list of email addresses for the users who have write access to the asset. 
%asset_admin_permission_email%A comma-separated list of email addresses for the users who have admin access to the asset. 
%asset_read_permission_email_linked%A comma-separated list of linked email addresses for the users who have read access to the asset.
%asset_write_permission_email_linked%A comma-separated list of linked email addresses for the users who have write access to the asset. 
%asset_admin_permission_email_linked%A comma-separated list of linked email addresses for the users who have admin access to the asset.  

Roles

Keyword ReplacementInformation Shown
%asset_role_X% A comma-separated list of  full names for the users/groups who can perform a Role, where X is the asset ID of the Role.  
%asset_role_X_email% A comma-separated list of email addresses for the users/groups who can perform a Role, where X is the asset ID of the Role.
%asset_role_X_email_linked%A comma-separated list of linked email addresses for the users/groups who can perform a Role, where X is the asset ID of the Role.

Thumbnail

Keyword ReplacementInformation Shown
%asset_thumbnail% The thumbnail of an asset. 
%asset_thumbnail_title%The title (friendly name) of the thumbnail of an asset.
%asset_thumbnail_name%The file name of the thumbnail of an asset.
%asset_thumbnail_assetid%The asset ID of the thumbnail of an asset.
%asset_thumbnail_url% The URL of the thumbnail of an asset. 
%asset_thumbnail_caption% The caption of the thumbnail of an asset.
%asset_thumbnail_alt%  The alt text of the thumbnail of an asset.
%asset_thumbnail_v_<variety_name>_X%Specified attribute value for an Image Variety of an asset thumbnail, where <variety_name> is the name of the variety and X is the attribute that you want to show. For example, %asset_thumbnail_v_var1_url% will show the URL of the var1 variety.
 
For more information, refer to the Image and Thumbnail Keyword Replacements.  

Boolean (True/False) Evaluation

Keyword ReplacementInformation Shown
%asset_is_frontend_asset%Boolean keyword that evaluates as true if the asset is the current frontend asset being viewed on the current URL. Basically if it has the same asset ID as the %frontend_asset_assetid% keyword.

Paint Layout & Design

Keyword ReplacementInformation Shown
%asset_paint_layout_id%The asset ID of the Paint Layout applied to the asset based on the current URL context.
%asset_design_id%The asset ID of the Design applied to the asset based on the current URL context.

Next Chapter

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.