Шаблоны уведомлений
Шаблоны уведомлений используются для настройки различных типов уведомлений, которые отправляются системой.
Шаблоны уведомлений настраиваются в меню конфигурации Шаблоны уведомлений.
Модель шаблонов уведомлений
| Поле | Тип | Описание |
|---|---|---|
| content | Object | Текст шаблона уведомлений. |
| content.single | String | Текст одиночного уведомления. |
| content.pack | String | Текст группового уведомления. |
| group | String | Группа уведомлений. Возможные значения – state для системных уведомлений (смена состояний и события) и auth для событий аутентификации. |
| id | String | ID шаблона уведомлений. |
| langCache | Object | Список языков, для которых отправляется это уведомление. |
| langCache.single | Array<String> | Список языков для одиночного уведомления. |
| langCache.pack | Array<String> | Список языков для группового уведомления. |
| name | String | Имя шаблона уведомлений. |
| subject | Object | Тема письма. Только для типа шаблона email. |
| subject.single | String | Тема одиночного уведомления. |
| subject.pack | String | Тема группового уведомления. |
| templateType | String | Тип шаблона. Все возможные типы описаны в разделе Типы шаблонов. |
Типы шаблонов
- telegram
- sms
- registration
- registration-subject
- registration-password
- registration-password-subject
- forgot
- forgot-subject
Переменные шаблонов
Список переменных, которые могут быть использованы в шаблонах уведомлений.
Подробную информацию можно найти в статье Шаблоны уведомлений.
Основные переменные
Эти переменные могут быть использованы с любым типом уведомлений:
| Variable | Description |
|---|---|
| breadcrumbs | Путь до элемента, о котором пришло уведомление. |
| changedStateText | Текст перехода состояния ("has passed to"). |
| condition | Информация о сработавшем условии перехода состояний. |
| conditionDescription | Описание сработавшего условия перехода состояния. |
| entityName | Имя сущности. |
| entityId | ID сущности. |
| entityType | Тип сущности (объект/связь). |
| entityUrl | URL сущности. |
| eventTime | Время возникновения события. |
| hasRootCause | true, если состояние было унаследовано от дочернего объекта. false, если состояние было изменено по другой причине. |
| rootCauseEntityName | Имя дочернего объекта, спровоцировавшего изменение состояния. |
| rootCauseEntityUrl | URL дочернего объекта, спровоцировавшего изменение состояния. |
| rootCauseEntityId | ID дочернего объекта, спровоцировавшего изменение состояния. |
| stateName | Имя состояния сущности. |
| stateData | Информация о состоянии сущности. |
Следующие переменные могут быть использованы в переменной breadcrumbs:
- entityName
- entityId
- entityUrl
Параметры переменной breadcrumbs. По умолчанию каждый параметр равен 0.
| Переменная | Описание |
|---|---|
| multi-break | Останавливаться на мультиродителе (0 - нет, 1 - да). |
| depth | Количество уровней вложения хлебных крошек (0 - без ограничения). |
| length | Максимальная длина пути (0 - без ограничения). |
Переменные для групповых уведомлений
В дополнение к основным переменным, для групповых уведомлений можно использовать следующие переменные:
| Variable | Description |
|---|---|
| eventsCount | Количество событий. |
| fromTime | Время первого события в группе. |
| toTime | Время последнего события в группе. |
| uniqueCount | Количество уникальных событий. |
Дополнительные переменные для email-уведомлений
Существуют дополнительные переменные для email-уведомлений:
| Variable | Description |
|---|---|
| entityLink | Имя-URL сущности. |
| goToObjectButton | Кнопка для перехода к сущности. |
| rootCauseEntityLink | Имя-URL дочернего объекта, которое стало причиной уведомления. |
| stateLabel | Цветное название состояния. |