Local vs Remote Templates

There are three types of component templates - SYSTEM, LOCAL, and REMOTE:

• SYSTEM templates are defined in the CMS "views\templates\components" folder for all sites
• LOCAL templates are located in the site's SFTP "templates\components" folder, and are automatically detected.
• REMOTE templates are located outside of the CMS server, and must be individually defined in the grid below.

Special Codes

The following Special Codes can be used in the Component Template URL. Special Codes are surrounded by three percent signs %%%:

• %%%branch_id%%%
• %%%timestamp%%%   (The current Unix timestamp)
• %%%Any key defined in Template Variables%%%

Any key defined in the Deployment Target "Params" JSON can be used as a code. For example, if the Deployment Target "Params" is set to:

  {
    "env": "staging",
    "base_url": "https://staging.company.com"
  }

The "env" and "base_url" Special Codes could be used as follows in the Component Template URL:

  %%%base_url%%%/templates/components/slideshow.html?env=%%%env%%%

Querystring Parameters for the Editor Template

The editor sends parameters to the template using the querystring. The following querystring parameters will be automatically added to the URLs:

• branch_id
• _   (Set to current timestamp for cache busting)

Separate Edit / Publish Templates

If different templates are required for "Edit" and "Publish", the URL defined in the Component Templates grid will be used as the Edit template, and the Publish template URL should be defined inside Edit template, in the <script type="text/cms-component-config"> script tag:

  <script type="text/cms-component-config">
  {
    "remote_templates": {
      "publish": "%%%base_url%%%/templates/components/banner.publish.html?source=1&_=%%%timestamp%%%"
  }
  </script>