Уведомление в МК

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

Работа с уведомлениями

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

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

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

Режим Silent Mode влияет на отправку уведомлений в мобильном приложении.

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

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

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

Уведомление может отображаться:

  • на мобильном устройстве;

  • в интерфейсе мобильного приложения в виде:

    • списка уведомлений (если настроен список объектов служебного класса "Уведомление в мобильном приложении");
    • карточки уведомления (если настроена карточка объекта служебного класса "Уведомление в мобильном приложении").

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

Настройка уведомления

Настройка уведомления заключается в настройке шаблона уведомления, определяющего внешний вид уведомлений в мобильном приложении, см. Работа с уведомлениями.

Шаблон уведомления настраивается как отдельный тип действий "Уведомление в мобильном приложении" в списке действий по событиям или действий при эскалации.

Алгоритм выполнения уведомления: Наступление инициирующего события → Проверка выполнения условий действия по событию → Формирование списка получателей → Выполнение скрипта кастомизации → Создание уведомления → Выполнение действия по событию. Действие по событию выполняется один раз.

Добавление шаблона уведомления

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

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

Чтобы настроить шаблон уведомления, выполните следующие операции:

  1. В меню навигации выберите "Настройка системы" → "Действия по событиям" и нажмите кнопку Добавить действие.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  3. Заполните параметры действия типа "Уведомление в мобильном приложении":

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

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

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

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

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

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

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

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

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

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

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

    • Формат заголовка уведомления — выберите формат заголовка уведомления.

      Для выбора доступны варианты: "значение по умолчанию", "значение по умолчанию + Тема", "Тема", см. подробнее Настройка заголовка уведомления.

    • Текст уведомления — введите содержание уведомления.

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

    • В формате HTML:

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

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

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

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

  4. Нажмите кнопку Сохранить. Форма добавления закроется, новое действие отобразится в списке действий по событиям.

Настройка заголовка уведомления

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

Заголовок по умолчанию для всех уведомлений настраивается на вкладке "Прочие" ( "Настройка системы" → "Мобильное приложение") при редактировании параметра "Название системы" в блоке "Прочие настройки", см. Прочие настройки МК.

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

Параметры уведомления для настройки заголовка:

  • Формат заголовка уведомления — формат заголовка уведомления.

    Для выбора доступны варианты: "значение по умолчанию", "значение по умолчанию + Тема", "Тема".

  • Тема — тема уведомления, которая будет отображаться в заголовке уведомления, если выбран формат заголовка "значение по умолчанию + Тема" или "Тема".

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

Настройка условий выполнения уведомления

Условия выполнения уведомления проверяются после наступления инициирующего события (для действий по событию).

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

Включение или выключение уведомления

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

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

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

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

Связанные настройки

Служебный класс "Уведомление в мобильном приложении"

Экземпляры уведомления хранятся в системе как объекты служебного класса "Уведомление в мобильном приложении".

Атрибуты объекта "Уведомление в мобильном приложении":

  • "Получатель" — получатель уведомления.
  • "Текст" — текст уведомления в формате RTF.
  • "Дата отправки" — дата и время срабатывания действия типа "Уведомление в мобильном приложении", в рамках которого было инициировано создание данного экземпляра уведомления.
  • "Дата прочтения" — дата и время перехода объекта в статус "Прочитано" (readByUser).

  • "Заголовок" — значение параметров "Формат заголовка уведомления" и "Тема" шаблона уведомления в мобильном приложении, по которому сформирован экземпляр уведомления.

    Значение по длине превышающее 255 символов обрезается до 252 символов и в конце строки добавляется многоточие ("...").

В служебном классе "Уведомление в мобильном приложении" не доступно создание пользовательских атрибутов.

Время хранения экземпляров уведомления

Время хранения в системе экземпляров прочитанных и непрочитанных уведомлений настраивается в конфигурационном файле dbaccess.properties, см. Уведомления.

Удаление экземпляров уведомлений запускается один раз в сутки.