Contents
Creating a notification template
To create a notification template:
- In the KUMA web interface, open the Resources → Notification templates section.
In the right part of the Resources section, the Notification templates table is displayed.
- Click the Add button and in the displayed window, specify settings as described in the table below.
Notification template settings
Setting
Description
Name
Required setting.
Unique name of the template. Must contain 1 to 128 Unicode characters. The name may not begin or end with a space and may not contain control sequences (line feed, etc).
Tenant
Required setting.
The name of the tenant that owns the resource. You can create templates of all types of events for the Shared tenant. For all other tenants, only the following types are available: Alert created and Sources monitoring alert.
Type
Required setting.
The type of event for which you want to create a notification template. The following types are available:
- Alert created.
- Report generated.
- Task finished.
Only one template of this type can exist. If a template of this type already exists, this type is not available for selection when creating a new template.
- Sources monitoring alert.
- KASAP group changed.
Subject
Required setting.
Subject of the notification email message. Maximum length: 140 Unicode characters.
You can enter the text in English or Russian, depending on the localization selected in the user profile.
For each event type, a standard subject text is available when creating a template. You cannot edit the text in the Subject field or select a standard text until you select the template type in the Type field.
In the subject of the message, you can reference the object fields depending on the selected type of event.
Example (subject in notification template for an event of the Alert created type):
New alert in KUMA: {{.CorrelationRuleName}}
.In place of
{{.CorrelationRuleName}}
, the subject of the notification message will include the name of the correlation rule contained in theCorrelationRuleName
alert field.Template
Required setting.
Body of the notification email message.
You can enter the text in English or Russian, depending on the localization selected in the user profile.
The syntax of the template lets you dynamically populate the notification with data from the specified fields of the corresponding objects. For a description of the notification template syntax and the list of supported fields, see the Notification template syntax article. For each event type, a standard email message subject text is available when creating a template.
For convenience, you can open the text of the email message in a separate window by clicking the
icon. This opens the Template window in which you can edit the text of the notification message. Click OK to save the changes and close the window.
Default
Optional setting. Available for the Task finished event type.
If the check box is selected, the created template is applied instead of the system template to all tasks created after saving the template.
Tags
Optional setting.
Tags for the generated notification template.
The list includes all available tags created in the tenant of the resource and in the Shared tenant. You can find a tag in the list by typing its name in the field. If the tag you entered does not exist, you can press Enter or click Add to create it.
Description
Optional setting.
Arbitrary text describing the template. Maximum length: 4000 Unicode characters.
- Click Save.
The notification template is created and displayed in the Notification templates table.
Page top