This documentation supports the 23.3 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License types and features.To view an earlier version, select the version from the Product version menu.

Task 3: (Optional) Adding or modifying notification templates

By default, the notification engine on BMC Helix Innovation Suite provides several email templates that you can use as-is. To see the out-of-the-box templates, see Out-of-the-box-notification-events-templates-and-processes. 

If you have created a new notification event, you must also create a template that corresponds to the event. You can create or modify the out-of-the-box templates to suit your business requirements, such as branding and colors. All notification templates follow the branding defined when Rebranding-BMC-Helix-Digital-Workplace.

Related topics

Leveraging-the-notification-engine-on-BMC-Helix-Innovation-Suite-for-greater-flexibility

The following image shows the process of leveraging the notification engine on BMC Helix Innovation Suite:

Task 3 Add or modify notification templates.png

 

Before you begin

 

To add or modify notification templates

You can create only one notification template with an event name, a template name, a module, and a company combination.

  1. As an administrator, log in to BMC Helix Innovation Studio. 
  2. Click the Administration tab. 
  3. Select Notification Configuration > Manage Templates.  
  4. Perform one of the following steps:
    • To create a new notification template, click + Notification Template.
    • To modify, copy the existing template then proceed with the modification. 
    • To create a notification template for a different company, copy an existing template.

  5. Complete the following fields:
     

    Field

    Action

    Example

    Template Name

    Specify a meaningful name for the template.

    Original_Notification en_Notification template.png

    Module Name

    Select DWP - Notification

    Description

    Provide a brief description of the email template

     

    Default Notification Method

    Do not change the default value Email.

    Event

    Select the event that you created earlier.

    Status

    By default, the status that you selected for the event is displayed. In the template, you can change the status to any of the following values:

    • Enabled—The template is ready to use.
    • Offline—The template is not available for use. You can enable it for use at any point.
    • Delete—A template with the Delete status remains in the system, but it cannot be used in the application.

    Important: The Proposed, Obsolete, and Archive statuses are deprecated and should not be used. 

    Company

    • If you created a new template, the company you selected for the event is displayed by default. You cannot change the company in the template.
    • If you copied a template, from the list of companies, select the company for which you want to create the template. 

    Recipients

    (Optional) If you want to send email notifications to recipients other than the default ones, click Add Recipients.

    1. From the Recipient Type list, select Individual or Group.
    2. If you select Individual, search and select the name from the type-ahead list.
    3. If you select Group, search and select the group from the type-ahead list.
      Important: The Record Data and Dynamic Data options are not applicable. 
    1. Click Save.
      The selected recipients are displayed in the Recipients section.
    2. Select To, CC, or BCC for the recipients that you selected.
    3. Click Save.

  6. To create the email template body, click the Email tab and complete the following fields

    Field

    Description

    Subject

    Specify the subject line for the template.

    Body

    Specify the email body for the template.

    Supported variables:

    • Header background color—$headerBgColorValue$
    • Home page link in header—$headerHomePageLink$
    • Product name in header—$headerProductName$
    • Free Label (related to service pricing) —$freeLabelText$
    • Details link—$viewDetailsLink$
    • Color of the link in the footer—$footerLinkColor$
    • Link to manager email notifications—$footerLinkToUserPreference$
    • Imported SRDs (set to true for imported SRDs)—$isImportedSRD$
    • BMC Helix Digital Workplace Catalog native service request—$isNative$
    • Order description—$orderDescription$
       
    Example of using variables in a template

    Notification en_variables in templates.png

    Tips: 

  7. Click Save. 

 

To localize a notification template

You can localize an email template in the Edit view. You cannot localize it in the Create view. 

  1. As an administrator, log in to BMC Helix Innovation Studio. 
  2. Click the Administration tab. 
  3. Select Notification Configuration > Manage Templates.  
  4. Click the template that you want to localize.
  5. On the Email tab, from the Locale list, select the locale in which you want to create the template.
    For example, German. 
  6. Click +Localized Message to create an email subject and email body in the selected langauge. 
  7. Click Save. 

Notification en_select locale.png

 

Example of using variables and if-else conditions in the email template

Example of using if-else condition to display an attachment

Display the attachments if they are added to a comment.

If-else condition
#if("$420003521$")
Attachments: $420003521$
#end

In the above condition, 

  • ("$420003521$") denotes the presence of attachments value by field ID.
  • Attachments: $420003521$ denotes the attachments.

 

Where to go from where

Task-4-Optional-Modifying-the-notification-process

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*