Документация продукта

Руководство пользователя

Универсальная платформа-конструктор сбора, обработки и согласования данных

Программное обеспечение «Универсальная платформа-конструктор сбора, обработки и согласования данных»

Редакция документа: 1.1. Дата: 21.09.2026.

1. Назначение и подготовка к работе

Руководство описывает ввод данных, настройку форм и согласование в текущей версии «Универсальная платформа-конструктор сбора, обработки и согласования данных». Для работы нужны адрес приложения, учетная запись и предоставленные администратором права. Используйте браузер с включенными JavaScript и cookie. Серверные компоненты развертывает администратор через Docker; пользователю не требуется устанавливать Python, Node.js или запускать приложение на своем компьютере. Локальный запуск frontend относится только к среде разработки.

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

2. Вход и завершение сеанса

  1. Откройте адрес приложения и страницу /login.
  2. Введите полученные логин и пароль.
  3. Выполните вход. После успешной проверки откроется защищенная часть приложения.
  4. По завершении работы нажмите кнопку выхода.

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

3. Основные разделы

Адрес Назначение
/ Рабочее место: выбор формы и контекста, записи
/assignment Согласование выбранной формы и контекста
/admin/constructor Администрирование конструктора
/admin/access Пользователи и роли

Административные страницы предназначены для пользователя с системной ролью admin. Назначение произвольной роли, например admin_constructor, само по себе не предоставляет этих полномочий.

4. Работа с данными

4.1. Выбор формы и контекста

На рабочем месте выберите форму. Если у формы настроена иерархия, последовательно выберите ее элементы. Например: «Регион А» → «Мероприятие 1». Записи отображаются для выбранного контекста. Если ввод настроен в корне формы, элемент иерархии для создания записи не требуется.

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

4.2. Создание записи

  1. В блоке «Записи» нажмите «Создать запись».
  2. В открывшейся панели заполните поля формы.
  3. Проверьте обязательные значения, даты, варианты выбора и рассчитанные показатели.
  4. Нажмите кнопку создания и дождитесь сообщения «Запись создана».
  5. Убедитесь, что новая запись появилась в списке со статусом «черновик».

Введенные, но не отправленные кнопкой сохранения данные не следует считать сохраненными. Формулы используют значения полей текущей формы; при неверном результате проверьте исходные числа и сообщите администратору.

4.3. Просмотр и редактирование

Откройте действие «Редактировать» у черновика либо отклоненной записи. Измените значения и нажмите «Сохранить». Успешная операция сопровождается сообщением «Данные успешно сохранены». Для остальных статусов интерфейс предлагает действие «Просмотр».

В таблице доступны сведения о статусе и времени изменения. Система сохраняет предыдущее содержимое при обновлении данных, но пользовательского архива всех версий в этом сценарии нет.

4.4. Отправка записи

У черновика или отклоненной записи нажмите действие «Отправить», либо «Отправить на согласование», если включено согласование. Эта операция устанавливает статус записи submitted («отправлена»).

При выключенном согласовании отправленную запись можно вернуть действием «Вернуть в черновик». При включенном согласовании эта кнопка не отображается. Отправка записи не запускает маршрут автоматически: для процесса используется отдельный раздел «Согласование».

Статус записи Поведение интерфейса
draft — черновик Редактирование и отправка
submitted — отправлена Просмотр; возврат в черновик при выключенном согласовании
signed — подписана Просмотр
rejected — отклонена Редактирование и повторная отправка

5. Согласование

5.1. Запуск

  1. Откройте раздел «Согласование» из рабочего места либо страницу /assignment.
  2. Выберите форму и требуемый контекст маршрута.
  3. Нажмите «Запустить».
  4. После сообщения «Согласование запущено» проверьте статус и номер текущего шага.

Для запуска нужен настроенный маршрут. Если для того же контекста уже имеется активный процесс, сервер отклонит повторный запуск.

5.2. Выполнение действия

Выберите действие, совпадающее с настроенным текущим шагом: «утвердить», «подписать» или «отклонить». При необходимости заполните «Подпись» и «Комментарий», затем нажмите «Применить действие». Действие разрешается назначенному пользователю, пользователю назначенной роли или администратору.

После промежуточного шага номер увеличивается. Последний успешный шаг дает процессу статус «подписано»; действие reject завершает процесс статусом «отклонено». Отклонение не является универсальной кнопкой для любого шага: тип действия должен совпасть с конфигурацией маршрута.

Поле «Подпись» хранит текст и технически необязательно. Ввод ФИО или номера сертификата не выполняет криптографическое подписание.

5.3. Особенности текущей версии

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

Статус процесса и статус записи независимы. Завершение маршрута не переводит запись автоматически в signed. Панель также не передает содержимое записей в снимок согласования. Эти особенности следует учитывать при выборе рабочего порядка согласования между несколькими сотрудниками.

6. Пользователи и роли

6.1. Создание роли

В разделе /admin/access откройте «Роли», нажмите «Создать роль», введите название и описание и сохраните. Например, создайте operator для операторов ввода. Системная роль admin имеет ограничения на изменение и удаление.

6.2. Создание пользователя

На вкладке «Пользователи» нажмите «Создать пользователя». Задайте логин и пароль, при необходимости имя и email, отметьте активность и назначьте роли. Нажмите «Создать».

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

7. Настройка формы

7.1. Порядок настройки

  1. Создайте пользователей и роли.
  2. На странице /admin/constructor создайте форму и откройте редактирование.
  3. Настройте уровни и элементы иерархии, если они нужны.
  4. Создайте тип схемы и основную схему полей.
  5. Задайте параметры ввода и согласования.
  6. Настройте маршрут и правила доступа.
  7. Проверьте форму под обычной учетной записью.

В панели формы доступны вкладки «Настройки», «Схемы», «Типы схем», «Иерархия», «Маршрут» и «Доступ».

7.2. Иерархия

На вкладке «Иерархия» создайте уровни. Для примера используйте следующие значения:

Системное имя Название Порядок Ввод данных
region Регион 1 Выключен
activity Мероприятие 2 Включен

Выберите размещение уровня в интерфейсе. В панели «Элементы» первого уровня добавьте «Регион А» без родителя. Во втором уровне добавьте «Мероприятие 1», указав ID созданного региона в поле «ID родителя». Внешние ключи, например region_a и activity_1, используйте для удобного различения элементов.

ID родителя — идентификатор элемента, а не его название или внешний ключ. Если ID не виден в таблице, администратор получает его через API списка элементов. Для проверки связей используйте фильтр по ID родителя. Ввод должен быть разрешен только на одном уровне; для корневого ввода не разрешайте его ни на одном уровне.

7.3. Тип схемы и схема

На вкладке «Типы схем» при необходимости создайте тип с системным именем main и путем модуля default. На вкладке «Схемы» нажмите «Создать схему», откройте редактирование, задайте название «Основная схема» и подходящий тип. В конструкторе добавьте необходимые поля и сохраните схему.

Рабочее место выбирает схему с main, «основ» или «глав» в соответствующих проверяемых именах, иначе первую из полученных схем. Для предсказуемого результата используйте одну явно названную основную схему. Список схем рабочего места запрашивается с ограничением 50 записей.

7.4. Поля и вычисления

Поле Пример использования
Ввод Название мероприятия
Большой текст Пояснение
Ввод чисел Плановая и фактическая суммы
Дата Дата выполнения
Выбор / Множественный выбор Один или несколько вариантов
Чекбокс / Переключатель Логический признак
Формула Расчет из других полей

Для каждого поля задайте название и «Уникальный номер поля». Например, числам присвойте plan_amount и fact_amount, формуле — total_amount. Пример сложения двух чисел в JSON Logic:

{"+": [{"var": "plan_amount"}, {"var": "fact_amount"}]}

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

7.5. Параметры и маршрут

На вкладке «Настройки» согласуйте «Уровень ввода данных» с признаками иерархии. Если нужен маршрут, включите «Согласование» и выберите «Старт маршрута». Сохраните настройки. Флаги импорта и экспорта Excel не создают готовый сценарий работы с файлами в текущей версии.

На вкладке «Маршрут» добавьте шаги. Например: шаг 1 — «утвердить», роль reviewer; шаг 2 — «подписать», роль signer. Выберите существующих пользователей или роли из списка и нажмите «Сохранить маршрут». Порядок должен идти подряд от 1 без пропусков. Перед использованием такого маршрута несколькими сотрудниками учтите ограничение доступа к ранее запущенному процессу из раздела 5.3.

7.6. Доступ

На вкладке «Доступ» выберите пользователя либо роль, область и разрешения. Добавьте правило. Для операторов примера можно выдать роли operator «чтение» и «запись» на всю форму, оставив ID области пустым. Это дает доступ ко всем записям данной формы.

Для ограничения одним мероприятием выберите область «элемент уровня» и ID самого мероприятия. Для всех записей определенного уровня используйте область «уровень» с ID этого уровня. Правило на регион не распространяется автоматически на его дочерние мероприятия.

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

8. Проверка перед началом эксплуатации

Создайте тестовую форму и запись, проверьте расчет, сохранение и повторное открытие данных. Убедитесь, что пользователь без read/write не получает и не изменяет записи через API. Для проверки самого маршрута на текущем интерфейсе можно использовать административную учетную запись и выполнить его шаги в одной открытой панели; это не заменяет проверку работы нескольких исполнителей.

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

9. Нештатные ситуации

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

В обращении укажите страницу, форму, выбранный элемент, действие, время и сообщение ошибки. Не передавайте пароль или cookie сеанса.