Используемые термины

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

Общие термины

• Инструмент командной строки - утилита report доступная в интерфейсе командной строки после установки.
• Решение - папка с файлами созданная через команду report create <НАЗВАНИЕ_ПРОЕКТА>.
• RMS файл - файлы app.rms и site.rms содержащие YAML нотацию, которые описывают содержание и структуру решения.
• Сайт - статичная часть решения, представленная в файле site.rms. Сайт доступен без авторизации.
• Приложение - динамическая часть решения, интерактивная информационная система, представленная в файле app.rms.

Термины приложения

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

Публичная часть

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

• Экран входа - Страница с формой входа, на которой пользователь указывает логин(email) и пароль. С экрана входа доступна возможность восстановить доступ. Внешний вид экрана входа определяется секцией Проект файла app.rms. Экран входа доступен по адресу /login при наличии файла site.rms и по адресу / в противном случае.
• Форма восставноления доступа - Модальное окно, которое появляется на экране входа после нажатия кнопки "Восстановить доступ". Окно содержит поле ввода email и кнопку "Восстановить доступ". После нажатия кнопки отправляется запрос на восстановление доступа на почту указанную в поле ввода(если такой пользователь существует). В письме пользователю отправляется ссылка для восстановления доступа.
• Swagger документация - Документация API приложения для сторонних разработчиков.

Внутренняя часть

После авторизации пользователь будет переадресован во внутренюю часть при каждом входе.

• Справочник - Таблица с данными.
• Представление - Отображение данных для конкретной роли пользователя.
• Поле справочника - Колонка таблицы данных. Поле справоника имеет определённый тип, такие как Строка, Число, Дата, Время, Дата и время и другие.
• Внутреняя таблица - Тип поля справочника, который определяет связь между двумя справочниками и отображается как встроенная таблица внутри элемента справника.
• Перечисление - Статичная коллекция значений.
• Действие - Кнопка у элемента справника.
• Задача по расписанию - Кнопка для справочника или выполняемое по расписанию действие.
• Python файл - Файл связанный с действием, задачей по расписанию или событием.
• Объект app в Python файле - Аргумент метода run в Python файле, который определяет связь с сущностями приложения.
• Событие - Создание, обновление, удаление элемента справника.

Термины сайта (site.rms)

• Страница - Коллекция блоков, отображаемая на определённом url.
• Блок - Элемент страницы определённого типа с заданными свойствами.