In this release, we focused on improving the operator and developer experience of our template and property keys. We reviewed naming conventions, improved the rules for enforcing uniqueness and refreshed validation and notification messaging.

What are keys?

Keys are automatically created during the setup of Experience and Collection templates. They are generated when a template or property is named. These keys must be unique to prevent breaking code, and are therefore locked once the template or property is first published.

(NOTE: these improvements will not cause breaking changes for any existing users, and no action is required.)

Here’s a summary of what’s been done:

Template keys | Improvements and rules

We’ve improved the duplicate key check process by refreshing the notification and error messaging and introducing new naming rules, for example:

  • Multiple underscore characters ‘_ _’ will auto-correct to a single underscore ‘_’.

  • Only lowercase alphanumeric characters and single underscores can be used.

  • Spaces ' ' in names will automatically convert to underscores '_'.

  • Only the ‘untitled’ part of the key is editable. The suffix ‘_experience’ or ‘_collection’ is added automatically.

  • Certain keywords like class, var, break, public, private, switch, new are reserved and cannot be used in key names. See full reserved keyword list here.

Image of Experience template showing error messaging.

Property keys | Improvements and rules

A property key is generated when a property (text box, number field, tag element etc.) is added to an Experience template during setup. We've improved the notification and error messaging, and introduced new naming rules, for example:

  • Multiple underscore characters ‘_ _’ will auto-correct to a single underscore ‘_’.

  • Only lowercase alphanumeric characters and single underscores can be used.

  • Spaces ' ' in names will automatically convert to underscores '_'.

  • Certain keywords like class, var, break, public, private, switch, new are reserved and cannot be used in key names. See full reserved keyword list here.

Image of Experience showing property key with error messaging.

Section keys | Improvements and rules

A section is a placeholder in a Collection template that can hold up to 20 Experiences. Every time a section is added and published; a unique key gets generated. We've improved the notification and error messaging and introduced new naming rules, for example:

  • Multiple underscore characters ‘_ _’ will auto-correct to a single underscore ‘_’.

  • Only lowercase alphanumeric characters and single underscores can be used.

  • Spaces ' ' in names will automatically convert to underscores '_'.

  • Only the ‘untitled’ part of the key is editable.

  • Certain keywords like class, var, break, public, private, switch, new are reserved and cannot be used in key names. See full reserved keyword list here.

Image of Collection template showing section with error messaging.

-----------------------------------------------------------------------------------------------------------------------------

| For more information on mtribes, visit our Help Center, or leave us a message on the chat widget at the bottom of the page.

Did this answer your question?