Описание компонента
Что нового в версии 1.4.2
Новые функции
- Уведомления теперь можно отправлять из панели администратора.
- Появилась возможность отправки уведомлений в заглушку.
- Добавлен новый тип канала оповещения Webhook.
- В ГЭПС-уведомления теперь можно добавлять вложения.
- Стало возможным размечать шаблоны уведомлений в формате TXT.
- Добавлена сквозная трассировка в сервисы Компонента.
Изменения функциональности
Обновился интерфейс панели администратора:
- по умолчанию отображается табличное представление данных, если более 10 объектов;
- добавлена поисковая строка по системам и группам пользователей;
- переименованы некоторые кнопки управления;
- переход на главную страницу теперь происходит только при нажатии на текст загловка "Центр уведомлений".
Исключенные и устаревшие функции
Отсутствуют.
Исправленные ошибки
- Исправлены уязвимости уровня Critical и High.
- Скорректирована работа сортировки и пагинации в истории статусов уведомления.
- Кнопки редактирования и переключения состояния канала неактивны для недоступного типа уведомлений в пользовательских и системных настройках.
- Исключено дублирование статусов в истории статусов уведомления.
- Исключено дублирование всплывающего окна при удалении дефолтного профиля.
- Исправлена ошибка 500/unregisteredError при недоступном сервисе files.
- Исправлена ошибка 500 при создании event-rule с именем удаленного event-rule.
- Исправлена ошибка 403 при отправке уведомлений через панель администратора.
- Добавлена возможность отфильтровать список по отсутствию канала оповещения пользователя.
- Исправлены отметки об обязательности полей в настройках каналов оповещения.
- Исправлено поведение при создании и удалении карточки «Настройка тротлинга».
- Добавлен вывод всплывающей подсказки о невозможности добавить параметр в шаблон при использовании символов (", $).
Известные проблемы
Не выявлены.
Компонент «Центр уведомлений Platform V Notification Center» входит в состав сервиса «Сервис управления процессами (услуга 1.12)».
Компонент «Центр уведомлений Platform V Notification Center» - сервис для рассылки уведомлений по разным каналам и распространения информации об изменении статусов уведомлений в системах-получателях при ее наличии. Он гарантирует доставку сообщений и хранение отправленных сообщений в течение настраиваемого срока.
Сервис позволяет рассылать следующие типы уведомлений в зависимости от каналов оповещения:
- push-уведомления на мобильные устройства (короткие сообщения, отправляемые на смартфон или в браузер клиента по device token);
- уведомления по электронной почте;
- sms-уведомления;
- уведомления через Государственную электронную почтовую систему (ГЭПС, осуществляется с помощью СМЭВ);
- внутренние уведомления между сервисами;
- уведомления в каналы через webhook.
При выполнении рассылки обеспечивается:
- получение статуса прочтения ГЭПС-уведомлений;
- рассылка внутренних сообщений (предназначенных для получения пользователями других автоматизированными систем в том же контуре);
- включение вложений в рассылаемые сообщения (email, ГЭПС);
- формирование общих и персонализированных сообщений на основе переданных сервису данных и шаблона;
- возврат данных по прочтению сообщений системе-отправителю по ее запросу;
- рассылка уведомлений по расписанию;
- рассылка уведомлений по наступлению события;
- отправка уведомлений в сервисы через webhook;
- хранение параметров настройки каналов для уведомлений пользователя: почтовые адреса, токены устройств для push-уведомлений (уникальный идентификатор установленного мобильного приложения и мобильного устройства), идентифицирующие пользователя документы для ГЭПС-уведомлений, идентифицирующие пользователя данные для внутренних уведомлений;
- хранение параметров подключения к конечным серверам, т.е. к серверам, через которые выполняется отправка уведомлений (SMTP, FCM, SMEV).
Удобный и понятный интерфейс позволяет настроить уведомления для пользователей (шаблоны и расписание отправки), а также создать новые типы уведомлений.
Для работы с компонентом необходимо завести систему (приложение), которая будет использовать бизнес функциональность центра уведомлений. Получателями отправленных уведомлений будут являться пользователи этой системы. Создание и настройка систем подробно описаны в Руководстве прикладного разработчика.
Сервис позволяет выполнять рассылку уведомлений как внутренним пользователям центра уведомлений, так и пользователям, импортированным из внешних систем. Тогда при отправке уведомлений в методе указывается система-отправитель и данные пользователя.
Уведомления могут быть отправлены сразу по нескольким каналам (email, push, gaps, sms, internal). Для этого необходимо воспользоваться универсальным методом, в котором указываются параметры отправки.
Необходимые настройки для отправки уведомлений по разным каналам указаны в таблице ниже.
| Канал отправки | Ресурс | Настройки |
|---|---|---|
email | SMTP-сервер | Адрес сервера (хост, порт), логин и пароль. Допускается подключение нескольких серверов. Если развертывание сервиса выполняется на тестовое окружения, то возможно установить заглушку SMTP-сервера |
push | https://firebase.google.com/docs/admin/setup | - Получите закрытый ключ Firebase SDK - Создайте Secret в Kubernetes |
sms | SMPP-сервер | Адрес сервера (хост, порт), логин и пароль пользователя для подключения. Если развертывание сервиса выполняется на тестовое окружения, то возможно установить заглушку SMPP-сервера |
gaps | Сертификат сервиса СМЭВ | В конфигурационном файле укажите валидный адрес для отправки уведомлений в сервис smev-proxy POST методом |
internal | - | Не требуется. Рассылка уведомлений по данному каналу идет между системами одного контура |
webhook | - | URL, на который необходимо отправить сообщение, заголовок запроса, тело запроса, метод, который необходимо использовать для отправки уведомления |
Сервис поддерживает создание и настройку текстовых шаблонов для отправки однотипных уведомлений. Связь типа уведомлений с созданным шаблоном реализуется через API (см. Руководство прикладного разработчика).
-
Отправка уведомлений с шаблоном/без шаблона.
Для отправки однотипных уведомлений нет необходимости в нескольких уведомлениях прописывать одинаковый текст. Можно создать шаблон (текстовый с параметрами) и при отправке уведомления в методе указать, какой шаблон и с какими параметрами применять.
-
Отправка уведомлений по расписанию.
Для каждого типа уведомлений можно задать расписание отправки уведомлений. Для зарегистрированных пользователей (см. п. ведение пользователей и систем) можно указать интервалы времени, в которые отправлять уведомления нельзя.
-
Отправка уведомлений по наступлению события.
Для отправки уведомлений по наступлению события необходимо создать триггер события, который будет содержать в себе информацию о том, когда событие происходит, а также создать правила отправки уведомлений по событию. В правилах можно указать:
- систему, из которой будут отправляться уведомления;
- группу пользователей - выбрать из списка или собрать динамическую группу пользователей на основе их дополнительных данных;
- признак уведомления;
- типы уведомлений и соответствующие им шаблоны;
- настройки троттлинга.
-
Настройка приоритетов для уведомлений.
Можно назначить приоритет отправляемым типам уведомлениям. Например, можно указать отправку по email и push, при этом задать, что email-уведомления отправляются только при невозможности отправки push-уведомления.
-
Отправка уведомлений по определенному профилю пользователя.
Для пользователя может быть зарегистрировано несколько профилей (например, рабочий и домашний). Сервис позволяет при отправке уведомлений указать, какой именно контакт использовать.
- Отправка универсального уведомления (пользовательского типа).
Минимальная конфигурация Сервиса обеспечивает:
- компонент «Интеграция со СМЭВ Platform V SMEV Gateway» предоставляет функциональность обмена данными с Системой межведомственного электронного взаимодействия версии 3 (схемы 1.2 и 1.3);
- размер файлов, принимаемых в обработку компонентом «Интеграция со СМЭВ Platform V SMEV Gateway» — 5242880 байт;
- компонент «Центр уведомлений Platform V Notification Center» поддерживает возможность отправки уведомлений по каналам email, ГосПочта, sms, webhook с производительностью до 60 tps (требуется организация соответствующего канала);
- для компонента «Моделирование и исполнение бизнес-сценариев Tasklist Platform V Flow» максимальный размер запроса (параметр
utsk max.request.size) — 5242880; - для компонента «Моделирование и исполнение бизнес-сценариев Engine Platform V Flow» размер «пачки» job, которые будут исполняться на одном ядре, (параметр
maxAsyncJobsDuePerAcquisition) — 5.
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки