Skip to main content
Version: 5.4.0

Notification template

note

You need the admin rights to use this feature.

Notification templates allow the admin to manage reusable email and SMS message templates.

Use notification templates to define the template content, subject, category, and parameters used when KAIZEN sends notifications.

Manage notification templates​

To manage notification templates, perform the following:

  1. In the KAIZEN studio console, on the left menu, click Notification > Notification Template.

    The Notification/ Notification Template page displays.

    Notification Template
  2. From here, you can create notification templates, search for existing notification templates, import notification templates, and export notification templates. Each row in the table provides the following actions under the Actions column:

    • View: Opens the notification template details in read-only mode.
    • Edit: Opens the notification template details for editing.
    • More: Expands a dropdown with additional actions, including Deactivate and Export.

Search notification templates​

To search for notification templates, perform the following:

  1. In Notification/ Notification Template, enter or select the search criteria.

    FieldDescription
    TypeFilter notification templates by type, which can be Email or SMS.
    Template KeySearch for notification templates by template key.
    SubjectSearch for notification templates by subject.
    StatusFilter notification templates by status, which can be Active or Inactive.
  2. Click Search to find the result.

To clear the search criteria, click Clear.

Create a notification template​

To create a notification template, perform the following:

  1. In Notification/ Notification Template, click Create.

  2. In the Create Notification Template window, provide the details:

    Create Notification Template window

    The following table describes each field from the window above:

    FieldRequiredDescription
    TypeYesSelect the notification type. Available values are Email and SMS.
    CategoryYesEnter the notification template category.
    Template KeyYesEnter the unique key used to identify the notification template.
    DescriptionNoEnter a description for the notification template.
    StatusYesSelect Active or Inactive. Only active templates can be used for notifications.
    ContentYesEnter the notification message content.
  3. To add parameters to the notification template, click Parameters.

    The Parameters window displays.

    Parameters window
  4. Click Create Param.

  5. In the Create Parameter window, provide the details:

    Create Parameter window

    The following table describes each field from the window above:

    FieldRequiredDescription
    Parameter KeyYesEnter the parameter key used in the notification template content.
    StatusYesSelect Active or Inactive.
    DescriptionNoEnter a description for the parameter.
  6. Click Save to save the parameter.

  7. In the Parameters window, click Cancel to return to the Create Notification Template window.

  8. Click Save to create the notification template.

important

It is highly recommended to test the notification template you have created, before using it to notify a large group of recipients.

Export a notification template​

To export a notification template, perform the following:

  1. In Notification/ Notification Template, select the notification template you want to export.

  2. Open the Export function using one of the following methods:

    • Click Export at the top of the page.
    • Click More on the same row as the notification template, then click Export.
  3. The Confirm window pops up, asking for confirmation. Click OK.

    An XML file containing the selected notification template information will be downloaded in your browser.

Import a notification template​

To import a notification template from an existing XML file, perform the following:

  1. In Notification/ Notification Template, click Import. The File Explorer window opens.

  2. Browse to the XML file that contains the notification template information. Click Open.

    A message will pop up, showing the import is successful.

Deactivate a notification template​

To deactivate a notification template, perform the following:

  1. Click More on the same row as the notification template, then click Deactivate.

  2. In the confirmation dialog, click OK.

    A success message will confirm that the notification template has been deactivated. The notification template status will change from Active to Inactive.

note

After the deactivation, you have the option to reactivate it by clicking More > Activate.

Last updated on 19 Oct 2026