Описание карточек модуля

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

Справочник настроек сервиса уведомлений

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

  • Компоненты контекста данных уведомлений.

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

  • Компоненты преобразования данных.

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

  • Компоненты отправки уведомлений.

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

  • Компоненты источника данных периодической рассылки.

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

  • Компоненты постобработки периодической рассылки (опционально).

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

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

Справочник событий уведомлений

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

События, зарегистрированные в справочнике, используются в карточке настроек рассылки, таким образом рассылка подписывается на выбранное событие.

Карточка настроек уведомления

Карточка настроек уведомления (шаблон уведомления) содержит информацию, по которой формируется и отсылается уведомление. Информация будет получена на основании данных карточки.

Обычно шаблон уведомления специфичен для каждого типа\вида карточки.

Карточка настроек рассылки уведомлений

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

Журнал рассылки уведомлений

Модуль поставляет пользователю возможность работать с Журналом рассылки уведомлений. Для работы журнала с модулем поставляются следующие компоненты:

  1. GridCardRowView — плагин грида Web-клиента, предназначенный для открытия разметки строки Журнала расылки уведомлений.

  2. Поисковый запрос Поиск журналов и представление для просмотра журнала рассылки уведомлений.

    Поисковый запрос "Поиск журналов"
    Рисунок 1. Поисковый запрос "Поиск журналов"

  3. Представление с названием Поиск по журналу для отображения строк журнала в папке с параметрическим поиском.

    Представление "Поиск по журналу"
    Рисунок 2. Настройки представления "Поиск по журналу"
    В настройках представления:

    • LogRowId — идентификаторы строк секции Журнал, по умолчанию колонка скрыта. Наличие скрытого/видимого столбца с названием LogRowId активирует плагин грида.

    • Статус — варианты значений "Успешно" и "Ошибка".

  4. Папка Поиск по журналу с поисковыми параметрами

    Поисковые параметры для папки "Поиск по журналу"
    Рисунок 3. Поисковые параметры для папки "Поиск по журналу"