Skip to end of metadata
Go to start of metadata


The purpose of this page is to explain how and where an email notification extracts the information from e.g. where and how to find template ID, Syntax tags used in the email.


The following sections describe in detail the components that make up an email notification.

Steps to Research Notifications

  1. Analyze e-mail message received by user
  2. Locate the notification template used
  3. Break down the anatomy of a template:
    1. Message structure -- Body, subject(s), and vcal
    2. Message content -- Use of tags, text, labels and loops

1. Look at the email received

Body displays dynamic data - student name, user ID, item type, item ID, item rev date, start date and time. Also contains text (highlighted in yellow in screenshot above) such as “has a class” and “starting on”. Content repeats for each student.

2. Locate the Notification

  1. Go to System Admin  Configuration  Notification Templates

  2. Locate record – this is template ID ApmInstanceDelivery (APM to remind students enrolled in a scheduled offering)

  3. Go to Messages tab

3 a Anatomy - Structure

  1. Each section is a Message ID

  2. Message can contain mix of labels and text

3 b. Anatomy – Tags, Labels, Loops

  1. Select Preview to view current content

  2. Look at data tags + text + label contents + loop (repeat) tags

This example does not show any literal text strings. You could type in specific text instructions in place of (or in addition to) using labels.


3 c. Content - Simple Labels

  1. Go to System Admin  Configuration  Notification Templates
  2. Locate notification and select Edit to research.
  3. Locate body and existing label (purple shows ID):
    1. <label key="notification.ComponentAssignment.MessageText1"/>

       4. Go to System Admin > References > Locale Labels

       5. Locate this label ID and select record for language you want.


      6. View the Label Value field for your environment.

*If you modify this entry and Apply changes – update is immediate.


3 c. i) Content – Complex Labels

<label key="notification.ApmInstanceDelivery.MessageText1"



<label key="notification.ApmInstanceDelivery.MessageText2"





* If editing – must remove argument AND renumber AND remove reference from label

The values are passed in from the message as arg0 or arg1.

If you don’t want them, remove them from this label or use another label or static text.

3 c. ii) Content – How Tags Work

  1. Tags contain code to display related fields

  2. Each notification has a set of available tags

    Tags available for ApmStudentLearningPlanNotification:



    Tags available for ItemEvaluationAssignmentNotification:



    Tags available for ApmTrainingExpiration:


    **This is a representative sample of tags used for 3 common templates.

  3. Some templates use tag format with “&”

    Tags available for ApprovalProcessRequestApproved and other approval process notifications:



    Tags available for SystemEnrollmentNotification:



    Tags available for vcal calendar attachment:



    **Other examples that use “&” syntax include VLE_EVENT. 

    * Notice that these tags do not end with “\” character.



  • No labels