Notification Email Templates

Where a notification is to be sent via email, either a common default template can be used, or a custom template can be created specifically for this notification type.
For example, for an Approval Submitted notification, the default template is applied:

Default Template

An option in Global Features > Notifications lets you set the default template to use:

Note that other settings apply here too. Further details can be found in the article: Notifications Feature.

 

In this case, the default template is Notification – Instant Case Email. The template can be found in ShareDo at: Documents Admin > Document Templates > Notification Templates.

Notification templates are similar to standard email or document templates in ShareDo. Double-clicking the template opens the Edit blade, and just like standard email templates, clicking the Pack Contents nav bar allows you to configure the pack.

Configure Pack Details

  • Output Title
    Each notification generated is stored as an item within ShareDo and can be displayed in List Views. The Output Title specified here will define the notification's title.
  • Output File Name
    Each email notification will also produce a Microsoft Word document, which will be stored in the work item's DMS. This determines the file name of the Word document.
  • Email Subject
    Determines the subject line of the email.
    Note that a mixture of text and tags can be used in the Title, File Name and Subject fields. The tags presented here are legacy tags, but clicking on the icon will open the Context Browser and allow new Data Composer tags to be selected.
  • Source
    In this example, the notification template is a legacy type of Email - Notification - Markdown HTML. This means that it uses a text file with the suffix .md to set the body of the email. The text file contains text and references to ShareDo tags, but note that these are now being deprecated and replaced by the new Email - Notification – HTML type. 

Create a new Notification Email

To create a new, dynamic, rich content email notification template, navigate to Documents Admin > Document Templates > Notification Templates and click New in the top right-hand corner. In this example, we will create a new Notification – Instant Case Email that will become the default email for all notifications.

  1. Select the Email - Notification – HTML type:
  2. Enter a System Name, Name, and Description.
  3. On the Pack Contents blade, set the Output Title, File Name and Email Subject. Once more, remember that a combination of text and data tags can be used.
    Each HTML email will create an output file in DMS in the ShareDo .eml format.
  4. Click Confirm, then Save the template.

Editing the Email Body

Once the Pack details and email template are saved, you can reopen the Pack Contents nav bar and edit the email body by following these steps.

In this example, the type of notification, the work item title, and a link to the work item itself form the main body. A link to the user's notification settings is also provided.

  1. In Pack Contents, click the edit icon.
    The HTML Notification Templates editor is identical to the HTML Content Blocks and HTML Emails editors. See the guidance starting from the “Email Tagging" section on how to use the Editor: Preparing a New Email Template - ShareDo.
  2. Use a mixture of text and tags to set the message text that you require.
    To use tags, click the three dots and select the icon for the context browser.
  3. Once done, click Confirm on the editor, then Confirm again on the Configure Pack blade. Finally, click Publish on the Edit blade, which will save changes and make the latest version available for use.

Use the Refresh cache buttonat the bottom left of the page to reload all the new configuration.

To use this email as the default template, return to Modeller > Global Features > Notifications and select the template from the list of available notification templates. Then save the changes and refresh the cache.

Any notification type that uses the default template will now use the new HTML notification email.

As an example, the email is hydrated as follows when triggered via a Document Generation Failed event when attempting to generate a bundle.

Applying Templates to Specific Notification Types

You can apply a notification template other than the default for a specific notification type. To do this:

  1. Open the notification type you want to edit: go to Admin > Channels > Notification Types and select it.
  2. Clear the Use Default Template checkbox in the Notification Channels section.
  3. Select the template you want to use for this notification type with the > button.
  4. Click Confirm, then Save to finish.