Киберфизическая поисковая ЭКОсистема

Суть проекта
Цифровая платформа для хранения и поиска по нормативно-техническим, справочным и методическим
документам «ВасПонял»
Состоит из:
▪ Управляющая оболочка с системой точного поиска
▪ Обновляемая база нормативно
технических, отраслевых документов, комментариев, разъяснений, справочной, консультационной информации
▪ Чат-бот помощник для быстрого
подключения пользователя к единой горячей линии

Требования к серверам (в разработке)
Аутентификация
Загрузка данных
Клиент/сервер/gitlab/
chat
ElasticSearch/Redis
4 core
8 GB RAM
200 GB SSD
1000 Mbit/s Internet
8 core
16 GB RAM
3 TB HDD SATA
1000 Mbit/s Internet
16 core
16 GB RAM
200 GB SSD
1000 Mbit/s Internet
16 core
32 GB RAM
3 TB HDD SATA
1000 Mbit/s Internet
1
2
3
4
Backup
4 core
8 GB RAM
3TB HDD SATA
1000 Mbit/s Internet
5

Авторизация
Поддерживается самостоятельная регистрация пользователя через email и заведение пользователей администратором системы через панель Keycloak
Пользователь самостоятельно может сбросить пароль, через email в случае, если его забудет
Поддерживается функция «Запомнить меня»

Документы
Поддерживается загрузка документов в любых форматах
Для индексации поддерживаются документы в формате rtf
Документ, помимо текста, имеет ряд атрибутов:
Тип документа (ГОСТ, СП,…)
Статус (действующий, недействующий,…)
Дата вступления
Дата истечения
Принявший орган
Авторство
Документы, которые ссылаются на этот документ
Документы, на которые ссылается документ
…(полный список доступен в приложении)

Группировка документов
Продукт лицензируется по разделам, которые продаются отдельно. Пример: промышленная безопасность, лаборатории.
Один документ может относиться сразу к нескольким разделам (например, быть и в промышленной безопасности, и в лабораториях)
Разделы могут делиться на подразделы (TBD)

Главная страница: компоненты
Поиск
Выход из системы
Связь с поддержкой (в разработке)
Уведомления (в разработке)
Личный кабинет (в разработке)
Подразделы (в разработке)
Уведомления и новости (в разработке)

Результат поиска
Результаты поиска выдаются постранично по 10 документов
Помимо результата поиска выдается его score, источник, статус и дата принятия
Поддерживается фильтрация по Типу документа, Статусу
Поддерживается поиск по точному совпадению
Нажатие на заголовок документа ведет к открытию упрощенной версии
Нажатие на кнопку «Открыть» ведет к открытию полной версии.

Просмотр документа
Упрощенная версия документа
Версия, которая изначально хранится в виде html в Elastic, не содержит сложных таблиц и картинок.
Открывается менее 1 секунды
Полная версия документа
Версия конвертируется на лету при нажатии кнопки из rtf документа
Содержит таблицы, рисунки
Поддерживается увеличение и уменьшение размера шрифта, открытие в новом окне
Поддерживается функция «Скопировать ссылку» при нажатии ссылка на данный документ копируется в буфер обмена. При нажатии ссылки открывается данный документ в полной версии в новом окне.
Поддерживается сохранение документа в rtf. При нажатии кнопки происходит скачивание документа из S3

CMS
Разработанная CMS поддерживает следующие виды обновлений документов:
заменить существующий документ полностью
обновить часть атрибутов существующего документа
удалить документ
загрузить новый документ
обновить список связанных документов
Протокол:
метод POST
формат application/json
кодировке UTF-8
имена параметров в нижнем регистре
путь в S3 первая папка это имя бакета
возвращает 200 в случае успешного завершения

CMS – операции (1/2)
Замена существующего документа полностью:
Обязательные атрибуты
Дополнительные атрибуты
(в случае указания, будут обновлены)
Готово
Id заменяемого документа
Id документа в источнике
Имя файла
Путь файла
Название документа
Атрибуты документа (орган принятия, вид и пр.
Тип документа
Статус документа
Обновление атрибутов существующего документа:
Обязательные атрибуты
Дополнительные атрибуты
(в случае указания, будут обновлены)
Готово
Id заменяемого документа
Id документа в источнике
Название документа
Атрибуты документа (орган принятия, вид и пр.
Тип документа
Статус документа

CMS – операции (2/2)
Загрузка нового документа:
Обязательные атрибуты
Дополнительные атрибуты
(в случае указания, будут обновлены)
Готово
Id документа в источнике
Имя файла
Путь файла
Статус
Дата изменения статуса
Тип документа
Название документа
Атрибуты документа (орган принятия, вид и пр.
Обновление списка связанных документов:
Обязательные атрибуты
Id документа
Id документа в источнике
Список id документов, на которые ссылается данный документ
Готово
Удаление документа:
Обязательные атрибуты
Id документа
Id документа в источнике
Готово

Пакетное обновление документов из ТЭ (1 версия)
Для пакетного обновления используется 4 раздела про обновленные документы на Главной странице ТЭ:
Производится парсинг 4 подразделов обновленных документов (Новые документы, Измененые документы, Вступившие в силу, Скоро вступают в силу). В список сохраняются id всех документов, которые представлены в этих разделах. Список единый для всех подразделов.
Из ТЭ выгружаются документы из этого списка и их атрибуты.
Производится загрузка новых версий всех документов, которые есть в списке.
Если в системе уже есть такой документ, то он удаляется и прогружается заново со всем атрибутами
В дальнейшем возможен более сложный механизм обновления, при котором действие будет зависеть от раздела обновленных документов

Пакетное обновление документов из ТЭ (схема)
Вступившие в силу
Новые документы
Измененные документы
Скоро вступают в силу
Парсинг 4 разделов ТЭ
Единый список обновляемых документов
Документ с таким id уже есть?
Заливаем новый документ и его атрибуты
Удаляем предыдущую версию документа
Для каждого документа из списка