Общие сведения о модуле

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

Модуль отслеживает изменения в карточках, требующие уведомления.

Администратор системы создает карточку с настройками уведомления: тему и текст уведомления, получателей, канал. Также администратор создает карточку рассылки, в которой выбирает из Справочника событий уведомлений конкретное событие, вызывающее рассылку уведомлений и карточки с настройками уведомления.

Событие отправляет запрос с идентификатором корневого типа события и список объектов в карточку сообщений сервиса обработки запросов на формирование уведомлений. Служба фоновых операций обнаруживает новое сообщение в карточке сообщений и передает его сервису на обработку.

После обработки формируются экземпляры уведомления на отправку, которые попадают в очередь на обработку для нужного канала отправки уведомлений. Канал отправки уведомлений определяет адресатов уведомлений, формирует сообщение по заданной модели, прикладывает вложения и отправляет уведомление.

Компоненты модуля

Модуль состоит из следующих компонентов:
  1. Расширение Web-клиента — компоненты, необходимые для взаимодействия с карточками модуля посредством Web-клиента.

  2. Расширение службы фоновых операций — компоненты, открывающие возможность работы с функциями модуля фоновых операций.

  3. Справочник настроек сервиса уведомлений — содержит информацию обо всех функциональных компонентах, которые могут быть использованы для формирования, обработки и отправки уведомлений.

  4. Справочник событий уведомлений — содержит информацию о событиях, на которые может быть подписана рассылка уведомлений.

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

  6. Карточка настроек уведомления — шаблон для формирования уведомлений. Хранит все ссылки на компоненты и их настройки, которые используются для формирования экземпляров уведомлений из контекста данных и передачи их по каналу отправки.

  7. Библиотеки API модуля.

Сервис уведомлений является сервисом рассылки уведомлений в системе Docsvision.

Модуль предоставляет публичные интерфейсы, которые используются системой Docsvision для вызова функций по работе с уведомлениями.

Основные понятия

  • Источник уведомления — информационный объект, создающий запрос на создание уведомления.

  • Запрос на формирование уведомлений — позволяет сохранить и далее обработать определённый факт необходимости формирования уведомления.

  • Контекст данных уведомления — информационный объект, относительно которого формируется уведомление. На основе данных этого объекта может быть построена модель данных, на базе которой с применением шаблона будет сформирован и отправлен экземпляр уведомления.

  • Карточка настроек уведомления (Шаблон уведомления) — содержит правила преобразования контекста данных уведомления в экземпляр уведомления.

  • Экземпляр уведомления — сформированное уведомление, готовое к отправке через определённый канал уведомлений.

  • Канал отправки уведомления — механизм,позволяющий транслировать получателей уведомления, заданных в терминах записей справочников Docsvision, в адресатов в системе отправки\получения уведомлений и осуществить отправку уведомлений этим адресатам.