Локальный плагин «Настраиваемые поля для объектов»

1. Общая информация

Плагин предназначен для создания набора дополнительных полей объектов (сущностей) СЭО 3KL. Это повышает удобство управления объектами, в том числе с помощью плагина «Панель обработки прецедентов».  Модуль постоянно модифицируется и дополняется новыми функциями силами специалистов компании «Открытые технологии».

Настраиваемые поля сущности - её дополнительные описательные поля, значения которых могут нести информацию о сущности и её характеристиках. Могут быть доступны в генераторах отчетов, таблицах плагина «Панель управления 3KL», макроподстановках (генераторах шаблонов), при проверке условия доступности элемента, при определении критериев автоподписки и т.п. Используются как для отображения значений, так и для фильтрации и сортировки сущностей.

Как это работает:

• Выбирается объект, для которого будут созданы настраиваемые поля (например «Глобальная группа»).
• Определяется конфигурация настраиваемых полей для этого объекта (например поле «Дата удаления Глобальной группы»).
• Настраиваемые поля заполняются значениями (например «30.06.2022»).
• Путем фильтрации значений по заданным критериям происходит выборка объектов (например Глобальных групп, у которых значение в поле «Дата удаления Глобальной группы» менее текущего).
• К выбранным объектам применяются сценарии (например «Удаление глобальных групп по дате из настраиваемых полей глобальной группы»).

Возможные сценарии с использованием плагина  «Панель обработки прецедентов»:

• Удаление подписок типа «Синхронизация с Глобальной группой» по значениям даты из настраиваемых полей Глобальной группы. После настройки сценария и наступления указанной даты система удаляет способы записи типа «Синхронизация с глобальной группой», связанные с группами с истекшим сроком обучения.

• Удаление Глобальных групп по значениям даты из настраиваемых полей Глобальной группы. После настройки сценария и наступления указанной даты система находит Глобальные группы с истекшим сроком пребывания в системе и удаляет их.

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

2. Настройки требуются права администратора

Настройкой плагина является создание конфигурационных массивов в формате yaml (конфигурация настраиваемых полей) на странице Блок «Настройки»-> Администрирование-> Плагины-> Локальные плагины-> Настраиваемые поля для последующего заполнения созданных полей пользователем с соответствующим правом (например, «Редактировать значения настраиваемых полей курсов»).

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

Зарезервированные именованные свойства:

• type — тип элемента формы;
• label - установка подписи к элементу формы;
• filter — установка типа данных для элемента;
• default — значение, которое должно по умолчанию подставиться в элемент формы;
• repeatgroup — на текущий момент не реализовано для этого инструмента;
• rules — на текущий момент не реализовано для этого инструмента;
• disabledif — на текущий момент не реализовано для этого инструмента;
• autoindex — на текущий момент не реализовано для этого инструмента;
• expanded — на текущий момент не реализовано для этого инструмента;
• advanced — на текущий момент не реализовано для этого инструмента;
• helpbutton — на текущий момент не реализовано для этого инструмента.

Остальные свойства будут переданы в конструктор элемента формы в том порядке, в котором они объявлены в конфигурации.

На текущий момент для этого инструмента доступны следующие типы полей:

• text — однострочное текстовое поле;
• textarea — многострочное текстовое поле;
• select — выпадающий список;
• checkbox — флажок;
• date_selector — дата;
• submit — кнопка для отправки формы.

-Вернуться к содержанию-

3. Примеры и решения

3.1. Настраиваемые поля Глобальных групп

Пример задачи:

Решение:

Шаг 1. В плагине «Настраиваемые поля» в окне «Глобальные группы. Конфигурация настраиваемых полей» задать конфигурационный массив:

class:
   code1:
      type: text
      label: Организация
   code2:
      type: text
      label: Договор №
   code3:
      type: text
      label: Ответственный менеджер
   undergraduate_directions:
      type: select
      label: Направление подготовки 
      options: 
         09.03.03: Прикладная информатика 
         38.03.01: Экономика 
         38.03.02: Менеджмент
   unenroldate:
      type: date_selector
      label: Срок завершения обучения группы
   deldate:
      type: date_selector
      label: Срок жизни группы
   submit:
      type: submit
      label: Сохранить

Шаг 2. На странице редактирования настраиваемых полей внести значения полей:

• Перейти в  Блок «Настройки»->Администрирование->Пользователи->Учетные записи->Глобальные группы, а оттуда в интерфейс редактирования настроек выбранной Глобальной группы (пиктограмма ) :

• Со страницы редактирования глобальной группы через блок «Настройки» перейти на страницу редактирования настраиваемых полей:

• Внести значения полей:

Результат. Настраиваемые поля созданы. При настроенном сценарии «Удаление глобальных групп по дате из настраиваемых полей глобальной группы» по достижении указанной в поле «Срок жизни группы» даты эта глобальная группа будет удалена.

-Вернуться к содержанию-

3.2. Настраиваемые поля Курсов

Пример задачи:

Решение:

Шаг 1. В плагине «Настраиваемые поля» в окне «Курсы. Конфигурация настраиваемых полей» задать конфигурационный массив:

class:
   description:
      type: textarea
      label: Тип итогового испытания (из справочника ListMarkType системы СПРУТ)
   syncable:
      type: checkbox
      label: Синхронизируемая
   extid:
      type: text
      filter: int
      label: Идентификационный номер курса (из справочника ListSubject системы СПРУТ)
   submit:
      type: submit
      label: Сохранить

Шаг 2. Перейти в (Курс)-> Блок «Настройки»->Управление курсом->(Курс).Редактирование настраиваемых полей,  в поле «Тип итогового испытания (из справочника ListMarkType системы СПРУТ)» ввести название итогового испытания (например «экзамен»), а в поле «Идентификационный номер курса (из справочника системы СПРУТ ListSubject)» - id дисциплины (например 118).

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

-Вернуться к содержанию-