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

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

Для действия по событию "[Пользовательское событие]" (пользовательское действие) можно настроить параметры, которые необходимо будет заполнять в интерфейсе оператора при выполнении данного действия на специальной форме. Форма открывается после нажатия на элемент управления (кнопку, ссылку, иконку).

Инициация пользовательского действия из веб-интерфейса

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

Форма пользовательского действия по событию открывается, если:

Инициация пользовательского действия из мобильного приложения

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

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

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

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

Меню навигации "Настройка системы" → настройка "Действия по событиям" → карточка действия по событию "[Пользовательское событие]" → блок "Параметры".

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

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

Поля формы добавления параметра. Для всех параметров:

  • Название — название параметра, используется в качестве подписи параметра на форме.

  • Скрывать название атрибута:

    • Флажок снят — название параметра отображается в интерфейсе;
    • Флажок установлен — название параметра не отображается.

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

    Недопустимые значения: user, parent, state, responsible, responsibleTeam, responsibleEmployee, stateStartTime, massProblem.

  • Тип значения — определяет набор полей на форме добавления и вид полей для отображения и редактирования значения параметра.

    Возможные типы значений: Агрегирующий, Вещественное число, Временной интервал, Гиперссылка, Дата, Дата/время, Логический, Набор ссылок на бизнес-объекты, Набор типов класса, Набор элементов справочника, Набор элементов произвольного справочника, Ссылка на бизнес-объект, Строка, Текст, Текст в формате RTF, Текст с подсветкой синтаксиса, Файл, Целое число, Элемент произвольного справочника, Элемент справочника.

  • Редактируемый:

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

  • Обязательный:

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

  • Вычисление значения:

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

  • Агрегировать классы — классы объектов, которые объединяет параметр.

    Для типа "Агрегирующий атрибут".

  • Класс объекта — класс объекта, с которым будет создана связь (кроме класса "Компания" (root).

    Для типов "Набор ссылок на БО", "Ссылка на бизнес-объект".

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

    Для типов "Набор ссылок на БО", "Ссылка на бизнес-объект".

  • Фильтрация значений при редактировании.

    Для типа "Агрегирующий атрибут", "Набор ссылок на БО", "Ссылка на бизнес-объект", "Элемент справочника", "Набор элементов справочника", "Набор элементов произвольного справочника", "Элемент произвольного справочника".

  • Скрипт вычисления элементов справочника.

    Для типа "Набор элементов произвольного справочника", "Элемент произвольного справочника".

    Отображаются поля для добавления скрипта вычисления элементов произвольного справочника.

  • Значение параметра допустимо указывать

    Для типа "Дата" и "Дата/время".

    Возможные значения:

    • "В прошлом":

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

    • "В будущем":

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

    Хотя бы один флажок "В прошлом" или "В будущем" должен быть установлен.

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

  • Дополнительное ограничение на ввод даты

    Для типа "Дата" и "Дата/время".

    Возможные значения:

    • "Без ограничений" (по умолчанию).

    • "Задать зависимость от параметра" — ограничение на ввод даты в зависимости от значения другого параметра типа "Дата" и "Дата/время". В календаре доступны для выбора только допустимые даты. При вводе недопустимой даты вручную выводится сообщение об ошибке.

      На форме отображаются дополнительные поля:

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

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

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

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

  • Скрывать при редактировании, если нет значений для выбора

    Для типа "Агрегирующий атрибут", "Набор ссылок на БО", "Ссылка на бизнес-объект", "Элемент справочника", "Набор элементов справочника", "Набор элементов произвольного справочника", "Элемент произвольного справочника".

    • Флажок установлен — если у параметра нет доступных для выбора значений, то данный параметр (его название и поле выбора значений) не отображается на форме. Значение параметра считается неуказанным (пустым).
    • Флажок снят — параметр всегда отображается на форме.

  • Разделять по разрядам

    Для типа "Вещественное число".

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

    • Флажок установлен — при вводе значения вручную и при вставке значения (Ctrl+V) целая часть числа разделяется по разрядам, между разрядами ставится пробел.

      На карточках и в списках значение параметра отображается с разрядами (в том числе значения, введенные до установки параметра)

  • Ограничение на ввод десятичных знаков — определяет наличие ограничения на ввод десятичных знаков. В поле можно ввести только число от 1 до 10.

    Для типа "Вещественное число".

    Если число десятичных знаков указано, то в поле ввода значения параметра отображается маска ввода (например, 0.000), где количество нолей после запятой равно заданному числу десятичных знаков. При попытке вставить (Ctrl+V) значение неподходящее по маске, часть значения обрезается.

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

    Для типа "Элемент справочника", "Набор элементов справочника".

  • Сортировка списка — сортировка списка элементов справочника при редактировании значения параметра.

    Для типа "Элемент справочника", "Набор элементов справочника".

    Возможные значения:

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

  • По умолчанию — значение по умолчанию.

    Вычислимое:

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

    Для типа "Агрегирующий атрибут", "Набор ссылок на БО", "Ссылка на бизнес-объект".

    Возможные значения:

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

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

      Значение доступно для типов "Агрегирующий атрибут", "Набор ссылок на БО", "Ссылка на бизнес-объект".

      На форме отображаются поля:

      • Группа атрибутов в списке — группа атрибутов, которая определяет набор колонок в списке объектов на форме добавления связи. Для выбора доступны группы атрибутов класса/типа объектов, с которым устанавливается связь.

        Для типа "Агрегирующий атрибут", "Набор ссылок на БО", "Ссылка на бизнес-объект".

      • Редактирование только через расширенную форму

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

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

      Значение доступно для типов "Набор ссылок на БО", "Ссылка на бизнес-объект".

      На форме отображаются поля:

      • Группа атрибутов в списке — группа атрибутов, которая определяет набор колонок в списке объектов на форме добавления связи. Для выбора доступны группы атрибутов класса /типа объектов, с которым устанавливается связь.

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

      • Редактирование только через расширенную форму

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

  • Форма быстрого добавления

    Для типа "Набор ссылок на БО", "Ссылка на бизнес-объект".

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

    Поле отсутствует, если в параметре "Класс объектов" выбран "Запрос" (serviceCall).

  • Форма быстрого редактирования

    Для типа "Набор ссылок на БО", "Ссылка на бизнес-объект".

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

    Поле отсутствует, если в параметре "Класс объектов" выбран "Запрос" (serviceCall).

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

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

Параметры доступны в скрипте действия по событию при помощи конструкции params.'Код_Параметра', например params.title, см. Скрипт действия по событию.

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

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

  • Изменение порядка отображения параметров.

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

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

  • Редактирование параметра.

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

  • Удаление параметра.

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