Создание шаблона уведомления

Чтобы создать шаблон уведомления:

  1. Откройте раздел веб-интерфейса KUMA Ресурсы → Шаблоны уведомлений.

    В правой части раздела Ресурсы отобразится таблица Шаблоны уведомлений.

  2. Нажмите на кнопку Добавить и в открывшемся окне задайте параметры, как описано в таблице ниже.

    Параметры шаблонов уведомлений

    Параметр

    Описание

    Название

    Обязательный параметр.

    Уникальное имя шаблона. Должно содержать от 1 до 128 символов в кодировке Unicode. Имя не должно начинаться и заканчиваться пробелом и не должно содержать управляющие последовательности (перевод строки и т.п.).

    Тенант

    Обязательный параметр.

    Название тенанта, которому принадлежит ресурс. Вы можете создавать шаблоны всех типов событий для Общего тенанта. Для всех остальных тенантов доступны только типы Созданный алерт и Нарушение политики мониторинга.

    Тип

    Обязательный параметр.

    Тип события, для которого необходимо создать шаблон уведомления. Доступны следующие типы:

    • Созданный алерт.
    • Завершение генерации отчета.
    • Завершение асинхронной задачи.

      Шаблон с таким типом может быть только один. Если шаблон с таким типом уже существует, этот тип будет недоступен для выбора при создании нового шаблона.

    • Нарушение политики мониторинга.
    • Перемещение пользователя в другую группу KASAP.

    Тема

    Обязательный параметр.

    Тема электронного письма с уведомлением. Максимальная длина поля – 140 символов в кодировке Unicode.

    Текст необходимо указывать на русском или английском языке в зависимости от локализации, выбранной в профиле пользователя.

    Для каждого типа событий при создании шаблона доступен стандартный текст темы. Поле Тема недоступно для редактирования или выбора стандартного текста, пока не выбран тип шаблона в поле Тип.

    В теме письма можно обращаться к полям объектов в зависимости от выбранного типа события.

    Пример (тема в шаблоне уведомления для события типа Созданный алерт):

    Новый алерт в KUMA: {{.CorrelationRuleName}}.

    Вместо {{.CorrelationRuleName}} в теме письма с уведомлением будет подставлено название правила корреляции, содержащееся в поле алерта CorrelationRuleName.

    Шаблон

    Обязательный параметр.

    Тело электронного письма с уведомлением.

    Текст необходимо указывать на русском или английском языке в зависимости от локализации, выбранной в профиле пользователя.

    Шаблон поддерживает синтаксис, с помощью которого уведомление можно динамически наполнить данными из указанных полей соответствующих объектов. Описание синтаксиса шаблонов уведомлений и список поддерживаемых полей вы можете найти в статье Синтаксис шаблонов уведомлений. Для каждого типа событий при создании шаблона доступен стандартный текст электронного письма.

    Для удобства текст письма можно открыть в отдельном окне, нажав на значок full-screen. При этом открывается окно Шаблон, в котором можно изменить текст письма с уведомлением. Сохранить изменения и закрыть окно можно с помощью кнопки OK.

    По умолчанию

    Необязательный параметр. Доступен для типа событий Завершение асинхронной задачи.

    Если флажок установлен, то создаваемый шаблон применяется вместо системного шаблона ко всем задачам, созданным после сохранения шаблона.

    Теги

    Необязательный параметр.

    Теги для создаваемого шаблона уведомления.

    В списке отображаются все доступные теги, созданные в тенанте ресурса и Общем тенанте. Вы может найти тег в списке, начав вводить его название в поле. Если тега, который вы ввели, не существует, вы можете нажать Enter или Добавить, чтобы создать его.

    Описание

    Необязательный параметр.

    Описание шаблона в виде произвольного текста. Максимальная длина до 4000 символов в кодировке Unicode.
  3. Нажмите Сохранить.

Шаблон уведомления создан и отображается в таблице Шаблоны уведомлений.

В начало