Документация системы MDM СОЮЗ

Полное руководство по установке, настройке и использованию системы управления мастер-данными

Содержание документации

Введение в систему MDM

Система МДМ (Master Data Management) СОЮЗ — это комплексное решение для управления мастер-данными организации. Система позволяет создавать модели данных, управлять пользователями, ролями, правами доступа, а также работать со справочными данными через веб-интерфейс на базе SmartClient фреймворка.

Основные возможности системы

Возможности системы

Система MDM СОЮЗ предоставляет следующие основные возможности:

Управление моделями данных

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

Система безопасности

Интеграция

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

В данном разделе описаны основные возможности системы MDM для пользователей. Вы узнаете, как работать с моделями данных, управлять справочниками, использовать историчность и иерархические структуры данных.

Аутентификация и авторизация

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

Для входа в систему выполните следующие шаги:

1 Откройте браузер и перейдите на http://localhost:8080
2 Откроется окно авторизации с формой входа
3 Заполните поля:
  • Имя пользователя — поле для ввода логина
  • Пароль — поле для ввода пароля
  • Запомнить — чекбокс для сохранения учетных данных
4 Нажмите кнопку "Войти" или клавишу Enter
Форма входа в систему

Форма входа в систему

Сброс пароля

Если вы забыли пароль, используйте функцию сброса:

1 Нажмите кнопку "Сбросить пароль"
2 Откроется дополнительное окно с полями:
  • E-mail — поле для ввода электронной почты
  • Code — поле для кода подтверждения (появляется после отправки)
  • Password — новое пароль (появляется после отправки)
  • Confirm — подтверждение пароля (появляется после отправки)
    Окно сброса пароля

    Окно сброса пароля

Структура интерфейса после входа

После успешной авторизации открывается главное окно системы со следующей структурой:

Главное окно системы

Главное окно системы

Верхнее меню

Левая панель

Основная область

Управление метаданными (моделями)

Модуль позволяет создавать и настраивать модели данных (сущности) системы.

Доступ к разделу моделей данных

1 В верхнем меню нажмите кнопку "Модели данных" (иконка модели)
2 Откроется раздел "Модели" с табличным интерфейсом

Структура интерфейса моделей данных

Раздел "Модели данных" содержит:

Кнопки управления

Таблица моделей

Содержит колонки:

Создание новой модели

1 В разделе "Модели данных" нажмите кнопку "Добавить"
2 Откроется окно "Создать модель данных" со следующими полями:
  • Код — техническое имя модели (обязательное)
  • Название — отображаемое имя модели (обязательное)
  • Описание — многострочное поле для подробного описания
  • Исторический — чекбокс для включения поддержки истории изменений
  • Иерархический — чекбокс для включения поддержки древовидной структуры
3 Заполните обязательные поля (Код, Название)
4 Установите необходимые чекбоксы (Исторический, Иерархический)
5 Нажмите кнопку "Сохранить"
Форма создания новой модели

Форма создания новой модели

Настройка атрибутов модели

После создания модели автоматически открывается интерфейс с двумя вкладками:

Вкладка "Параметры"

Форма редактирования основных параметров модели:

Кнопки управления параметрами

Вкладка "Атрибуты"

Таблица существующих атрибутов с колонками:

Создание атрибута модели

1 Перейдите на вкладку "Атрибуты"
2 Нажмите кнопку "Добавить"
3 Откроется окно "Новый атрибут" со следующими полями:

Основные параметры

  • Код — техническое имя атрибута (обязательное поле)
  • Наименование — отображаемое имя атрибута (обязательное поле)
  • Описание — многострочное поле для описания атрибута

Свойства атрибута

  • Тип поля — выпадающий список типов данных:
    • STRING — Строковый тип для текстовых данных, кодов, названий
    • NUMERIC — Числовой тип для целых и дробных чисел
    • DATETIME — Дата и время для дат и временных меток
    • TEXT — Многострочный текст для описаний и комментариев
    • INTEGER — Целые числа для счетчиков, ID, количеств
    • BusinessEntities — Ссылки на контрагентов
    • Items — Ссылки на номенклатуру (товары)
    • ItemGroups — Ссылки на группы товаров
    • ItemTypes — Ссылки на типы товаров
    • BPGroup — Ссылки на группы контрагентов
    • Warranty — Гарантийные условия
    • AddressType — Типы адресов
    • Addresses — Ссылки на адреса
    • Accounts — Ссылки на счета
    • Subscriptions — Подписки
    • TestDict — Тестовые справочники
    • SystemAudit — Аудит системы

Дополнительные настройки

  • Параметры — текстовое поле для дополнительных параметров типа
  • Ширина колонки — числовое значение ширины в таблице
  • Форматирование колонки — текстовое поле для форматирования отображения
  • Регулярное выражение — маска для валидации ввода

Чекбоксы свойств

  • Первичный ключ — атрибут является первичным ключом
  • Представление — атрибут используется для отображения записи
  • Обязательный параметр — поле обязательно для заполнения
  • Скрытое поле — атрибут скрыт в интерфейсе
  • Нередактируемое — атрибут недоступен для редактирования
4 Заполните обязательные поля (Код, Наименование)
5 Выберите тип данных из выпадающего списка "Тип поля"
6 Настройте дополнительные параметры при необходимости
7 Установите необходимые чекбоксы свойств
Форма создания атрибута

Форма создания атрибута

8 Нажмите кнопку "Сохранить"
Форма создания атрибута

Форма создания атрибута

Управление справочными данными

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

Важно понимать разницу:
  • Модель данных — это шаблон (структура) для хранения информации
  • Справочник — это таблица с данными, созданная на основе модели
  • Запись в справочнике — это одна строка данных в таблице

Пример работы со справочниками

Модель данных "Товары" определяет структуру (поля: Код, Название, Цена)

Справочник "Товары" — таблица с товарами

Запись — конкретный товар (Код: 2, Название: "Товар 3", Цена: 4444)

Доступ к справочникам

1 В левой панели навигации раскройте дерево модулей
2 Найдите нужный справочник в разделе опубликованных моделей
3 Кликните по названию справочника для открытия
Как появляются новые справочники:
  • Справочники создаются автоматически при публикации модели данных
  • При создании модели в разделе "Модели данных" и её публикации
  • Система создает соответствующий справочник для работы с данными

Структура интерфейса справочника

Интерфейс справочника разделен на три основные области:

Интерфейс справочника

Интерфейс справочника

Левая панель навигации

Основная область (центр)

Верхняя панель инструментов:

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

Правая панель фильтров

Панель фильтров

Панель фильтров

Интерфейс справочника

Интерфейс справочника

Создание записи в справочнике

1 В открытом справочнике нажмите кнопку "Создать" (зеленая кнопка с плюсом)
2 Откроется форма создания записи с полями:
  • Все атрибуты модели в виде полей ввода
  • Обязательные поля помечены (*)
  • Ссылочные поля — выпадающие списки
  • Логические поля — чекбоксы
3 Заполните все обязательные поля (*)
4 Для ссылочных полей выберите значения из выпадающих списков
5 Нажмите кнопку "Сохранить" или Enter
Форма создания записи

Форма создания записи

для создания записи
Важно: Кнопка "Создать" в справочнике создает новую запись (строку данных), а не новый справочник. Для создания нового справочника нужно создать и опубликовать новую модель данных в разделе "Модели данных".

Работа с историчностью данных

Система поддерживает хранение полной истории изменений данных для аудита и восстановления.

Включение историчности для модели

1 При создании или редактировании модели данных установите чекбокс "Исторический"
2 Укажите глубину хранения истории — количество сохраняемых версий изменений
3 Система автоматически потребует добавить обязательные атрибуты:
  • CommitDate — поле типа DateTime для фиксации времени изменения
  • CommitUser — поле для указания пользователя, внесшего изменение
Важно: Без этих атрибутов историчность работать не будет

Работа с историческими данными в справочнике

Для справочников с включенной историчностью:

Просмотр истории изменений

1 Откройте нужную запись в справочнике
2 Перейдите на вкладку "История"
3 Откроется интерфейс истории со следующими элементами:
  • Выпадающий список версий — выбор версии модели для просмотра
  • Таблица изменений — дерево с параметрами и их значениями
  • Кнопки управления:
    • Отмена — закрыть окно истории
    • Откатить — восстановить выбранную версию
Скриншот: Интерфейс истории изменений

Интерфейс истории изменений

Откат версии модели

1 В выпадающем списке выберите нужную версию для восстановления
2 Нажмите кнопку "Откатить"
3 Подтвердите откат в диалоговом окне
4 Система восстановит выбранную версию модели
Важно: Восстановление исторических данных требует прав на редактирование соответствующих справочников

Работа с иерархическими данными

Система поддерживает древовидные структуры данных для организации иерархических справочников.

Включение иерархичности для модели

1 При создании или редактировании модели данных установите чекбокс "Иерархический вид"
2 Система автоматически потребует добавить обязательный атрибут:
  • Parent — поле типа "Ссылка на текущую модель" для указания родительского элемента
Важно: Без атрибута Parent иерархичность работать не будет

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

Для справочников с включенной иерархичностью:

Древовидное отображение

Записи отображаются в виде дерева с возможностью:

Типы элементов

📸 Скриншот: Иерархическое представление данных
Здесь будет размещен скриншот древовидного интерфейса

Создание иерархической структуры

1 Корневые элементы создаются с пустым значением Parent
2 Дочерние элементы создаются с указанием родительского элемента в поле Parent
3 Глубина вложенности не ограничена

Навигация в дереве

Операции с узлами дерева

Добавление элементов

Перемещение элементов

Удаление элементов

Важно: Работа с иерархическими данными требует понимания структуры и правильного указания родительских элементов

Руководство администратора

В данном разделе описаны функции системы MDM для администраторов. Вы узнаете, как управлять пользователями, настраивать роли и права доступа, мониторить систему и обеспечивать безопасность.

Управление пользователями

Доступ к разделу пользователей

1 В верхнем меню нажмите "Администрирование"
2 В выпадающем меню выберите "Пользователи"
3 Откроется раздел "Пользователи" с табличным интерфейсом

Структура интерфейса пользователей

Интерфейс управления пользователями

Интерфейс управления пользователями

Раздел "Пользователи" содержит:

Кнопки управления

Таблица пользователей

Содержит колонки:

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

1 В разделе "Пользователи" нажмите кнопку "Добавить"
2 Откроется окно "Создать пользователя" со следующими полями:
  • Имя пользователя — логин для входа (обязательное)
  • Пароль — пароль для аутентификации (обязательное)
  • Полное имя — ФИО пользователя (обязательное)
  • Роль — выпадающий список ролей (обязательное)
  • E-mail — адрес электронной почты (обязательное)
  • Активный — чекбокс активации учетной записи
3 Заполните все обязательные поля (*)
4 Выберите роль из выпадающего списка
Форма создания пользователя

Форма создания пользователя

5 Нажмите кнопку "Сохранить"

Смена пароля пользователя

Смена пароля пользователя

Смена пароля пользователя

1 Выберите пользователя в таблице
2 Нажмите кнопку "Изменить пароль"
3 Откроется окно "Изменить пароль" со следующими полями:
  • Пароль — новое пароль
  • Повтор пароля — подтверждение пароля
4 Введите новый пароль в оба поля
5 Пароли должны совпадать
6 Нажмите кнопку "Сохранить"
Важно: Управление пользователями требует прав System.Users.Read для просмотра и System.Users.Write для изменений

Роли

Роли определяют набор прав доступа для пользователей системы.

Ролевая модель доступа (RBAC)

Система использует ролевую модель доступа для управления правами пользователей:

Структура ролей

Типы прав доступа

Права формируются по шаблону: Категория.Объект.Действие

Примеры прав:
  • System.Users.Read — просмотр пользователей
  • System.Users.Write — управление пользователями
  • System.Roles.Read — просмотр ролей
  • Model.{НазваниеМодели}.Publish — публикация модели
  • Reference.{НазваниеСправочника}.Read — чтение справочника

Доступ к разделу ролей

1 В верхнем меню нажмите "Администрирование"
2 В выпадающем меню выберите "Роли"
3 Откроется раздел "Роли" с интерфейсом управления ролями
Доступ к разделу ролей

Доступ к разделу ролей

Структура интерфейса ролей

Интерфейс управления ролями

Интерфейс управления ролями

Раздел "Роли" содержит три основные области:

Верхняя панель

Левая панель (права доступа)

Правая панель (интерфейс)

Создание новой роли

1 В разделе "Роли" нажмите кнопку "Добавить"
2 Откроется окно "Создать роль" со следующими полями:
  • Name — название роли (обязательное поле)
3 Введите название роли (например, "Менеджер по продажам")
Форма создания роли

Форма создания роли

4 Нажмите кнопку "Сохранить"

Назначение прав роли

1 В верхней панели выберите созданную роль из выпадающего списка
2 В левой панели отобразятся все доступные права системы
3 Для каждого права установите чекбокс "Разрешить":
  • Отмеченные права — разрешены для роли
  • Снятые права — запрещены для роли
4 Используйте кнопки "Выделение" для групповых операций:
  • Выбрать все — разрешить все права
  • Снять выделение — запретить все права
5 Введите текст в поле "Поиск" для фильтрации прав
6 Права сохраняются автоматически при изменении чекбоксов
Назначение прав роли

Назначение прав роли

Создание нового права доступа

1 В меню "Действия" выберите "Добавить вид доступа"
2 Введите наименование нового права доступа
3 Право будет добавлено в список доступных прав
Важно: Управление ролями требует прав System.Roles.Read для просмотра и System.Roles.Write для изменений

Операции

Журнал операций

В разделе "Администрирование" → "Операции" доступен мониторинг системы:

Журнал операций

Таблица операций содержит

Фильтрация и поиск

Параметры системы

В разделе "Администрирование" → "Настройки" доступны параметры конфигурации:

Основные параметры

Параметры безопасности

Параметры уведомлений

Важно: Изменение настроек системы требует перезапуска приложения для применения изменений

Журнал аудита

Рекомендации по безопасности

В разделе "Администрирование" → "Журнал Аудита" доступна детальная информация:

Детали аудита

Отслеживаемые события

Доступ к журналу аудита

1 В верхнем меню нажмите "Администрирование"
2 В выпадающем меню выберите "Журнал Аудита"
3 Откроется интерфейс с детальной информацией об операциях
Информация: Журнал аудита ведется автоматически и содержит полную историю изменений в системе

Настройка системы

Параметры системы

В разделе "Администрирование" → "Настройки" доступны параметры конфигурации:

Основные параметры

Параметры безопасности

Параметры уведомлений

Важно: Изменение настроек системы требует перезапуска приложения для применения изменений

Установка и развертывание

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

Архитектура системы

Система построена на следующих технологиях:

1 Backend: Java Spring Boot с JPA/Hibernate
2 База данных: PostgreSQL
3 Frontend: SmartClient (JavaScript фреймворк)
4 Аутентификация: JWT токены
5 Интерфейс: Веб-приложение с деревом навигации и табличным представлением данных

Системные требования

Минимальные требования

1 Java: версия 8 или выше
2 Maven: версия 3.6 или выше
3 PostgreSQL: версия 9.5 или выше
4 ОЗУ: минимум 2 ГБ
5 Дисковое пространство: минимум 1 ГБ
Рекомендуемые требования: Java 11, Maven 3.8+, PostgreSQL 12+, 4 ГБ ОЗУ, 5 ГБ дискового пространства

Настройка и запуск

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

1. Настройка базы данных

# Создание базы данных для МДМ CREATE DATABASE mdm; CREATE USER postgres WITH PASSWORD '123456'; GRANT ALL PRIVILEGES ON DATABASE mdm TO postgres;

2. Конфигурация

Измените настройки подключения в файле application.properties:

# Настройки подключения к базе данных jdbc.url=jdbc:postgresql://localhost:5432/mdm jdbc.user=postgres jdbc.pass=123456

3. Запуск системы

# Запуск приложения mvn spring-boot:run
Важно: После успешного запуска система будет доступна по адресу http://localhost:8080

Интеграция и API

REST API

Система предоставляет REST API для интеграции с внешними системами:

Базовый URL: http://localhost:8080/rest/v1/

Аутентификация

POST /rest/Login Content-Type: application/json { "login": "user", "password": "password" }

Получение токена для дальнейших запросов

POST /rest/startup Authorization: Bearer <token> Content-Type: application/json

Основной endpoint для работы с данными

POST /rest/v1/{type}/{module} Authorization: Bearer <token> Content-Type: application/json { "dataSource": "{НазваниеСправочника}", "operationType": "fetch|add|update|remove", "data": { // Данные для операции } }

Примеры операций API

Получение списка записей справочника

# Получение списка записей справочника POST /rest/v1/Reference/Customers Authorization: Bearer <token> Content-Type: application/json { "dataSource": "Customers", "operationType": "fetch", "startRow": 0, "endRow": 50 }

Создание новой записи

# Создание новой записи POST /rest/v1/Reference/Customers Authorization: Bearer <token> Content-Type: application/json { "dataSource": "Customers", "operationType": "add", "data": { "name": "Новый клиент", "email": "client@example.com", "phone": "+7-999-123-4567" } }

Обновление записи

# Обновление записи POST /rest/v1/Reference/Customers Authorization: Bearer <token> Content-Type: application/json { "dataSource": "Customers", "operationType": "update", "data": { "id": 123, "name": "Обновленный клиент", "email": "updated@example.com" } }

Удаление записи

# Удаление записи POST /rest/v1/Reference/Customers Authorization: Bearer <token> Content-Type: application/json { "dataSource": "Customers", "operationType": "remove", "data": { "id": 123 } }

Публикация модели

POST /rest/api/publish/validate Authorization: Bearer <token> Content-Type: application/json { "metadataId": 123 } POST /rest/api/publish/execute Authorization: Bearer <token> Content-Type: application/json { "metadataId": 123, "createVersion": false }

Управление версиями модели

POST /rest/api/rollback/version Authorization: Bearer <token> Content-Type: application/json { "metadataId": 123, "version": 1 } POST /rest/api/rollback/execute Authorization: Bearer <token> Content-Type: application/json { "metadataId": 123, "version": 1 }

Устранение неполадок

В данном разделе описаны основные проблемы, которые могут возникнуть при работе с системой MDM, и способы их решения.

Частые проблемы

1. Ошибка подключения к базе данных

Решение:
  1. Проверьте настройки в файле application.properties
  2. Убедитесь, что PostgreSQL сервер запущен и доступен
  3. Проверьте права доступа пользователя БД
  4. Проверьте сетевые настройки firewall

2. Ошибка аутентификации

Решение:
  1. Убедитесь в правильности логина и пароля
  2. Проверьте, что пользователь активен в системе
  3. Проверьте срок действия токена аутентификации
  4. Используйте функцию сброса пароля при необходимости

3. Ошибка публикации модели

Решение:
  1. Проверьте наличие атрибута представления (должен быть ровно один)
  2. Убедитесь в правильности типов данных атрибутов
  3. Проверьте права доступа пользователя на публикацию модели
  4. Изучите сообщения об ошибках валидации

4. Медленная работа системы

Решение:
  1. Оптимизируйте запросы в PostgreSQL (добавьте индексы)
  2. Настройте параметры кеширования
  3. Проверьте производительность сервера БД
  4. Оптимизируйте структуру моделей данных

5. Ошибки в интерфейсе

Решение:
  1. Очистите кеш браузера и перезагрузите страницу
  2. Проверьте консоль браузера на ошибки JavaScript
  3. Убедитесь в совместимости браузера с SmartClient

Диагностика

Логи приложения

Мониторинг производительности

Полезные SQL-запросы

# Проверка подключений к базе данных SELECT * FROM pg_stat_activity WHERE datname = 'mdm'; # Проверка размера базы данных SELECT pg_size_pretty(pg_database_size('mdm'));

Поддержка и развитие

При возникновении проблем или для получения дополнительной информации:

1 Документация — изучите настоящее руководство
2 Журнал операций — проанализируйте историю действий
3 Администратор системы — обратитесь за помощью
4 Техническая поддержка — создайте заявку с детальным описанием проблемы

Рекомендации по развитию системы

Версия документа: 3.3
Дата последнего обновления: Октябрь 2025
Основание для обновления: Разъяснение механизма работы справочников - отличие моделей данных от справочников, автоматическое создание справочников при публикации моделей