Getting Started with Notification Templates

Overview

Notifications are important as they enable people to stay up to date on work progress via email delivery. Administrators can configure notification templates that determine the email content and layout for their organization. 

Where to Find This

Navigate to Notification Templates following these paths:

• Standard Application Notification Templates
  • TDAdmin > Notification Templates > [choose type of template] > [select template]
• Application Specific Notification Templates
  • TDAdmin > Applications > [Application Name] > Notification Templates > [select template]
  • As an application administrator:
    1. Work Management > View Applications > [Application Name]
    2. Select the Gear icon on the right side of the upper menu bar
    3. Select Admin > Notification Templates > [select template]

Where to Start

Notification Templates exist throughout the system for a variety of applications and components. This allows custom email templates to be controlled on an action-by-action basis, with each action limited to the scope of an application. If the custom template is not enabled for a specific action, the default template will be used instead. 

Template Information by Application or Component

Notification Footers

Notification footers allow additional customization for notifications.

Notification footers include a text footer and an HTML footer, which will be included at the bottom of the email. The former is used when plain-text emails are delivered, while the latter is used for HTML-formatted emails. If an HTML-formatted email is being delivered and HTML footer information is not provided, then the text footer information will be used instead. Notification footers can also include a tracking pixel at the bottom of the email. If this is enabled, then a corresponding Read By entry is created for the item in TeamDynamix when the user reads the email.

Template Configuration

When editing a notification template, the available information is encapsulated by Template Tags. This changes on a per-application basis so that only relevant information can be included for an email. These tags can be used to include helpful information for both the email Subject and Body, and are of the format {{FieldName}}. All available fields for a notification template are present in the Template Tag dropdown. This uses the Mustache markup language, which has documentation available here: http://mustache.github.io/mustache.5.html.

Follow these steps to add a template tag to the Subject or Body fields:

1. Place your cursor in the Subject or Body field at the place where the template tag should be inserted.
2. Choose the appropriate field in the Insert Template Tag dropdown. It will be inserted where your cursor is.

Template tags can also be used to insert a section of HTML content that only displays when the section tag evaluates to True or a not empty value. A section starts with a tag with a pound sign and ends with one with a slash, as follows: 

{{#TemplateTag}} ... snippet ... {{/TemplateTag}}

As an example, the default Project Comment Added Template includes this section, which displays the old status and new status if the Description tag has a value: 

{{#Description}}
<!--Description-->
<tr>
  <td style="font-size: 17px; font-weight: bold; color: #515A61; padding-top: 10px; border-top: 1px solid #0072C6;">Description
  </td>
</tr>
<tr>
  <td style="font-size: 16px; padding-top: 0px;">{{{Description}}}
  </td>
</tr>
{{/Description}}

Sections can also display when the opposite is true, by switching the pound sign for a caret. The following would include a message that no description is provided if the Description field is empty: 

{{^Description}}
<!--No Description-->
<tr>
  <td style="font-size: 17px; font-weight: bold; color: #515A61; padding-top: 10px; border-top: 1px solid #0072C6;">Description
  </td>
</tr>
<tr>
  <td style="font-size: 16px; padding-top: 0px;">No Description was provided.
  </td>
</tr>
{{/Description}}

Custom Attribute Sections

A special type of section is available, which allows you to include all the custom attributes on an item. For notifications that support custom attributes, the {{#CustomAttributes}} section will repeat once for each valid custom attribute on the item. Within this section, you can define how the HTML displays, and can include the attributes' Names and Values using the {{Name}} and {{Value}} tags. 

A custom attribute will be valid for including in the {{#CustomAttributes}} section if it:

• Has a value
• Is not a protected custom attribute
• Is marked as Client Visible (for custom attribute types that support this setting)
• Matches the project's current type (for project custom attributes only)

Individual Custom Attributes

Each individual custom attribute is also available as a section in the Insert Template Tag dropdown. These will insert a section with a tag based on the custom attribute's ID, with the name of the attribute in an HTML comment tag. 

{{#Attribute61902}}<!-- AttributeName -->{{Name}}: {{Value}}{{/Attribute61902}}

Inside the custom attribute, you can use the same {{Name}} and {{Value}} tags to define exactly how you want the attribute to display.

Activating or Deactivating Templates

Activating a Template

Each notification must be activated before it can be used for notification.

1. Open the notification template that you wish to activate
2. Click the Activate button at the top.

Deactivating a Template

If a template is deactivated, the default template will be used for this notification. 

1. Open the notification template that you wish to activate
2. Click the Deactivate button at the top.