Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Related Permissions/Services

“Create Email Notification”, “Read Email Notification”, “Delete Email Notification”, or “Update Email Notification” permission on any service defined in “Admin Console Supported Services on page 17.

Email The Email notification card and Email notification menu bar let admin user administrators manage Email notificationNotifications. Email notification pages can only be only accessed if admin user has proper the administrator has any of the following permissions on at least one of the services defined in Admin Console supported services on page 18. “Read Email Notification”, “Create Email Notification”, “Update Email Notification” and “Delete Email Notification”. Following table shows Email Notification tasks and associated permissions.MTOA supported service:

  • Create Email Notification

  • Read Email Notification

  • Update Email Notification

  • Delete Email Notification

The table below describes what an administrator can do with a given permission. 

 

Read Email Notification Permission

Create Email Notification Permission

Update Email Notification Permission

Delete Email Notification Permission

Create and invite users in any service

View Email list

ü   

 

 

 

See note below

Create new Email

 ü 

 

 

 

Edit an Email

 

 ü 

 

 

Preview

ü   

 

 

 

Delete an Email

 

 

 ü 

 

Note: A user with a the special permission "Create and invite users in any service" in "myTC Account Administration" service, need to be enrolled in a given service with permissions as described above to read and manage email notifications.

This page displays all notification templates, if none exist then the table will be empty. You can manage existing notifications and create new ones. This page can be only accessed if you have the user has the proper Read Email notification permissionspermission.

NB: When a regular user is assigned to a specific service with some permissions for email notification notifications in that service, those permissions are applicable to all email notification notifications created in for that service.

...

Add

...

New Email

...

 

Add New Template

...

Notification

This allows administrators to create a new email template. This action requires Create email notification permission otherwise, the notification templates and requires the Create Email Notification permission. Without this permission, the “Add a new email notification template“ button will not be displayed as shown below.

...

Edit Email

...

Notification Template

The Edit button allows admin user administrators to update an email template. The action requires Update email notification email notification templates and requires the Update Email Notification permission. If there is no update permission on a given service, the Edit button will not be displayed as shown below.

...

 Add Email template and Edit Email template

...

pages

 

 

...

Template Name

The name of the email notification template. You cannot reuse the same name of an existing template or you will get validation error. notification.
This field is required when creating a new template. In edit pagenotification. When editing, this field is read-only and cannot be modified.

Template name now only be supplied with safe charactersThe following rules apply to characters used in the notification name:

  • No special characters are allowed

  • No spaces allowed (instead you should use dash or underscore, which are allowed)

  • Should start and end with an alphabetalphabetical character

  • Use numeric, upper and lower case letters

  • dashes Dashes (-), underscores (_), quote marks ('), commas (,) are allowed

  • accented Accented characters are allowed however but will be converted to their base non-accented equivalent characters

Service

Displays This field displays a list of supported services based on admin console supported services and admin user’s permissions. On the current administrators permissions.
For example, on the Create Email template Template page, the services displayed are those where admin user has create email permission. On Edit Email template page, the administrator has the Create Email Template permission. Similarly, on the Edit Email Template page, the services displayed are those where admin user has edit email permission.the administrator has Edit Email Template permission. To select more than one service from the list you must hold the CTRL key on the keyboard.

Has Subject Parameters

Check this field if the English/French subjects will have any parameters.

English/French Subject

The subject of the email notification.

Has Body Parameters

Check this field if the English/French body will have any parameters.

English/French Body

Contain Content of the email notification.

 

 

Save

Saves the email notificationsnotification, then returns to the notifications list.

Cancel

Stop ongoing action and returns to the notifications list.

Template Parameters

Parameters is are text inside the subject and body that is contained between these two characters “{}”.
In the image below you can see an example of how parameters (indicated in red rectangles) are used in the subject and body. There’s There are no limit on the amount of parameters that can be used.

...

Preview Email notification

This page lets you add values to the parameters. In the image below you can see an example of the parameters being replaced by text.

...

Send a test email

Sends you an a test email with all of the parameters being replaced with the values provided.

Cancel

Returns to the email notification list.

Email Preview

Below is an example of the email that was received.

...

Delete

...

Delete action removes an email notification from the list and requires delete email the Delete Email Notification permission. Before deleting an email , notification a confirmation message pop up. The email template is displayed.
After confirmation, the email notification is removed from the email notices list once delete button is clicked. Cancel button stops the process.  

...

Without delete permission on a given service, the delete button will not be displayed as shown below.

...

Validation

This is an example of a validation summary. The number of validation errors is displayed. A link to the field where the validation failed is provided. The field where the validation failed will also have message.

...