Добавление уведомления в интерфейсе

Описание настройки

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

Уведомление, добавленное для класса объектов, наследуется в его типы. Уведомление, добавленное для типа, действует только для данного типа и не наследуется во вложенные типы.

Место настройки в интерфейсе

Раздел "Настройка системы" → "Действия по событиям", страница "Действия по событиям".

Включение или выключение уведомления, редактирование параметров уведомления и удаление уведомления выполняется в списке действий по событию и в карточке действия по событию.

Выполнение настройки

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

Общие параметры действия по событию:

  • Название — название уведомления, используемое в системе.
  • Код — уникальный код действия по событию. Значение заполняется автоматически (транслитерация названия действия по событию при переводе фокуса с поля "Название"), код можно изменить.
  • Описание — подробная информация об уведомлении и его назначении.

  • Объекты — классы/типы объектов, относительно которых совершается событие.

    При установке флажка у класса или типа флажки проставляются у всех вложенных типов. Флажки вложенных типов доступны для редактирования.

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

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

    Подробное описание работы с метками см. Метки

  • Событие — событие, при наступлении которого будет выполняться действие.

    Перечень доступных событий зависит от выбранного класса/типа объектов.

    Для определенных событий на форме добавления и редактирования могут отображаться дополнительные поля.

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

    Подробное описание инициирующих событий и дополнительных полей приводится в разделе Инициирующие события для выполнения действия по событию

  • Действие — выберите действие, которое будет выполняться при наступлении события: "Уведомление в интерфейсе".

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

  • Атрибуты, передаваемые в контекст — укажите атрибуты, которые будут использоваться при выполнении действия по событию. Если поле не заполнено, то в очередь выполнения действия по событию передается весь объект. Если поле заполнено, то в скрипте выполнения действия по событию учитываются только те атрибуты, которые указаны в поле.

    Поле доступно для всех событий, кроме событий "Редактирование комментария" и "Упоминание в рамках выбранных объектов".

    В поле "Атрибуты, передаваемые в контекст" рекомендуется указывать адрес электронной почты (email) или атрибуты, используемые для вычисления ролей, указанных в параметре "Кому" для действия по событию.

  • Очередь обработки действия — выберите очередь, в которой будет размещено уведомление в интерфейсе.

    Параметр отображается, если создана хотя бы одна пользовательская очередь, см. Очереди обработки действий по событиям

Параметры уведомления:

  • Кому: Сотрудники — выберите уведомляемых сотрудников.

    Уведомление отправляется не архивному сотруднику, у которого указан логин.

    Сотрудники выбираются из разделов дерева:

    • "Компания" — иерархический список отделов и вложенных сотрудников.

      Если выбран отдел, то в список получателей будут добавлены все неархивные сотрудники отдела на момент выполнения действия по событию.

    • "Команды" — список команд и вложенных сотрудников.

      Если выбрана команда, то в список получателей будут добавлены все неархивные участники команды на момент выполнения действия по событию.

    • "Роли" — список абсолютных и относительных ролей, сгруппированных по классам, которые указаны в параметре "Объекты". В списке отображаются системные роли и пользовательские роли, предназначенные для определения списка пользователей, см. Роли пользователей.

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

    Если сотрудник оказывается в списке получателей несколько раз (например, является участником разных команд/отдела и команды/ролей), то дубли из общего списка получателей исключаются.

  • Исключить автора действия из списка получателей: по умолчанию включен.

    • Флажок установлен (по умолчанию) — автор действия не получает уведомление.
    • Флажок снят — автор действия получает уведомление.

  • Шаблон — выберите шаблон стилей для формирования уведомления.

    В выбранном шаблоне стилей вместо переменной "$content" подставляется значение параметра "Текст уведомления". Если в шаблоне стилей нет переменной "$content", то используется только текст шаблона, см. Шаблоны стилей.

    Значение [без шаблона] — текст уведомления и его внешний вид полностью определяется в параметре "Текст уведомления".

  • Текст уведомления — введите текст уведомления в формате RTF, см. Поле ввода текста в формате RTF.

    В тексте уведомления допустимо использование глобальных переменных, см. Переменные и ссылки в оповещениях, уведомлениях, шаблонах стилей

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

  • В формате HTML:

    • Флажок установлен (по умолчанию) — уведомление отправляется в формате HTML.

      При отправке уведомления в формате HTML желательно все атрибуты типа "Строка" или "Текст" перед вставкой в текст оповещения явно преобразовать в "Текст в формате RTF" (метод utils.asRTF, см. Методы API).

    • Флажок снят — уведомление отправляется в виде простого текста (в формате "text\plain").

      При отправке уведомления в формате "text\plain" желательно все атрибуты типа "Текст в формате RTF" перед вставкой в текст уведомления явно преобразовать в обычный текстовый формат (метод utils.asText).

  • Способ отображения уведомления — способ отображения уведомления для пользователя.

    • "Только в интерфейсе" — отображается только уведомление в интерфейсе;
    • "Только браузерное уведомление" — отображается только уведомление в браузере;

    • "В интерфейсе всегда. Дополнительно браузерное уведомление, если вкладка неактивна".

      Уведомление в интерфейсе отображается всегда.

      Браузерное push-уведомление отображается, если окно браузера с вкладкой приложения свернуто или развернуто, но выбрана другая вкладка.

    • "В интерфейсе и браузерное уведомление" — всегда используются оба способа отображения уведомления.

    Описание способов отображения уведомлений:

  • Расположение на экране — расположение уведомления на странице приложения. Не влияет на расположение браузерных уведомлений.

    • "Справа снизу" (по умолчанию).
    • "Справа сверху".
    • "Слева снизу".
    • "Слева сверху".
    • "Системное (внизу во всю ширину)"

  • Скрипт — введите содержание скрипта кастомизации уведомления. Скрипт кастомизации предназначен для выполнения настроек, не вынесенных в отдельные параметры уведомления.

Результат настройки

На экране отобразится карточка действия по событию типа "Уведомление в интерфейсе". Действие по событию создается в состоянии "выключено".

Действие по событию также отобразится в списке на странице "Действия по событиям".

Последующие настройки

Включение действия по событию

Уведомление создается в состоянии "выключено". Для использования уведомления его необходимо включить. Затем уведомление можно исключить из работы путем отключения и снова включить при необходимости его дальнейшего использования. Текущее состояние уведомления отображается в параметре "Включено", означает включено.

Чтобы включить (выключить) уведомление, выполните одно их следующих действий:

  • В карточке уведомления нажмите кнопку Включить или Выключить.

  • В списке действий по событиям нажмите иконку в строке действия по событию (уведомления).

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

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

Условия выполнения действия по событию

Для оповещения можно настроить условия выполнения. Условия выполнения оповещения проверяются после наступления инициирующего события.