Справочники

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

В секции Справочники содержится список из элементов, заголовок которых определяет название справочника и задаётся во множественном числе, например Заказы, Заявки и т.д.

Справочник

Название	Тип	Описание
Наименование единицы справочника	`Строка`	Название единицы справочника в единственном числе. Например Заказ, Заявка и т.д.
Описание	`Строка`	Будет отображено на странице справочника по центру если список пуст и в правом верхнем углу если список не пуст. В случае отображение справочника календарём будет отображаться под элементом навигации по датам.
Иконка	Иконка	Используется для отображения в пункте меню.
Ширина окна создания-редактирования	`Мелкое`/`Обычное`/`Очень мелкое`/`Широкое`/`Во всю ширину экрана`	Модальное окно создания-редактирования элемента справочника будет заданного размера.
Позиция окна создания-редактирования	`По центру экрана`/`Наверху экрана`	Определяет вертикальное расположение модального окна создания-редактирования элемента справочника.
Изображение в описании	`Путь до файла c картинкой`	Будет отображено на странице справочника по центру если список пуст(левее текстового описания) и в правом верхнем углу если список не пуст(левее текстового описания). В случае отображение справочника календарём будет отображаться под элементом навигации по датам(выше текстового описания).
Поле для отображения всей сущности	Название поля этого справоника	Это поле будет использовано, если элемент этого справочника будет выбран по ссылке в другом поле другого справочника.
Поле для отображения как аватара	Название поля этого справоника	Это поле будет использовано как отображение аватара всей сущности, если элемент этого справочника будет выбран по ссылке в другом поле другого справочника.
Поле для отображения описания сущности	Название поля этого справоника	Это поле будет использовано как дополнительное описание всей сущности, если элемент этого справочника будет выбран по ссылке в другом поле другого справочника.
Доступно комментирование	`Да`/`Нет`	Связана с возможностью комментирования элементов этого справочника.
Условие показа пользователю комментариев	`Условие`	При выполнении условия пользователь может видеть комментарии.
Условие редактирование пользователем комментариев	`Условие`	При выполнении условия пользователь может создавать комментарии.
Тип сортировки	`По возрастанию`/`По убыванию`	Определяет направление сортировки.
Стратегия сортировки	`По дате создания`/`Выбрать поле`	Определяет какие поля будут использоваться для сортировки.
Поле для сортировки	Название поля этого справоника	Если Стратегия сортировки указана как `Выбрать поле`, то это поле будет использоваться для сортировки.
Поля	Массив объектов `Поле справочника`	Какие поля будут у этого справочника. Они могут быть отображены в колонках списков и как элементы редактирования в модальном окне создания-редактирования.
События	Массив объектов `Событие`	Логика событий при создании, редактировании и удалении элемента этого справочника.
Действия	Массив объектов `Действие`	Какие кнопки будут доступны для элемента этого справочника.
Инфоблоки	Массив объектов `Инфоблок`	Показ информационных блоков с текстом для пользователей, а так же подсвечивать строки в таблице по условию.
Вкладки	Массив объектов `Вкладка`	Какие вкладки будут отображаться в модальном окне создания-редактирования эемента этого справочника.

Элементы

Поле справочника

Название	Тип	Описание
Описание	`Любой`/`Картинка`/`Аватар`	Будет показана в всплывающем окне рядом с полем.
Тип поля	`Булево значение`/`Время`/`Выбор роли`/`Вычислимое поле`/`Дата`/`Дата и время`/`Значение перечисления`/`Массив`/`Прогресс`/`Продолжительность`/`Сохранённый пароль`/`Строка`/`Таблица`/`Текст`/`Файл`/`Число`/`Элемент справочника`	Определяет внешний вид и логику работы поля.
Тип строки	`Любая`/`Адрес`/`Ссылка`	Eсли Тип поля указан как `Строка`.
Тип файла	`Любой`/`Картинка`/`Аватар`/`Видео`/`Аудио`	Eсли Тип поля указан как `Файл` или если Содержание массива указан как `Файлы`.
Тип числа	`С точкой`/`Целое`	Eсли Тип поля указан как `Число` или если Содержание массива указан как `Числа`.
Содержание массива	`Строки`/`Файлы`/`Числа`/`Элементы перечисления`/`Элементы справочника`	Eсли Тип поля указан как `Массив`.
Заполнитель при пустом значении	`Строка`	Отображается при отсутствии значения в элементе ввода значения.
Размер	`1`-`16`	Размер поля по 16 колоночной сетке.
Обязательно при создании	`Да`/`Нет`	Если поле достпупно при создании, то оно будет обязательно к заполнению.
Обязательно при обновлении	`Да`/`Нет`	Если поле достпупно при редактировании, то оно будет обязательно к заполнению.
Условие редактирования	`Условие`	При выполнении условия пользователь может редактировать поле. По-умолчанию все пользователи могут редактировать все поля доступных справочников.
Условие скрытия	`Условие`	При выполнении условия пользователь не видит поле. По-умолчанию все пользователи видят все поля доступных справочников.
Условие добавления	`Условие`	Eсли Тип поля указан как `Таблица`. При выполнении условия пользователь может добавлять строки в таблицу. По-умолчанию все пользователи могут добавлять строки в таблицу, при доступности поля.
Скрыто в списке	`Да`/`Нет`	Не показывать колонку этого поля в списке.
Скрыто на форме	`Да`/`Нет`	Не показывать это поле в модальном окне создания редактирования.
Предвыбрано	`Да`/`Нет`	Если Тип поля выбран как `Булево значение` то галочка будет установлена при создании ноговое элемента справочника. Если Тип поля выбран как `Элемент справочника` или `Значение перечисления` то это будет выбрано первое значение из списка.
Справочник	Название справочника	Eсли Тип поля указан как `Элемент справочника`.
Перечисление	Название Перечисления	Eсли Тип поля указан как `Значение перечисления`.
Ограничение выборки	`Условие`	Eсли Тип поля указан как `Элемент справочника`. Позволяет ограничить выборку элементов справочника.
Короткое имя в списке	`Строка`	Если задано, то в списке будет показано это название для этого поля.
Вкладка	Название вкладки	В какой вкладке отображается поле.
Префикс	`Строка`	Отображается перед значением у элемента редактиррования и в списке у значения.
Постфикс	`Строка`	Отображается после значением у элемента редактиррования и в списке у значения.
Иконка у строкового поля	Иконка	Отображается у элемента редактирования в модальном окне создания-редактирования.
Скрыто для ролей	Массив названий ролей	Не показывать это поле для определённых ролей.
Поле для обратной ссылки	Название поля в справочнике указанном в поле Справочник	Eсли Тип поля указан как `Таблица`. По этому полю определяется какие элементы попадают в таблицу.

Тип поля: Значение перечисления

Если Вам нужно, чтобы значение поля было выбором из предопределенных значений, то:

Укажите Тип поля: Значение перечисления
Заполните поле Перечисление. В него должно быть записано название перечисления
В блоке Перечисления создайте перечисление с таким названием, если его еще нет

В следующем примере есть справочник Еженедельные отчёты, c полем Метод генерациии и типом Значение перечисления, у него указано перечисление - Метод генерациии отчёта. В блоке Перечисления есть перечисление с названием Метод генерациии отчёта.

app.rms
Справочники:
  - Еженедельные отчёты:
    Наименование единицы справочника: Еженедельный отчёт
    Иконка: chart pie
    Поля:
      - Период:
        Обязательно при создании: Да
        Обязательно при обновлении: Да
      - Метод генерациии:
        Тип поля: Значение перечисления
        Перечисление: Метод генерациии отчёта
Перечисления:
  - Метод генерациии отчёта:
    Значения:
      - Автоматически:
        Цвет: Синий
        Иконка: clock outline
        Описание: Отчёт создается автоматически за последнюю неделю по четвергам
      - Вручную:
        Цвет: Оранжевый
        Иконка: user circle outline
        Описание: Отчёт создается вручную с указанием периода

Событие

Название события может быть одним из значений:

Создание
Обновление
Удаление
Валидация при создании
Валидация при обновлении

Название	Тип	Описание
Описание	`Строка`	Описывает что происходит в событии. Будет показано пользователю, если в коде события произойдёт ошибка.
Python код	`Путь до python файла`	При генерации события соответствующего типа будет вызван этот код.

подсказка

События валидации (Валидация при создании и Валидация при обновлении) используют исключения для отображения ошибок. Подробнее тут.

Действие

Название действия будет использована как название кнопки в интерфейсе.

Название	Тип	Описание
Описание	`Строка`	Будет показана при наведении пользователем курсора на кнопку как всплывающее описание.
Python код	`Путь до python файла`	При генерации события соответствующего типа будет вызван этот код.
Иконка действия	Иконка	При генерации события соответствующего типа будет вызван этот код.
Условие доступности	`Условие`	При выполнении условия пользователю будет досутпно это действие.
Описание параметров	`Строка`	Если у действия есть параметры, то описание будет показано при открытии модального окна ввода параметров.
Иконка у описания параметров	Иконка	Если у действия есть параметры, то иконка будет показана при открытии модального окна ввода параметров рядом с Описанием параметров.
После выполнения	`Закрывать окно`/`Оставлять открытым`	Определяет будет ли модальное окно редактирования закрыто после выполнения действия.
Параметры	Массив объектов `Параметр действия`	Какие параметры будут запрошены у пользователя перед запуском действия.

Параметры действия

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

Название	Тип	Описание
Тип поля	`Булево значение`/`Время`/`Выбор роли`/`Вычислимое поле`/`Дата`/`Дата и время`/`Значение перечисления`/`Массив`/`Прогресс`/`Продолжительность`/`Сохранённый пароль`/`Строка`/`Текст`/`Файл`/`Число`/`Элемент справочника`	Определяет внешний вид и логику работы поля.
Содержание массива	`Строки`/`Файлы`/`Числа`/`Элементы перечисления`/`Элементы справочника`	Eсли Тип поля указан как `Массив`.
Тип файла	`Любой`/`Аватар`/`Картинка`/`Видео`/`Аудио`	Eсли Тип поля указан как `Файл`.
Справочник	Название справочника	Eсли Тип поля указан как `Элемент справочника`.
Перечисление	Название перечисления	Eсли Тип поля указан как `Значение перечисления`.
Обязательно при создании	`Да`/`Нет`	Поле будет обязательно для заполнения.
Размер	`1`-`16`	Размер поля по 16 колоночной сетке.
Описание	`Строка`	Будет показана в всплывающем окне рядом с полем.

Инфоблок

Название	Тип	Описание
Инфоблок	`Да`/`Нет`	Является ли текущий элемент инфоблоком(Прямоугольной областью заданного цвета расположенного выше всех полей на форме создания редактирования).
Индикатор	`Да`/`Нет`	Числовой индикатор в пункте меню связанном с справочником.
Подсветка	`Да`/`Нет`	Является подсветкой строки в таблице.
Описание	`Строка`	Отображается в инфоблоке или в описании индикатора.
Условие показа	`Условие`	При выполнении условия пользователь может видеть инфоблок. Если условие не задано, то инфоблок будет показан всем пользователям.
Иконка в инфоблоке	Иконка	Для инфоблока иконка будет показана левее описания.
Цвет	`Белый`/`Бирюзовый`/`Жёлтый`/`Зелёный`/`Коричневый`/`Красный`/`Оливковый`/`Оранжевый`/`Пурпурный`/`Розовый`/`Серый`/`Синий`	Определяет цвет фона инфоблока, цвет подсветки и/или индикатора.
Показывать для ролей	Массив названий ролей	Для этих ролей будет показан инфоблок. Если эта настройка не задана, то инфоблок будет показан всем пользователям.

Вкладка

Название вкладки можно использовать у поля в настройке Вкладка. Если на вкладке есть только одно поле с типом Таблица и таблица не пуста, то к имени вкладки будет добавлено количество элементов в таблице, например "Заказы (2)".

Название	Тип	Описание
Описание	`Строка`	Отображается выше полей на вкладке.
Не показывать количество	`Да`/`Нет`	Определяет, показывать ли количество элементов в таблице.

Пример app.rms

app.rms
lang: ru

Проект:
  Название: Лаборатория
  FavIcon: imgs/favicon.ico
  Пароль администратора: '123'
  Мастер пароль: 'qwerty'
  Фон страницы логина: imgs/app-login-bg.jpg
  Логотип: imgs/logo.png
  Маленький логотип: imgs/logo-mini.png
  Описание: Автоматизация процессов генетической лаборатории

Справочники:
  - Пациенты:
    Наименование единицы справочника: Пациент
    Иконка: user outline
    Изображение в описании: imgs/patient.svg
    Ширина окна создания-редактирования: Обычное
	Позиция окна создания-редактирования: Наверху экрана
    Описание: texts/patients.md
    Поле для отображения всей сущности: ФИО
    Поля:
      - ФИО:
        Скрыто на форме: Да
        Тип поля: Текст
      - Дата рождения:
        Тип поля: Дата
        Заполнитель при пустом значении: Укажите дату рождения...
        Размер: 6
        Условие редактирования: <ЛОЖЬ>
      - Пол:
        Тип поля: Значение перечисления
        Перечисление: Пол
        Предвыбрано: Да
        Размер: 5
        Условие редактирования: <ЛОЖЬ>
      - Образцы:
        Тип поля: Таблица
        Справочник: Образцы
        Поле для обратной ссылки: Пациент
        Поля для отображения в табличном виде: ["Номер образца", "Биоматериал"]
        Вкладка: Образцы
        Условие добавления: <ЛОЖЬ>
    Вкладки:
      - Образцы:
    События:
      - Создание:
        Python код: scripts/patient_create_update.py
  - Образцы:
    Наименование единицы справочника: Образец
    Иконка: lab
    Изображение в описании: imgs/sample.svg
    Описание: texts/samples.md
    Ширина окна создания-редактирования: Обычное
    Поле для отображения всей сущности: Номер образца
    Поля:
      - Пациент:
        Тип поля: Элемент справочника
        Условие редактирования: <ЛОЖЬ>
        Справочник: Пациенты
        Заполнитель при пустом значении: Укажите пациента...
      - Номер образца:
        Описание: Порядковый номер образца
        Размер: 4
        Заполнитель при пустом значении: Укажите лабораторный ID...
      - Биоматериал:
        Тип поля: Значение перечисления
        Перечисление: Биоматериал
        Заполнитель при пустом значении: Укажите тип биоматериала...
        Размер: 4
      - Дата забора:
        Тип поля: Дата и время
        Заполнитель при пустом значении: Укажите дату сбора...
        Размер: 4
	  
Перечисления:
  - Биоматериал:
    Значения:
      - Операционный материал:
        Цвет: Розовый
      - Кровь:
        Цвет: Красный
      - Прочее:
        Цвет: Белый    
  - Пол:
    Значения:
      - Мужской:
        Иконка: man
        Цвет: Синий
      - Женский:
        Иконка: woman
        Цвет: Розовый