Create a Template

Creating a Notification Template is handled by the Notifications->Templates view

🚧To create a Notification Template, please follow the steps below:

1

Navigate to the Notifications Templates View

The Notifications Templates view handles Notification Templates for the system

🚧To navigate to the Templates view:

  • Click on the Notifications -> Templates link via the navigation bar

After, the Notification Templates view will display

2

Open the Create Template View

The Create Template view handles creating new Notification Templates

🚧To open the Create Template view:

  • Click the Add button located above the Notification Templates Table.

After, a Create Template view will display.

3

Populate the Core Properties

The Core Properties panel handles entering general properties of a Notification Template

🚧To populate the Core Properties of the Notification Template, follow the sections below

Populate the Template Name

The Template Name is display name for the Notification Template. This can have characters, numbers, and special characters

  • Enter the new Template Name into the Template Name input

Populate the Template Mnemonic

The Template Mnemonic is a unique identifier for the Notification Template. This can have character, numbers and some special characters.

‼️White spaces (i.e. [SPACES]) are not allowed

  • Enter a new Template Mnemonic in the Template Mnemonic input

Populate the Tags

The Tags is a descriptive keyword to use with this Notification Template

  • Enter as many Tags in the Tags input

Removing a Tag

To remove a tag, click the ✖️ icon on the Tag

4

Populate the Template Parameters

The Template Parameters are variables that can be provided for the Notification Template. The Notification Instances will use these to populate data into the Template.

🚧To populate the Template Parameters:

  • Enter a new Name into the Parameters Name input

  • Enter a new Description into the Parameter Description input

Adding Parameters

Adding more Parameters is handled by the Add new parameter button

🚧To add a new Parameter — Click the Add new parameter button

Removing a Parameter

Removing a Parameter is handled by the X button

🚧To remove an existing Parameter — Click the X button

5

Populate the Default Content

The Default Content is the Content that will be used by default for the Notification Template.

When the Default Content is used

If only Default Content is populated, this will be the contents used for all instances of the Notification Template.

If multiple Translations are defined, the translation which matches the Target User will be used, otherwise the Default Content will be used

🚧To populate the Default Content of the Notification Template:

Populate the Subject

  • Enter a new Subject for the Notification Template into the Subject input

Subject

The Subject is the subject field for a notification (e.g. Subject of an email, etc...)

The Subject input will accept the following:

  • Static text

  • The parameters defined in the Template Parameters

Populate the Body

  • Enter a new Body for the Notification Template into the Body input

Body

The Body of the Notification Template is the message that will be sent as a Notification (e.g. Body of an email, etc...)

The Body input will accept the following:

  • Static text

  • The parameters defined in the Template Parameters

6

Populate Translations

Translations are different Contents for the Notification Templates that can be used in the case that a Preferred Language is defined for a Target User

Translations

The Translated messages will be used in cases where the target user has specified a preferred language.

Otherwise, it will default to the Default Content

🚧To populate a Translation for the Notification Template:

Create a new Translation

  • Click the Add Translation button

After, a new Translation Panel will display

Populate the Subject and Body

  • Enter the Subject for the Translation of the Notification Template in the Subject input

  • Enter the Body for the Translation of the Notification Template in the Body input

Adding more Translations

Repeat the above steps:

  • Create new Translation, and

  • Populate the Subject and Body

for as many other Translations this Notification Template will need

Removing Translations

Translations can be removed by using the Remove Translation button

🚧To remove a Translation:

  • Click the Remove Translation button

7

Save or Publish

Saving as Draft or Publish will allow you to save the Notification Template

Saving as Draft

Saving as Draft will save the Notification Template but will prevent the Template from being used until the Template has been completed and enabled.

Publish

Publishing will save the Notification Template and allow Notification Instances to be created using this template, or allow existing Notification Instances to now use this Notification Template

🚧To save the Notification Template:

  • Click the Save as Draft button or Publish button (depending on your preference and completeness)

After, the Create Template View will close and a success notification will appear in the top right-hand corner of the screen

8

Verify the Notification Template

In this step, we will verify the Notification Template was successfully created by locating the new Notification Template in the Notification Templates Table

🚧To verify the Notification Template was created successfully:

  • Search for the Notification Template in the Notification Templates Table

PreviousTemplatesNextEdit a Template

Last updated