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

Модуль «Сервис ФЛК для Витрины данных» предназначен для интеграции ГИСОГД субъекта Российской Федерации и Витрины данных и выполняет следующие функции:

авторизация и аутентификация с использованием безопасного доступа к сервисам ETL (при необходимости);

форматно-логический контроль (ФЛК) данных перед отправкой в Витрину данных для обеспечения корректности и соответствия требованиям;

передача сведений, документов и материалов из ГИСОГД субъекта РФ в Витрину данных, включая:

загрузку системных справочников;

создание, обновление и удаление объектов данных;

получение информации по результатам загрузки данных в Витрину данных.

Авторизация#

Работа с веб-интерфейсом диагностики интеграции доступна по ссылке вида https://{host}:8085. Учетную запись для авторизации можно получить у администратора системы.

Интерфейс#

После авторизации в системе пользователь попадает на стартовую страницу (дашборд).

Интерфейс сервиса состоит из:

рабочей области, предназначенной для работы с инструментами диагностики интеграции;

боковой панели навигации, содержащей разделы диагностики интеграции с наборами инструментов:

Дашборд;

Объекты DLQ;

Объекты в обработке;

Детали объекта;

Диаграмма зависимостей.

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

Обработка данных;

В очереди DLQ есть объекты (или информация об их отсутствии);

Нет ошибок обработки (или количество ошибок);

Авторизация ЕИС «http://Стройкомплекс.РФ » (статус: «Активна» / «Неактивна»);

Redis;

Kafka;

Сервис интеграции (количество реплик и их статус).

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

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

Чтобы загрузить на компьютер файл отчета в формате .xlsx, после выбора отчетного периода нажмите кнопку Скачать отчёт.

Чтобы сбросить отчетный период, выбранный в интерфейсе, нажмите кнопку Сбросить.

Чтобы закрыть модальное окно выбора периода, нажмите кнопку Отмена.

Раздел «Сервисные операции» содержит перечень действий, доступных для быстрого запуска. Например:

Обработчик застрявших объектов – переобработка объектов, которые «зависли» или не были корректно обработаны;

Обработчик перевода объектов в статус DLQ – принудительная отправка проблемных объектов в очередь DLQ;

Обработчик очистки кэша – очистка обработанных данных из кэша.

Для запуска любой операции наведите курсор мыши на блок «Обработчик» и нажмите кнопку «Запустить» (она появится при наведении мыши на необходимый блок).

Разделы «Создание», «Обновление», «Удаление»#

При переходе на боковой панели навигации в разделы «Создание», «Обновление», «Удаление» отобразится таблица с набором столбцов:

ID объекта – уникальный идентификатор объекта (GUID или другой код);

Тип – тип объекта (например, WheelchairLifts, Customer, GPZInfoP2_5 и т. д.);

Статус – текущее состояние объекта (например, VERIFIED, PENDING, VALIDATION_ERROR и пр.);

Время создания – дата и время, когда объект был добавлен в систему;

Действия – набор кнопок, позволяющих посмотреть детали объекта в формате JSON, перейти к просмотру зависимостей объекта.

Чтобы выполнить поиск по GUID объекта, введите в поле [Поиск по GUID объекта] полностью или частично GUID. По мере ввода система фильтрует список и отображает только те записи, которые соответствуют поисковому запросу. Если введён полный GUID, в результате отобразиться единственная строка с точным совпадением.

Чтобы выполнить фильтрацию объектов по типу, нажмите на выпадающий список «Все типы» и выберите подходящее значение. Например, InboxData, Organization, Supplier, Territory, DataSection1 и т. д. Таблица обновится и отобразит только объекты выбранного типа.

Для фильтрации объектов по статусу нажмите на выпадающий список «Все статусы» и выберите подходящее значение. Например, PENDING, SENT_VAL, VALIDATION_ERROR, VERIFIED и пр. Таблица отфильтруется по выбранному статусу объектов.

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

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

«Строк на странице» – выберите количество записей, которые хотите видеть на одной странице (например, 20, 100, 500, 1000).

«Номера страниц» – переключение между страницами при большом количестве объектов.

«Кнопки «Вперёд»/«Назад» – для быстрого перехода к следующей или предыдущей странице.

Раздел «Детали объекта»#

При переходе на боковой панели навигации в раздел «Детали объекта» на странице отобразится расширенная информация об одном конкретном объекте интеграции, его связях с другими объектами (зависимостями), истории обработки и исходных данных.

Блок «Основная информация» включает ключевые атрибуты объекта:

ID объекта (GUID) – уникальный идентификатор;

ID сообщения – идентификатор, связанный с обменом данными из Kafka;

Тип – тип объекта (например, RSOKSPart);

Действие – тип операции над объектом (например, «Создание», «Обновление»);

Дата и время поступления в обработку – когда объект был зафиксирован системой;

Статус – текущее состояние (например, DELIVERED, PENDING и т. д.).

Блок «Зависимости» отображает перечень связанных зависимостей объекта. Каждая зависимость отображается в виде кликабельного элемента (ссылки), при нажатии на который можно перейти на страницу деталей соответствующего объекта. Кнопка «Проверить зависимости» открывает зависимости объекта.

Блок «История обработки объекта» отображает хронологический список действий и событий, связанных с обработкой данного объекта:

отметки времени;

описание выполняемых операций (например, «Планирование аудита…», «Получен статус объекта…»);

информацию об ошибках или результатах обработки.

Блок «Данные объекта» показывает исходные данные в формате XML, которые система получила для данного объекта. Исходные данные позволяют увидеть «сырые» сведения, передаваемые между системами, могут использоваться для диагностики и анализа ошибок.

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

«Назад» – возврат к предыдущему экрану (например, к списку объектов).

«Обновить страницу» – перезагрузка текущей страницы для получения актуальных данных.

«Удалить объект» – удаление текущего объекта (с подтверждающим модальным окном «да/нет»).

Раздел «Диаграмма зависимостей»#

При переходе на боковой панели навигации в раздел «Диаграмма зависимостей» на странице отобразятся связи (зависимости) между объектами в системе. На схеме каждый узел (блок) представляет отдельный объект, а стрелки или линии демонстрируют, как эти объекты связаны друг с другом.

Схема помогает:

понять общую структуру интеграции;

быстро обнаружить проблемные узлы (например, объекты в статусе «Error»);

перейти к деталям конкретного объекта для дальнейшего анализа.

Чтобы перейти на страницу графа соответствующего объекта, нажмите на любой узел (блок).

Легенда статусов отображает, какие цвета соответствуют конкретным статусам (Verified, Delivered, Pending/Processing, Error). Помогает быстро ориентироваться и различать объекты по состоянию.

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

Сообщения для пользователя#

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

Рекомендуется использовать в браузере режим разработчика (DevTools) для подробного ознакомления с ошибкой:

Нажмите клавишу F12 для активации режима разработчика.

Перейдите во вкладку Сеть (Network).

Повторите действия, при которых возникает проблема.

Нажмите на запрос, который подсвечивается красным цветом.

Ознакомьтесь с содержимым вкладок «Заголовки» (Headers) и «Предпросмотр» (Preview).

Ошибка	Описание ошибки	Действия для устранения
Авторизация ЕИС http://Стройкомплекс.РФ: Не активна	Не проходит проба авторизации в ЕИС http://Стройкомплекс.РФ	Проверить доступность ЕИС http://Стройкомплекс.РФ. Повторить попытку позже, если внешняя система недоступна
Redis недоступен	Не проходит проба Redis	Проверить доступность Redis
Kafka недоступен	Не проходит проба Kafka	Проверить доступность Kafka
Сервис валидации недоступен	Не проходит проба datalink-val	Проверить доступность datalink-val
Сервис интеграции недоступен	Не проходит проба datalink-int	Проверить доступность datalink-int
Есть ошибки обработки	Имеются объекты с ошибками обработки	Перейти в раздел Объекты, выбрать объект с ошибочным статусом и перейти в карточку объекта для идентификации ошибки
Очередь DLQ содержит объекты	Имеются объекты, которые не смогли быть обработаны автоматически и требуют ручной обработки	Перейти в раздел DLQ, выбрать объект и перейти в карточку объекта, идентифицировать проблему. Вернуть объект Поставщику данных с указанием комментария