Способы формирования уведомлений
Формирование уведомления на отправку одинаково как для событийного взаимодействия, так и для вызова Rest API. Ниже приведено описание для события.
Отправка уведомления, контракт события qun-notification-create
| Параметр | Название | Тип |
|---|---|---|
| NotificationRecipient | Получатель уведомления | NotificationRecipient |
| channelProtocolLinkList | Список каналов рассылки | Array of ChannelProtocolLinkList |
| attachments | Список прикрепленных файлов | Array of Attachments |
| createdBy | Автор уведомления | string |
| id | ID записи уведомления | integer($int64) |
| message | Текст сообщения | string |
| messageHTML | Текст сообщения в формате HTML | string |
| messageType | Тип сообщения | string |
| notificationAttributes | Атрибуты сообщения | string |
| notificationAttributesJson | Атрибуты сообщения в формате JSON. Используется, если атрибуты не указаны в поле notificationAttributes | object |
| objectId | ID объекта процесса, в рамках которого было отправлено уведомление | string |
| objectNumber | Номер объекта процесса, в рамках которого было отправлено уведомление | string |
| objectType | Тип объекта процесса, в рамках которого было отправлено уведомление | string |
| overrideRecipient | Признак перезаписи получателей. При включенном признаке при создании уведомления из процесса по шаблону, получатели будут перезаписаны данными из процесса. | bool |
| recipientGroupId | ID группы рассылки | integer($int64) |
| recipientGroupSystemName | Системное наименование группы рассылки | string |
| soundAlarm | Признак звукового сигнала при отпрвавке уведомления | bool |
| templateId | ID шаблона уведомления | integer($int64) |
| templateSystemName | Системное наименование шаблона уведомления | string |
| type | Тип уведомления | integer($int64) |
| typeSystemName | Системное наименование типа уведомления | string |
| useCurrentUserMail | Признак использования электронной почты текущего пользователя для отправки уведомления | bool |
Отправка уведомления, контракт события qun-notification-command
| Параметр | Название | Тип |
|---|---|---|
| NotificationRecipient | Получатель уведомления | Array of NotificationRecipient |
| channelProtocolLinkList | Список каналов рассылки | Array of ChannelProtocolLinkList |
| attachments | Список прикрепленных файлов | Array of Attachments |
| createdBy | Автор уведомления | string |
| id | ID записи уведомления | integer($int64) |
| message | Текст сообщения | string |
| notificationAttributes | Атрибуты сообщения | string |
| recipientGroupId | ID группы рассылки | integer($int64) |
| templateId | ID шаблона уведомления | integer($int64) |
| type | Тип уведомления | integer($int64) |
Получение сообщения по шаблону, контракт события qun-notification-template-text-command
| Параметр | Название | Тип |
|---|---|---|
| templateId | ID шаблона уведомления | integer($int64) |
| notificationAttributes | Атрибуты сообщения | string |
| notificationAttributesJson | Атрибуты сообщения в формате JSON. Используется, если атрибуты не указаны в поле notificationAttributes | object |
| channelId | ID канала рассылки | integer($int64) |
Схемы объектов
NotificationRecipient
Получатель уведомления
| Параметр | Название | Тип |
|---|---|---|
| externalSystemId | Системное имя получателя. Может быть передан адрес электронной почты | string |
| id | ID записи получателя | integer($int64) |
| name | Наименование получателя | string |
| recipientId | ID получателя (ID роли, ID сотрудника, ID департамента) | integer($int64) |
| systemName | Системное имя получателя (сис имя роли/логин сотрудника/сис имя департамента) | string |
| type | Тип получателя: • 1 - Сотрудник (employee); • 2 - Подразделение (department); • 3 - Роль пользователя (role); • 4 - Группа пользователей (group); • 5 - Чат телеграмма (TELEGRAM_CHAT); • 6 - Электронная почта (EMAIL); • 7 - Телефонный номер (PHONE_NUMBER); • 8 - Токен копии приложения (APPLICATION_INSTANCE_TOKEN); • 9 - Участник (PARTICIPANT). | integer($int64) |
ChannelProtocolLinkList
Список каналов рассылки
| Параметр | Название | Тип |
|---|---|---|
| attachments | Список прикрепленных файлов | Array of Attachments |
| channelSysName | Системное имя канала рассылки | string |
| message | Шаблон текста сообщения для канала | string |
| messageHTML | Шаблон текста сообщения для канала в формате HTML | string |
| messageType | Тип сообщения | integer |
| subject | Тема письма | string |
Attachments
Список прикрепленных файлов
| Параметр | Название | Тип |
|---|---|---|
| contentType | Тип содержимого файла | string |
| file | Наименование файла с путем в файловом хранилище | string |
| fileID | ID файла в файловом хранилище | string |
| fileInfoId | ID информации о файле в файловом хранилище | integer($int64) |
| fileName | Наименование файла с расширением | string |
| isBase64 | Признак кодирования в base64 | bool |
| storage | Место хранения документа в файловом хранилище | string |
Варианты формирования события для отправки уведомления
Уведомление можно сформировать:
- Самостоятельно сформировать уведомление, не используя шаблона. В таком случае необходимо указать следующие параметры:
- channelProtocolLinkList - список каналов для отправки;
- notificationRecipient / recipientGroupId - получатель уведомления или ID группы рассылки (в которую входит список получателей);
- type - тип уведомления;
- message - шаблон текста уведомления (статичный текст);
- notificationAttributes - атрибуты сообщения, если в
messageбыл указан параметризированный шаблон текста. - notificationAttributesJson - атрибуты сообщения в формате JSON, если в
messageбыл указан параметризированный шаблон текста. Используется, если атрибуты не указаны в поле notificationAttributes.
- Сформировать уведомление по шаблону. В таком случае необходимо указать следующие параметры:
- templateId - ID шаблона уведомления;
- notificationAttributes - атрибуты сообщения, если в шаблоне был указан параметризированный текст.
- notificationAttributesJson - атрибуты сообщения в формате JSON, если в шаблоне был указан параметризированный шаблон текста. Используется, если атрибуты не указаны в поле notificationAttributes.
Ниже будут представлены примеры формирования уведомлений в редакторе дизайнера процессов.
Отправка статического текста
| Переменная | Тип | Пример | ||||||
|---|---|---|---|---|---|---|---|---|
| channelProtocolLinkList | скрипт Groovy | [["channelSysName": "email", "message": "Test1"]] | ||||||
| message | Строка или выражение | "Уведомление о созданной задаче" | ||||||
| type | Строка или выражение | 1 | ||||||
| notificationRecipient | Карта |
|
Отправка шаблонного текста уведомления c параметризацией
При заполнении значения переменной notificationAttributes можно делать перенос строк. Перенос осуществляется после знака "+".
Заполняется одна из переменных notificationAttributes ИЛИ notificationAttributesJson. При заполнении обоих полей значения используются из поля 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 | ||||||
| notificationAttributesJson | Строка или выражение | {"taskId" : ${taskId}} | ||||||
| channelProtocolLinkList | скрипт Groovy | [["channelSysName": "email"]] | ||||||
| message | скрипт Groovy | "Подчинённый создал заявку на отпуск. Необходимо ее подтвердить через пользовательскую задачу №${taskId}" | ||||||
| type | Строка или выражение | 1 | ||||||
| notificationRecipient | Карта |
|
Пример настройки отправки параметризированного уведомления с атрибутами бизнес-процесс.
Пример настройки отправки параметризированного уведомления с атрибутами в формате JSON бизнес-процесс.
Отправка уведомления с параметрами по шаблону
| Переменная | Тип | Пример |
|---|---|---|
| notificationAttributes | скрипт Groovy | def text = "{\"taskId\": \"" + response.content.stream().findFirst().get().id.toString() + "\", \"startDate\": \"" + startDate + "\", \"endDate\": \"" + endDate + "\", \"statusName\": \"" + statusName + "\", \"fullName\": \"" + responseEmployee.fullName + "\", \"url\": \"" + url + "\"}"; text |
| notificationAttributesJson | Строка или выражение | {"taskId" : ${taskId}} |
| templateId | Строка или выражение | 1 |
Пример настройки отправки уведомления с параметрами по шаблону через бизнес-процесс.
Пример настройки отправки уведомления с параметрами в формате JSON по шаблону через бизнес-процесс.
