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

1. Роли и права доступа

Механизм разграничения прав

Права доступа формируются на трёх уровнях:

• Меню — набор доступных разделов формируется сервером индивидуально для каждого аккаунта
• MODIFY_OPTS — битовая маска, определяющая разрешённые операции над записями:

• WS-методы — доступ к конкретным REST-ресурсам по токену аутентификации
• Видимость ТС — привязка транспортных средств к аккаунту и организации

2. Вход в систему

1. Откройте приложение в браузере. Система автоматически проверит наличие активной сессии — если она действительна, вы перейдёте сразу к рабочему экрану.
2. Если сессия не найдена, отобразится экран входа. В правом верхнем углу доступен переключатель языка (русский / английский). Введите логин (email) и пароль.
3. Нажмите кнопку входа. Система выполнит аутентификацию и загрузит ваш профиль.
4. После успешного входа загрузится главный экран с боковым меню, соответствующим вашим правам.

Восстановление пароля

На экране входа доступна ссылка «Восстановить пароль». Введите адрес электронной почты, привязанный к аккаунту — на него будет отправлена ссылка для сброса пароля (действительна 24 часа). Если письмо не приходит — обратитесь к администратору системы для ручного сброса.

3. Интерфейс: структура и навигация

Компоненты экрана

Навигация

• Кликните пункт-лист в боковом меню — в рабочей области загрузится соответствующий раздел
• Поле поиска в верхней части меню фильтрует пункты по названию (регистронезависимый поиск подстроки)
• Меню можно свернуть кнопкой-гамбургером в шапке для увеличения рабочей области
• Текущий раздел и вкладка детализации отражаются в хеше URL (например, #/BB.TRANSPORT) — можно сохранять закладки на конкретные разделы

4. Работа со справочниками и реестрами

Все роли — набор доступных разделов и операций определяется правами аккаунта.

Таблица данных

Операции CRUD

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

Форма редактирования

Форма автоматически строится по метаданным раздела. Поддерживаемые типы полей:

• Текст — строковый ввод с опциональной валидацией по регулярному выражению
• Число — числовой ввод
• Дата / Время — компоненты выбора даты и времени
• Логическое — флажок (чекбокс)
• Справочное поле — автоподбор (autocomplete) с возможностью открыть полный справочник в диалоговом окне для выбора значения
• Файл — загрузка вложений

Экспорт данных

• Excel — экспорт текущего представления таблицы (с учётом фильтров и видимых столбцов) в файл .xlsx. Файл формируется на стороне клиента и скачивается в браузер

Специальные действия

Некоторые разделы содержат кнопки дополнительных действий (формирование отчёта, вызов расчёта и т.д.). При нажатии может появиться форма ввода параметров или запрос подтверждения.

5. Онлайн-мониторинг и карта

Все роли — видимость ТС зависит от аккаунта. Администратор видит все ТС системы.

Карта

Компоновка экрана

Экран онлайн-мониторинга разделён на две части с изменяемой границей (drag-to-resize): карта вверху (~45%) и таблица ТС внизу. Таблица содержит текущие статусы, параметры датчиков (температура, топливо, напряжение, зажигание, моточасы, одометр и др.), статус охраны (HOU), статус регистрации и активные тревоги.

Выбор строки в таблице центрирует карту на выбранном ТС, и наоборот — клик по маркеру выделяет строку в таблице. Строки с активными тревогами автоматически сортируются вверх.

Обновление данных

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

Конструктор параметров ТС

Помимо основной карты мониторинга, в системе доступен режим «Конструктор параметров» — расширенное представление данных с акцентом на параметры датчиков.

Графики временных рядов

Для анализа исторических данных датчиков доступен модуль графиков — визуализация значений параметров ТС во времени. Графики строятся по данным, полученным от сенсоров (температура, напряжение, уровень топлива, моточасы и др.), и позволяют выявлять тренды и аномалии.

6. Треки и события

Все роли

1. На панели онлайн-мониторинга выберите транспортное средство (клик по маркеру или строке таблицы).
2. В форме загрузки трека укажите период (дата и время начала / окончания).
3. Нажмите «Загрузить трек». Параллельно загружаются три набора данных: точки маршрута, события (остановки, превышения, заправки и т.д.) и данные температурных датчиков.
4. На карте отобразится линия маршрута с цветовой кодировкой скорости — цвет участка меняется в зависимости от скорости движения.
5. Под картой доступен интерактивный таймлайн (vis-timeline): перетаскивайте маркер-«курсор» по временной шкале, чтобы просматривать положение ТС в каждый момент времени. Таймлайн также отображает сессии движения и диапазоны событий.
6. В таблице событий загружаются связанные данные: остановки, превышения скорости, заправки, срабатывания датчиков и прочие события за период.

7. Тревоги и уведомления

Типы тревог

Каналы уведомлений

Просмотр тревог на онлайн-панели

Активные тревоги отображаются в реальном времени: маркер ТС на карте меняет цвет, в таблице появляется индикатор. Тревоги обновляются автоматически через периодический HTTP-опрос сервера (каждые 20 секунд).

• Администратор — видит тревоги по всем ТС без фильтрации
• Оператор — видит тревоги только по ТС своего аккаунта (с учётом организации и роли)

8. Отчёты

Все роли — доступные отчёты зависят от прав аккаунта.

Формируемые отчёты

Как сформировать отчёт

1. Перейдите в раздел отчётов через боковое меню.
2. Выберите тип отчёта.
3. Укажите параметры: период, ТС или группу ТС, дополнительные фильтры.
4. Нажмите «Сформировать». Для XLS/PDF — файл скачается в браузер. Для БД-отчётов — результат сохранится и отобразится в таблице.

9. Руководство: Администратор

REFR.ADMIN

Эксклюзивные возможности

Типичные задачи

1. Создание нового пользователя: Раздел «Аккаунты» → кнопка «+» → заполнить ФИО, логин (email), пароль, назначить роли → сохранить. Пользователю будут доступны разделы меню и операции, соответствующие назначенным ролям.
2. Привязка ТС к аккаунту: Раздел «Транспорт» или детализация аккаунта → вкладка связанных ТС → добавить привязку. Видимость ТС на карте и в отчётах определяется этими привязками.
3. Настройка тревог: Активация типов тревог выполняется через переменные окружения APP_SUPPORTED_ALARMS_* в .env / docker-compose.yml при развёртывании. Перезапустите сервис alarm-service после изменений.
4. Сброс пароля пользователя: Пользователь может восстановить пароль самостоятельно через форму на экране входа. При необходимости администратор может сбросить пароль вручную через раздел «Аккаунты».
5. Мониторинг сервисов: Откройте http://<сервер>:9103 — Spring Boot Admin покажет статус каждого микросервиса, логи и метрики.

10. Руководство: Управление ТК / Руководитель ТК

REFR.MANAGE_TK REFR.HEAD_TK_DEPARTMENT

Ключевые возможности

Типичный рабочий день

1. Утром: откройте онлайн-мониторинг — убедитесь, что все ТС на связи, нет критических тревог.
2. Проверка уведомлений: просмотрите email / Telegram на предмет тревог за ночь (отключения питания, сливы).
3. Анализ маршрутов: загрузите треки интересующих ТС за вчерашний день, проверьте соответствие маршрутам.
4. Формирование отчётов: при необходимости сформируйте отчёт по топливу или движению за неделю / месяц.

11. Руководство: Оператор / Диспетчер

Базовая роль

Ключевые возможности

Типичные задачи

1. Контроль ТС в реальном времени: откройте онлайн-мониторинг, проверьте статусы. Красные маркеры — тревоги, серые — потеря связи.
2. Поиск ТС: используйте фильтр в таблице ТС по номеру или названию. Клик по строке центрирует карту.
3. Просмотр трека: выберите ТС → укажите период → загрузите трек. Используйте таймлайн для пошагового просмотра.
4. Работа со справочником: выберите раздел в меню → при необходимости примените фильтры → добавьте / измените записи.
5. Экспорт: отфильтруйте нужные данные → нажмите кнопку экспорта → файл .xlsx скачается в браузер.

12. Частые вопросы

Не вижу ТС на карте

• Убедитесь, что слой «Транспорт» включён в панели слоёв карты
• Проверьте масштаб карты — при мелком масштабе маркеры группируются в кластеры (pie-диаграммы). Кликните по кластеру для раскрытия
• Если ТС нет вообще — оно может быть не привязано к вашему аккаунту. Обратитесь к администратору

Сессия истекла — данные потеряны

• Сессия (JWT-токен) живёт 1 час. При истечении появится оверлей для повторного входа
• После успешной переавторизации рабочее состояние восстанавливается без перезагрузки страницы
• Если страница была перезагружена — несохранённые данные формы будут потеряны

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

• Проверьте, отображается ли кнопка редактирования. Если нет — права не выданы (бит 2 в MODIFY_OPTS)
• Обратитесь к администратору для изменения прав вашего аккаунта

Трек не загружается

• Проверьте, что выбран корректный период (ТС могло не передавать данные в указанные даты)
• Для больших периодов (более 7 дней) загрузка может занять до минуты
• Убедитесь, что указаны и дата, и время начала / окончания

Не приходят уведомления о тревогах

• Email и Telegram уведомления доступны только для ролей REFR.MANAGE_TK и REFR.HEAD_TK_DEPARTMENT
• Каналы уведомлений настраиваются администратором при развёртывании
• Убедитесь, что нужный тип тревоги активирован (по умолчанию включены только «Отключение питания» и «Пересечение запретной территории»)

Как изменить язык интерфейса?

• На экране входа — переключатель языка в правом верхнем углу (RU / EN)
• Язык интерфейса рабочей области определяется настройками сессии, заданными при входе

Как быстро найти нужный раздел в меню?

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

Как использовать фильтры столбцов?

• Нажмите Ctrl+F в любой таблице — под заголовками столбцов появятся поля ввода для фильтрации
• Фильтрация происходит мгновенно по мере ввода текста

Где посмотреть все документы по системе?

• Архитектура системы — техническое описание, схемы микросервисов, Kafka, БД
• Руководство по развёртыванию — пошаговая инструкция по установке
• Функциональные характеристики — описание возможностей системы
• Данный документ — руководство пользователя по ролям