Способы формирования уведомлений
Формирование уведомления на отправку одинаково как для событийного взаимодействия, так и для вызова Rest API. Ниже приведено описание для события.
Отправка уведомления, контракт события qun-notification-create
| Параметр | Название | Тип |
|---|---|---|
| NotificationRecipient | Получатель уведомления | NotificationRecipient |
| channelProtocolLinkList | Список каналов рассылки | Array of ChannelProtocolLinkList |
| createdBy | Автор уведомления | string |
| id | ID записи уведомления | integer($int64) |
| message | Текст сообщения | string |
| notificationAttributes | Атрибуты сообщения | string |
| recipientGroupId | ID группы рассылки | integer($int64) |
| templateId | ID шаблона уведомления | integer($int64) |
| type | Тип уведомления | integer($int64) |
Отправка уведомления на список email`ов, контракт события qun-notification-command
| Параметр | Название | Тип |
|---|---|---|
| NotificationRecipient | Получатель уведомления | Array of NotificationRecipient |
| channelProtocolLinkList | Список каналов рассылки | Array of ChannelProtocolLinkList |
| createdBy | Автор уведомления | string |
| id | ID записи уведомления | integer($int64) |
| message | Текст сообщения | string |
| notificationAttributes | Атрибуты сообщения | string |
| recipientGroupId | ID группы рассылки | integer($int64) |
| templateId | ID шаблона уведомления | integer($int64) |
| type | Тип уведомления | integer($int64) |
Схемы объектов
NotificationRecipient
Получатель уведомления
| Параметр | Название | Тип |
|---|---|---|
| Эл. почта получателя (для получателя "Сотрудник") | string | |
| id | ID записи получателя | integer($int64) |
| name | Наименование получателя | string |
| recipientId | ID получателя (йд роли, ID сотрудника, ID департамента) | integer($int64) |
| systemName | Системное имя получателя (сис имя роли/логин сотрудника/сис имя департамента) | string |
| type | Тип получателя: • 1 - Сотрудник (employee); • 2 - Департамент (department); • 3 - Роль пользователя (role); • 4 - Группа получателей (group). | integer($int64) |
ChannelProtocolLinkList
Список каналов рассылки
| Параметр | Название | Тип |
|---|---|---|
| channelSysName | Системное имя канала рассылки | string |
| message | Шаблон текста сообщения для канала | string |
| messageHTML | Шаблон текста сообщения для канала в формате HTML | string |
| messageType | Тип сообщения | integer |
| subject | Тема письма | string |
Варианты формирования события для отправки уведомления
Уведомление можно сформировать:
- Самостоятельно сформировать уведомление, не используя шаблона. В таком случае необходимо указать следующие параметры:
- channelProtocolLinkList - список каналов для отправки;
- notificationRecipient / recipientGroupId - получатель уведомелния или ID группы рассылки (в которую входит список получателей);
- type - тип уведомления;
- message - шаблон текста уведомления (статичный текст);
- notificationAttributes - атрибуты сообщения, если в
messageбыл указан параметризированный шаблон текста.
- Сформировать уведомление по шаблону. В таком случае необходимо указать следующие параметры:
- templateId - ID шаблона уведомления;
- notificationAttributes - атрибуты сообщения, если в шаблоне был указан параметризированный текст.
Ниже будут представлены примеры формирования уведомлений в редакторе дизайнера процессов.
Отправка статического текста
| Переменная | Тип | Пример | ||||||
|---|---|---|---|---|---|---|---|---|
| channelProtocolLinkList | скрипт Groovy | [["channelSysName": "email", "message": "Test1"]] | ||||||
| message | Строка или выражение | "Уведомление о созданной задаче" | ||||||
| type | Строка или выражение | 1 | ||||||
| notificationRecipient | Карта |
|
Отправка шаблонного текста уведомления и параметризированный
При заполнении значения переменной notificationAttributes можно делать перенос строк. Перенос осуществляется после знака "+".
| Переменная | Тип | Пример | ||||||
|---|---|---|---|---|---|---|---|---|
| notificationAttributes | скрипт Groovy | def text = "{\"taskId\": \"" + response.content.stream().findFirst().get().id.toString() + "\", \"startDate\": \"" + startDate + "\", \"endDate\": \"" + endDate + "\", \"statusName\": \"" + statusName + "\", \"fullName\": \"" + responseEmployee.fullName + "\", \"url\": \"" + url + "\"}"; text | ||||||
| channelProtocolLinkList | скрипт Groovy | [["channelSysName": "email"]] | ||||||
| message | скрипт Groovy | "Подчинённый создал заявку на отпуск. Необходимо ее подтвердить через пользовательскую задачу №${taskId}" | ||||||
| type | Строка или выражение | 1 | ||||||
| notificationRecipient | Карта |
|
Отправка уведомления с параметрами по шаблону
| Переменная | Тип | Пример |
|---|---|---|
| notificationAttributes | скрипт Groovy | def text = "{\"taskId\": \"" + response.content.stream().findFirst().get().id.toString() + "\", \"startDate\": \"" + startDate + "\", \"endDate\": \"" + endDate + "\", \"statusName\": \"" + statusName + "\", \"fullName\": \"" + responseEmployee.fullName + "\", \"url\": \"" + url + "\"}"; text |
| templateId | Строка или выражение | 1 |
Отправка уведомления на email
| Переменная | Тип | Пример | ||||||
|---|---|---|---|---|---|---|---|---|
| channelProtocolLinkList | скрипт Groovy | [["channelSysName": "email"]] | ||||||
| message | Строка или выражение | "Уведомление о созданной задаче" | ||||||
| type | Строка или выражение | 1 | ||||||
| notificationRecipient | Карта |
|
