Настройка упоминания объекта

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

При настройке упоминания определяются:

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

Упоминание объекта доступно в поле ввода текста в формате RTF (только редактор Froala).

Упоминание объекта может инициировать действие по событию, например, отправку оповещения. В скрипте действия по событию "Упоминание в рамках выбранных объектов" доступны контекстные переменные, содержащие информацию о том, какие объекты были упомянуты.

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

Меню навигации "Настройка системы" → настройка "Упоминания объектов".

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

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

Поля формы добавления:

  • Название — название упоминания.
  • Код — код упоминания.

  • Объекты — класс /тип объектов, на который будет указывать упоминание.

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

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

    Например, префикс "@" — для упоминания сотрудника.

  • В контексте объектов — класс /тип объекта, в контексте которого будет доступно упоминание объектов. Если ни один класс не выбран, то упоминание выбранных объектов доступно в контексте всех объектов.
  • Атрибут для формирования ссылки — атрибут, по значению которого будет формироваться ссылка для упоминания. Для выбора доступны уникальные атрибуты выбранного класса (параметр "Объекты").

  • Группа атрибутов для сложной формы упоминания — группа атрибутов для отображения списка на форме "Добавление упоминания". Для выбора доступны группы атрибутов выбранного класса (параметр "Объекты").

    Если группа атрибутов не выбрана, то название упоминания не отображается на форме "Упоминание объекта" (в меню слева).

    Форма открывается при нажатии иконки на панели редактирования текста RTF.

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

    Для выбора доступны абсолютные профили класса, выбранного в параметре "Объекты".

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

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

    Включенный механизм контроля прав при упоминаниях влияет на формирование списка объектов, доступных для упоминания. Список объектов формируется с учетом всех профилей упоминаемого класса объектов с признаком "Определить условие отбора объектов, доступных обладателю роли при упоминании", см. Контроль прав при упоминаниях. Профили, выбранные в параметре "Профили", на формирование списка не влияют.

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

Добавленное упоминание отобразится в блоке "Доступные объекты" на странице "Упоминание объектов".

Условия отображения иконки вставки упоминания в тексте RTF

Иконка вставки упоминания отображается на панели редактирования текста RTF в интерфейсе оператора, если в объекте, в рамках которого добавляется упоминание, настроено хотя бы одно упоминание со следующими параметрами:

  • в параметре "В контексте объектов" указан класс текущего объекта;
  • в параметре "Группа атрибутов для сложной формы упоминания" определена группа атрибутов.

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

Порядок отображения настроенных упоминаний

Порядок отображения возможных упоминаний на форме "Упоминание объекта" определяется порядком отображения элементов на странице "Упоминание объектов" (блок "Доступные объекты").

Порядок элементов на странице "Упоминание объектов" настраивается с помощью инструмента Drag and drop или иконок и в строке списка.

Переход по ссылке с упоминанием

Для атрибутов типа "Текст в формате RTF", размещенных на карточке объекта, переход по ссылке с упоминанием может быть отключен в конфигурационном файле dbaccess.properties (параметр ru.naumen.processMentionsInRtfServlet, см. RTF). По ссылке с упоминанием будет открываться новая страница с данным упоминанием в формате "текст".

Поиск объектов

При упоминании по префиксу (например, "@") объекты, доступные для упоминания, совпадают с результатами быстрого поиска.

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

Поиск объектов для класса "Сотрудник" (employee) выполняется по трем атрибутам: "ФИО" (title), "Логин" (login) и "Адрес электронной почты" (email).

Для всех остальных классов поиск происходит только по атрибуту "Название" (title).

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

Действие по событию "Упоминание в рамках выбранных объектов"

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

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