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

Описание функциональных характеристик программного обеспечения DoXML

Содержание

  1. Организации, аккаунты и ролевая модель
  2. Управление проектами и документами
  3. Редактор форм документов
  4. Работа с XML-схемами и валидация
  5. Генерация и экспорт документов
  6. Управление файлами и общими папками
  7. Аутентификация и безопасность
  8. Совместная работа и приглашения
  9. Тарифы и лицензирование
  10. Панель управления организацией
  11. OCR и автозаполнение
  12. REST API и интеграции
  13. Пользовательский интерфейс

Программный комплекс DoXML (далее — ПО) предназначен для создания, редактирования, валидации, управления и экспорта проектной документации в соответствии с требованиями Минстроя Российской Федерации.

1. Организации, аккаунты и ролевая модель

  • Работа в рамках организаций с ролевой моделью.
  • Каждый пользователь может состоять в нескольких организациях.
  • Ролевая модель: ACCOUNT_OWNER, ADMIN, USER, GUEST.
  • Разделение прав на уровне организации, проекта и документа.

2. Управление проектами и документами

  • Создание, редактирование и удаление проектов.
  • Создание, редактирование и удаление документов типов ЗНП, ВОР, ПЗ и других.
  • Поиск, фильтрация, сортировка проектов и документов.
  • Привязка документов к проекту и копирование реквизитов.
  • История изменений и отчёты об изменениях (change reports).

3. Редактор форм документов

  • Пошаговый редактор форм на основе JSON Schema, порождённой из XSD-схем.
  • Динамическая навигационная панель по разделам документа.
  • Поддержка таблиц, вложенных блоков, условного отображения полей.
  • Автосохранение с индикатором статуса.
  • Поддержка соло- и коллаборативного редактирования.
  • Поиск по содержимому документа.

4. Работа с XML-схемами и валидация

  • Формирование XML-документов на основе данных формы.
  • Валидация по XSD-схемам Минстроя РФ.
  • Автоматическое обнаружение ошибок с указанием места и описания.
  • Переход к полям с ошибками из панели валидации.
  • Поддержка версионирования схем и конвертации между версиями.

5. Генерация и экспорт документов

  • Генерация XML-файлов по заполненным данным.
  • Преобразование в HTML для предварительного просмотра.
  • Генерация PDF и DOCX на основе XML-данных.
  • Экспорт в форматы XML, PDF, DOCX, HTML.

6. Управление файлами и общими папками

  • Загрузка файлов через веб-интерфейс (drag-and-drop).
  • Хранение файлов в S3-совместимом объектном хранилище (Apache Ozone).
  • "Мой диск" — персональное файловое хранилище пользователя.
  • Общие папки проекта с доступом по ссылке и паролем.
  • Сравнение версий файлов.

7. Аутентификация и безопасность

  • Регистрация и вход по email/пароль.
  • JWT-аутентификация с refresh-токенами.
  • Подтверждение email и SMS-подтверждение телефона.
  • Двухфакторная аутентификация (OTP).
  • Восстановление пароля по email/SMS.
  • Ограничение частоты запросов, CSRF-защита, CORS.
  • SSL/TLS через Traefik.

8. Совместная работа и приглашения

  • Приглашение пользователей в организацию, проект, документ.
  • Управление правами доступа.
  • Уведомления о приглашениях и изменениях.
  • Совместное редактирование документов.

9. Тарифы и лицензирование

  • Просмотр доступных тарифов.
  • Управление тарифным планом организации.
  • Лицензирование через вендорский ключ.
  • Проверка лимитов пользователей и функциональных возможностей.

10. Панель управления организацией

  • Управление пользователями и приглашениями.
  • Управление проектами и документами организации.
  • Настройки организации и реквизиты.
  • Управление типами документов.
  • Публикация новостей и объявлений.
  • Статистика использования.
  • Управление лицензией.

11. OCR и автозаполнение

  • Распознавание текста в загруженных документах (OCR).
  • Автозаполнение полей документа по данным проекта.
  • Интеграция со справочниками (ОКТМО, ОКСМ, адреса, организации).
  • Сохранённые реквизиты для быстрого заполнения.

12. REST API и интеграции

  • REST API серверной части на Java Spring Boot (префикс /api/v1).
  • Control Panel API (/api/v1/control-panel).
  • Интеграция с серверами обновления вендора.
  • Вебхуки платёжной системы ЮKassa.
  • Интеграция со SMSC.ru для SMS-уведомлений.

13. Пользовательский интерфейс

  • React 18 + Vite + TypeScript.
  • Адаптивный интерфейс для современных браузеров.
  • Два клиентских приложения: пользовательское приложение и панель управления организацией.
  • Поддержка русского языка интерфейса.
  • Интерактивные таблицы, диалоги, уведомления.
Скачать документ