1. Введение
1.1. Общие Сведения
Настоящий документ описывает правила и приёмы использования возможностей инфраструктуры электронного правительства (далее – ИЭП), которые позволяют участникам межведомственного взаимодействия (далее – УВ) решать задачи передачи сведений с использованием единого сервиса доступа к данным СМЭВ (Далее – СМЭВ4) между информационными системами участников взаимодействия (далее – ИС УВ).
Термины и сокращения, используемые в данном документе, представлены в соответствующем разделе.
1.1.1. Нормативно-правовые основания
Данный документ разработан в целях реализации и во исполнение:
Постановления Правительства Российской Федерации от 8 сентября 2010 года № 697 «О единой системе межведомственного электронного взаимодействия»;
Распоряжения Правительства Российской Федерации от 3 июня 2019 года №1189-р «Об утверждении Концепции создания и функционирования национальной системы управления данными и плана мероприятий («дорожную карту») по созданию национальной системы управления данными на 2019–2021 годы» (далее – Концепция);
Постановления Правительства Российской Федерации от 3 июня 2019 года № 710 «О проведении эксперимента по повышению качества и связанности данных, содержащихся в государственных информационных ресурсах»;
Федерального закона от 27 июля 2010 г. № 210-ФЗ «Об организации предоставления государственных и муниципальных услуг»;
мероприятий федерального проекта «Цифровое государственное управление» национальной программы «Цифровая экономика», утверждённой на заседании правительственной комиссии по цифровому развитию, использованию информационных технологий для улучшения качества жизни и условий ведения предпринимательской деятельности под председательством Председателя Правительства Российской Федерации Д. А. Медведева. 25 декабря 2018 года:
06.01.011.001.004 «Разработка функциональных и технических требований к информационным системам НСУД (включая требования к функциям получения, очистки и преобразования данных, хранения и обработки данных, визуального представления данных, управления метаданными, межведомственного взаимодействия);
06.01.011.001.006 Разработка, адаптация программного обеспечения и разработка архитектуры и проектных решений на НСУД и ее части, внедрение функционала НСУД, включая пусконаладочные работы, проведение предварительных испытаний, проведение опытной эксплуатации, доработку программного обеспечения, дополнительную наладку технических средств и проведение приемочных испытаний НСУД в соответствии с 06.01.011.001.005.
1.2. Виды информационного обмена с использованием СМЭВ
Виды информационного обмена, поддерживаемые СМЭВ4, приведены в Таблица 1.1.
№ |
Вид информационного обмена |
Характеристика |
|---|---|---|
1 |
Обмен с использованием SQL-запросов |
Обмен с использованием регламентированных запросов типа «SQL-запрос». Раздел 1.4.1 содержит описание данного вида обмена |
2 |
Обмен с использованием Рассылок |
Обмен данными с использованием регламентированных запросов типа «Рассылка» в соответствии с созданной подпиской. Раздел 1.4.2 содержит описание данного вида обмена |
3 |
Обмен с использованием запросов к REST-сервису ИС Ответчика |
Обмен с использованием регламентированных запросов типа «Rest-сервис» к зарегистрированным в СМЭВ4 REST-сервисам ИС Ответчика. Раздел 1.4.3 содержит описание данного вида обмена |
1.2.1. Классификация регламентированных SQL-запросов
Классификация Регламентированных SQL-запросов приведена в Таблица 1.2.
По количеству Витрин, в которых размещены данные, используемые в процессе выполнения запроса |
Простые запросы Запросы, которые обращаются к данным, размещённым в одной Витрине Поставщика данных |
Распределённые запросы Запросы, которые обращаются к связанным данным, размещённым в двух или более Витринах Поставщика данных |
|
По типу условий отбора и способу обработки данных |
Запросы по ключу Запросы, предполагающие отбор небольшого количества записей, относящихся к единичному объекту |
Аналитические запросы Запросы, предполагающие обработку значительного количества записей и предполагающие получение агрегатов, а не значений из отдельных атрибутов |
Выгрузки Запросы, обрабатывающие значительное количество записей, но не выполняющие вычисления, а возвращающие отобранные записи Потребителю данных |
По типу допустимой вариативности |
Фиксированные Запросы, не предусматривающие каких-либо возможностей для Потребителя данных уточнить запрос |
Параметризованные Запросы, содержащий в своём определении параметры, значения которых Потребитель данных задаёт непосредственно перед выполнением запроса |
|
По способу предполагаемого использования |
Универсальные Запросы, атрибутный состав которых не имеет разметки, предполагающей какое-то специальное использование этого запроса |
Многомерные Запросы, результат которого размечен так, что все возвращаемые атрибуты поделены на измерения и факты, таким образом многомерный запрос подходит для использования в средствах OLAP-анализа как источник данных |
|
Классификация Регламентированных SQL-запросов содержит 24 класса, представляющих собой различные комбинации классифицирующих признаков, приведённых в таблице.
Например:
универсальная простая фиксированная выгрузка;
многомерный распределённый аналитический фиксированный регламентированный запрос;
универсальный распределённый параметризованный запрос по ключу.
Значения классификаторов «универсальный», «простой» и «фиксированный» обычно не указываются и принимаются по умолчанию.
Например:
«универсальная изолированная фиксированная выгрузка» – это просто «выгрузка»;
«многомерный распределённый аналитический фиксированный регламентированный запрос» – это «многомерный распределённый аналитический регламентированный запрос».
1.3. Участники информационного обмена с использованием СМЭВ4
Участник взаимодействия - это орган или организация, участвующий в информационном обмене через СМЭВ4.
Рисунок - 1.1 иллюстрирует общую схему взаимодействия участников.
Рисунок - 1.1 Участники информационного обмена с использованием СМЭВ4
При участии в информационном обмене через СМЭВ4 УВ может одновременно выступать как в роли Поставщика и/или Ответчика, так и в роли Потребителя данных и/или Инициатора запроса в зависимости от используемого вида обмена.
В информационных обменах с использованием Витрин данных УВ может иметь роль Поставщика и Потребителя. Каждый УВ может выступать одновременно как в качестве Поставщика данных, предоставляя данные со своих Витрин, так и в качестве Потребителя данных, выполняя запросы к другим УВ.
Потребители данных имеют возможность получать сведения из Витрины Поставщиков данных следующими способами:
используя Регламентированный SQL-запрос (см. Раздел 1.4.1);
сформировав подписку на регламентированный запрос типа «Рассылка» и получая сведения в виде уведомлений об изменениях (см. Раздел 1.4.2).
Поставщики данных обеспечивают доступ к актуальным данным на Витринах:
размещают и актуализируют данные на Витринах;
осуществляют подключение Витрин к СМЭВ4;
В информационных обменах с использованием запросов к REST-сервису ИС Ответчика (без использования Витрин) УВ может иметь роль Инициатора и Ответчика. Каждый УВ может выступать одновременно как в качестве Ответчика, предоставляя данные c сервиса ИС, так и в качестве Инициатора запроса, выполняя запросы к другим УВ.
Инициаторы запроса имеют возможность получать сведения из ИС Ответчика, выполнив запрос к REST-сервису ИС Ответчика (см. Раздел 1.4.3).
Ответчики разворачивают REST-сервисы и предоставляют к нему доступ через СМЭВ4.
1.4. Информационный обмен участников взаимодействия с использованием СМЭВ4
Для осуществления информационного обмена с использованием СМЭВ4 должно быть обеспечено подключение ИС УВ к СМЭВ4 с помощью Агента СМЭВ4 в соответствии с «Руководством администратора Агента СМЭВ4» [1]
1.4.1. Обмен с использованием Регламентированных SQL-запросов
1.4.1.1. Общее описание информационного обмена
Обмен с использованием регламентированных SQL-запросов для получения сведений из Витрины Поставщика данных.
Также данный механизм обеспечивает:
разграничение доступа ИС Потребителей данных к регламентированным SQL-запросам путём использования принципа выдачи/изъятия прав через ЛК УВ;
(опционально) лимитирования запросов ИС Потребителей данных к регламентированным SQL-запросам / Витринам данных;
(опционально) задание в ЕИП НСУД последовательности выполнения подзапросов к Витрине данных при регистрации распределенных регламентированных SQL-запросов.
(опционально) сохранение данных запросов и ответов, переданных в процессе информационного обмена.
Классификация Регламентированных SQL-запросов приведена в Раздел 1.2.1.
1.4.1.2. Требования к участникам взаимодействия
1.4.1.2.1. Требования к Поставщикам данных
Поставщик данных для участия в информационном обмене с использованием Регламентированных SQL-запросов должен выполнить следующие требования.
№ |
Требования |
Инструкция [2] |
|---|---|---|
1 |
Зарегистрировать ИС в СМЭВ4 |
Инструкция приведена в документе «Регламент Правила и процедуры работы в СМЭВ 4» |
2 |
Развернуть и настроить в своем контуре Агент СМЭВ4 |
Инструкция приведена в «Руководство администратора Агента СМЭВ4» |
3 |
Обеспечить сетевую связанность Агента с СМЭВ4 |
|
4 |
Развернуть в своем контуре ПО Витрина данных |
Исходные коды и документация ПО Витрина данных размещены в НФАП |
5 |
Настроить ПО Витрина данных для взаимодействия с Агентом |
|
6 |
Загрузить модель данных Витрины в СМЭВ4 |
Инструкция приведена в «Инструкция по работе в ЕИП НСУД» |
7 |
Связать Витрину данных и ИС |
|
8 |
Зарегистрировать Регламентированные SQL-запросы в СМЭВ4 |
Инструкция приведена в «Инструкция по работе в ЕИП НСУД» |
9 |
Создать представление view (только для витрин версии 2.0.0 и выше) |
см. Раздел 1.5.4.3 |
10 |
Добавить критерии доступа к Регламентированному SQL-запросу (Согласовать право доступа) |
Инструкция приведена в «Руководство пользователя ЛК УВ» |
1.4.1.2.2. Требования к Потребителям данных
Потребитель данных для участия в информационном обмене с использованием Регламентированных SQL-запросов должен выполнить следующие требования.
№ |
Требования |
Инструкция [3] |
|---|---|---|
1 |
Зарегистрировать ИС в СМЭВ4 |
Инструкция приведена в документе «Регламент Правила и процедуры работы в СМЭВ 4» |
2 |
Развернуть и настроить в своем контуре Агент СМЭВ4 |
Инструкция приведена в «Руководство администратора Агента СМЭВ4» |
3 |
Обеспечить сетевую связанность Агента с СМЭВ4 |
|
4 |
Обеспечить свободный объем оперативной памяти на стороне Агента не менее размера передаваемых и получаемых данных |
|
5 |
Настроить ИС для выполнения запросов и обработки данных, получаемых от СМЭВ4 для взаимодействия с Агентом СМЭВ4 |
См. Раздел 2.3 |
6 |
Согласовать право доступа к Регламентированному SQL-запросу для своей ИС |
Инструкция приведена в «Руководство пользователя ЛК УВ» |
1.4.1.3. Взаимодействие участников обмена
Взаимодействие Ядра СМЭВ4 с Агентами СМЭВ4 осуществляется с использованием Протокола СМЭВ4.
Взаимодействие Агента Поставщика данных с Витриной Поставщика данных осуществляется с использованием зарезервированных топиков брокера сообщений Apache Kafka. Раздел 2.2.1 содержит перечень топиков Apache Kafka.
Взаимодействие ИС Потребителя с Агентом Потребителя осуществляется через REST или JDBC-интерфейс в соответствии со спецификацией Раздел 2.3.
Рисунок - 1.2 иллюстрирует общую схему взаимодействия участников обмена.
Рисунок - 1.2 Информационный обмен при выполнении Регламентированного SQL-запроса с использованием СМЭВ4
1.4.1.4. Информационный обмен с использованием SQL-РЗ
Рисунок - 1.3 содержит диаграмму последовательности осуществления информационного обмена с использованием Регламентированных SQL-запросов.
В контуре Потребителя данных (УВ 3 или 4 на схемах):
ИС Потребителя данных передаёт SQL-запрос Агенту СМЭВ4. Передача запроса может осуществляться с использованием:
JDBC-подключения;
REST-интерфейса.
Настройки подключения выполняются в рамках настройки ИС для взаимодействия с Агентом СМЭВ4 согласно «Руководству администратора Агента СМЭВ4»[4].
Раздел 2.3 содержит Спецификацию взаимодействия.
Агент Потребителя данных проверяет наличие включенного режима блокировки на отправку запросов (см. Раздел 3.5.3). Дальнейшие шаги выполняются в случае отсутствия блокировки.
Агент Потребителя подписывает запрос ЭП ОВ.
Агент Потребителя передает полученный запрос в Ядро СМЭВ4.
Ядро СМЭВ4 (после получения запроса от Агента Потребителя данных):
Выполняет проверку ЭП ОВ, которой подписан запрос, проверку запроса на корректность и наличие у Потребителя доступа на выполнение запросов к данным. Если хотя бы одна из проверок возвращает отрицательный результат, то прекращает выполнение запроса и возвращает Агенту Потребителя соответствующую ошибку в качестве результата запроса.
Выполняет преобразование полученной мнемоники Регламентированного SQL-запроса в SQL-выражение в соответствии с загруженным определением и формирует один или несколько запросов в адрес Витрин Поставщиков данных (далее – подзапросы).
Выполняет проверку соответствия ограничениям, заданным в Ядре СМЭВ4:
на интенсивность запросов от ИС Потребителя данных за интервал времени;
на общий объем данных в запросе и подзапросах за интервал времени.
В случае превышения установленных ограничений Ядро СМЭВ4 прекращает выполнение запроса или подзапроса и возвращает Агенту Потребителя сообщение о включении режима блокировки. Агент Потребителя при получении такого сообщения активирует режим блокировки и отвечает ошибкой на запросы от Потребителя к заблокированному ресурсу.
Передаёт каждый подзапрос в соответствующий Агент Поставщика.
В контуре Поставщика данных (УВ 1 и 2 на схемах):
Агент Поставщика данных получает запрос и проверяет ЭП ОВ, которой подписан запрос.
Дополнительно для простых исходных запросов Потребителя данных в рамках получения подзапроса от Ядра СМЭВ4 в Агент Поставщика передается исходный запрос с ЭП ОВ и сертификатом Потребителя данных, отправившего исходный запрос.
Если на стороне Агента Поставщика данных развернут и включен Сервис проверки полномочий:
Сервис проверки полномочий выполняет проверку подтверждения доступа на выполнение Регламентированного SQL-запроса для Потребителя данных, отправившего запрос.
Если для запроса не подтвержден доступ, то Агент Поставщика прекращает выполнение запроса и возвращает Агенту Потребителя соответствующую ошибку в качестве результата запроса. При подтвержденном доступе выполнение запроса продолжается.
В контуре Поставщика данных (УВ 1 и 2 на схемах):
Агент Поставщика данных помещает запрос в зарезервированный топик брокера сообщений Apache Kafka.
Витрина данных формирует результат выполнения подзапроса.
Агент Поставщика данных считывает результат выполнения подзапроса из зарезервированного топика брокера сообщений Apache Kafka.
Агент Поставщика подписывает результат ЭП ОВ.
Агент Поставщика формирует ответ и передает его в Ядро СМЭВ4.
Рисунок - 1.3 Диаграмма последовательности процесса выполнения SQL-запроса
Ядро СМЭВ4:
Осуществляет проверку ЭП ОВ УВ.
После получения результатов по всем подзапросам Ядро СМЭВ4 формирует результат для исходного запроса. Если хотя бы по одному была получена ошибка, Ядро СМЭВ4 прекращает выполнение запроса и возвращает Агенту Потребителя соответствующую ошибку в качестве результата запроса.
Отправляет результат Агенту Потребителя.
В контуре Потребителя данных (УВ 3 или 4 на схемах):
Агент Потребителя данных проверяет ЭП ОВ.
Агент Потребителя данных передает ИС с использованием JDBC-подключения или REST-интерфейса результат запроса.
1.4.2. Обмен с использованием Рассылок
1.4.2.1. Общее описание информационного обмена
СМЭВ4 и ПО «Витрина данных» позволяют организовать процесс автоматического:
информирования Потребителя данных об изменениях на Витрине Поставщика данных посредством передачи изменений (дельт);
размещения и актуализация данных из Витрины Поставщика данных в контуре Потребителя данных посредством передачи снапшота и дельт.
Такой обмен осуществляется по Подписке Потребителя данных на получение изменений данных с использованием регламентированного запроса типа «Рассылка» [5].
Подписка позволяет автоматически загружать изменения данных из Витрины Поставщика в Витрину Потребителя. Потребитель посылает запросы напрямую в свою Витрину, в результате чего сокращается продолжительность сеансов обмена.
Примечание
Информационный обмен по подписке при возникновении сбоев может быть приостановлен. Приостановка обмена означает прекращение запроса новых дельт у Поставщика и отправки их Потребителю. Приём уведомлений о наличии новых дельт от Поставщика в Ядре СМЭВ4 продолжается. Приостановка и возобновление обмена осуществляется СЦ.
Таблица 1.5 и Рисунок - 1.4 показывают виды подписок.
Вид |
Характеристика |
|
|---|---|---|
1 |
Простая |
Подписка на один простой Регламентированный запрос типа «Рассылка» |
2 |
Множественная |
Подписка на несколько простых Регламентированных запросов типа «Рассылка» к таблицам одной Витрины данных |
3 |
Распределённая |
Подписка на один распределённый Регламентированный запрос типа «Рассылка» |
Рисунок - 1.4 Виды подписок
Примечание
Множественная и распределённая подписки одновременно не работают на одной Витрине (Витрина 1 на Рисунок - 1.4 не может одновременно участвовать в подписках на схемах в центре и справа).
Для использования Регламентированного запроса типа «Рассылка» в подписке, он должен удовлетворять следующим требованиям:
Общие требования к Регламентированного запроса типа «Рассылка» для использования в подписке:
1.1. Не допустимо использование в SQL-запросе параметров (за исключением статического where).
1.2. Не допустимо использование в SQL-запросе set operation («union», «minus», «intersect» и т.п.), оконных функций, коррелирующих подзапросов, группирующих функций, сортировок, common table expression, semi-join.
1.3. Используемые в запросе функции, должны поддерживаться Витринами Поставщиков.
Дополнительные требования для нераспределённых подписок:
2.1. Количество источников данных в SQL-запросе должно быть равно одному.
Дополнительные требования для нераспределённых (множественных) подписок:
3.1. Количество источников данных в SQL-запросе должно быть равно одному.
3.2. Во всех SQL-запросах должна быть указана одна и та же Витрина (таблицы могут быть разными).
Дополнительные требования для распределённых подписок:
4.1. Количество источников данных должно быть равно двум (обработка большего количества в СМЭВ4 не поддерживается).
4.2. Объединение данных в SQL-запросе должно осуществляться с помощью inner join (обработка outer join в СМЭВ4 не поддерживается).
Раздел 1.5.5 содержит описание метаданных подписки.
Жизненный цикл подписки состоит из следующих этапов:
подготовительные мероприятия для регистрации подписки в соответствии с Раздел 1.4.2.2;
регистрация подписки в СМЭВ4 и Витринах Поставщиков и Потребителей в соответствии с Раздел 1.4.2.4.1;
осуществление информационного обмена по подписке в соответствии с Раздел 1.4.2.4.2, включающего в себя:
уведомление о наличии дельты от Поставщика;
передачу уведомления о наличии дельты Потребителю;
запрос у Поставщика дельты по инициативе Потребителя или СМЭВ4;
передача дельты Потребителю;
удаление подписки в СМЭВ4 и Витринах Поставщиков в соответствии с Раздел 1.4.2.4.3.
Информационный обмен по Рассылке сопровождается следующими ограничениями:
Подписка не обновляется. При необходимости изменений формируется новая подписка с новым идентификатором.
В Витрине Потребителе недопустима произвольная запись данных, кроме процесса получения новых дельт от Витрины Поставщика.
Механизма ограничения объема пакета отправляемых дельт не предусмотрено.
1.4.2.2. Требования к участникам взаимодействия
1.4.2.2.1. Требования к Поставщикам данных
Поставщик данных для участия в информационном обмене по Рассылке должен выполнить следующие требования.
№ |
Требование |
Инструкция [6] |
|---|---|---|
1 |
Зарегистрировать ИС в СМЭВ4 |
Инструкция приведена в документе «Регламент Правила и процедуры работы в СМЭВ 4» |
2 |
Развернуть и настроить в своем контуре Агент СМЭВ4 |
Инструкция приведена в «Руководство администратора Агента СМЭВ4» |
3 |
Обеспечить сетевую связанность Агента с СМЭВ4 |
|
4 |
Развернуть в своем контуре ПО Витрина данных |
Исходные коды и документация ПО Витрина данных размещены в НФАП |
5 |
Настроить ПО Витрина данных для взаимодействия с Агентом СМЭВ4 |
|
6 |
Загрузить модель данных Витрины в СМЭВ4 |
Инструкция приведена в «Инструкция по работе в ЕИП НСУД» |
7 |
Связать Витрину данных и ИС |
|
8 |
Зарегистрировать Регламентированный запрос типа «Рассылка», по которому будет выполняться подписка в СМЭВ4 |
Через ЛК УВ, в соответствии с «Руководство пользователя ЛК УВ» |
9 |
Добавить критерии доступа к Регламентированному запросу типа «Рассылка» |
|
10 |
Согласовать право доступа Потребителя к Регламентированному запросу типа «Рассылка», по которому будет выполняться Подписка |
Инструкция приведена в «Регламенте по подключению к СМЭВ4» |
11 |
Зарегистрировать Подписку в СМЭВ4 |
1.4.2.2.2. Требования к Потребителям данных
Потребитель данных для участия в информационном обмене по рассылке должен выполнить следующие требования.
№ |
Требование |
Инструкция [7] |
|---|---|---|
1 |
Зарегистрировать ИС в СМЭВ4 |
Инструкция приведена в документе «Регламент Правила и процедуры работы в СМЭВ 4» |
2 |
Развернуть и настроить в своем контуре Агент СМЭВ4 |
Инструкция приведена в «Руководство администратора Агента СМЭВ4» |
3 |
Обеспечить сетевую связанность Агента с СМЭВ4 |
|
4 |
Обеспечить свободный объем оперативной памяти на стороне Агента не менее размера передаваемых и получаемых данных |
|
5 |
Развернуть в своем контуре ПО Витрина данных для хранения данных по подписке |
Исходные коды и документация ПО Витрина данных размещены в НФАП |
6 |
Настроить ПО Витрина данных для взаимодействия с Агентом СМЭВ4 |
|
7 |
Загрузить модель данных Витрины в СМЭВ4 (модель-заглушка) |
Инструкция приведена в «Инструкция по работе в ЕИП НСУД» |
8 |
Связать Витрину данных и ИС |
|
9 |
Согласовать право доступа к Регламентированному запросу типа «Рассылка», по которому будет выполняться Подписка с Поставщиком данных |
Инструкция приведена в «Регламент Правила и процедуры работы в СМЭВ 4» |
1.4.2.3. Взаимодействия участников обмена
Взаимодействие Ядра СМЭВ4 с Агентами СМЭВ4 осуществляется с использованием Протокола СМЭВ4.
Взаимодействие Агента Поставщика данных с Витриной Поставщика данных осуществляется с использованием зарезервированных топиков брокера сообщений Apache Kafka. Раздел 2.2.1 содержит перечень топиков Apache Kafka.
Взаимодействие Агента Потребителя данных с Витриной Потребителя осуществляется с использованием зарезервированных топиков брокера сообщений Apache Kafka. Раздел 2.4.1 содержит перечень топиков Apache Kafka;
Рисунок - 1.5 иллюстрирует общую схему взаимодействия участников обмена.
Рисунок - 1.5 Информационный обмен с использованием Рассылок
1.4.2.4. Описание этапов
1.4.2.4.1. Регистрация подписки
Рисунок - 1.6 демонстрирует порядок регистрации подписки, соответствующее описание процесса приведено ниже.
Рисунок - 1.6 Диаграмма последовательности – Регистрация подписки
Запрос на регистрацию подписки передаётся в СМЭВ4 в соответствии с Раздел 1.5.5.
Ядро СМЭВ4:
Осуществляет следующие проверки:
проверка уникальности идентификатора подписки в запросе;
в случае множественной подписки, проверка Регламентированных запросов типа «Рассылка» на то, что они нераспределённые и источникам во всех запросах является одна Витрина;
проверка Регламентированного запроса типа «Рассылка» на его наличие в СМЭВ4;
проверка соответствия Регламентированного запроса типа «Рассылка» требованиям для использования в подписке (приведены в Раздел 1.4.2.1);
проверка соответствия Регламентированных запросов на использование допустимого для информационного обмена по подписке количество Поставщиков;
проверка наличия зарегистрированных в СМЭВ4 Витрин Поставщиков и Потребителя;
проверка наличия прав доступа ИС Потребителя к Регламентированному запросу типа «Рассылка», указанному в регистрируемой подписке;
проверка является ли действующей версия Регламентированного запроса типа «Рассылка».
в случае распределённой подписки, проверка на отсутствие значения в поле «cronExpression».
Отправляет ответ со статусом обработки запроса.
Определяет перечень подзапросов:
если подписка нераспределённая, то формируется один подзапрос на получение дельты (тип - DATA);
если подписка распределённая, формирует набор подзапросов:
подзапрос ключей Витрины Поставщика 1 (тип - KEYS);
подзапрос ключей Витрины Поставщика 2 (тип - KEYS);
подзапрос ключей Витрины Поставщика 1 с фильтрацией по ключам Витрины Поставщика 2 (тип - KEYS_FILTERED);
подзапрос ключей Витрины Поставщика 2 с фильтрацией по ключам Витрины Поставщика 1 (тип - KEYS_FILTERED);
подзапрос дельты Витрины Поставщика 1 с фильтрацией по ключам Витрины Поставщика 2 (тип - DATA_FILTERED);
подзапрос дельты Витрины Поставщика 2 с фильтрацией по ключам Витрины Поставщика 1 (тип - DATA_FILTERED);
подзапрос объединения частей дельт на Потребителе (тип - FINAL).
( 12 ) отправляет запрос на регистрацию подписки всем участвующим в подписке Поставщикам в соответствующие Агенты СМЭВ4.
Агент Поставщика данных:
( 13 ) осуществляет проверку ЭП Ядра СМЭВ4;
( 14 ) передает запрос на регистрацию подписки Витрине в топик
<префикс>.replication.rq.
Витрина Поставщика данных:
( 15 ) осуществляет проверку запроса на регистрацию подписки:
проверка уникальности идентификатора подписки;
проверка наличия витрины, указанной в подписке;
проверка наличия таблицы, указанной в подписке;
проверка корректности sql-запроса;
проверка соответствия полей sql-запроса таблице Витрины Поставщика;
проверка наличия атрибутов «primaryKey» и «shardingKey» в структуре итоговой таблицы.
( 16 ) регистрирует подписку (устанавливает статус подписки – активная (OPENED))
( 17 ) отправляет ответ в Агент Поставщика данных:
в случае успешной обработки запроса – структуру таблиц в топик
<префикс>.replication.rs.в случае неуспешной обработки запроса – уведомление об ошибке в топик
<префикс>.replication.err.
Агент Поставщика данных:
11 ( 18 ). Пересылает структуру таблиц в Ядро СМЭВ4.
Ядро СМЭВ4:
Пересылает структуру таблиц Агенту Потребителя данных.
Агент Потребителя данных:
Осуществляет проверку ЭП Ядра СМЭВ4;
Передает в Витрину данных структуру таблиц с использованием топика
<префикс>.replication.in.rq.
Витрина Потребителя данных:
Осуществляет проверку запроса на регистрацию подписки:
проверка уникальности идентификатора подписки;
проверка уникальности целевой таблицы подписки;
проверка корректности sql-запроса на объединение данных.
Регистрирует подписку (устанавливает статус подписки – активная (OPENED))
Отправляет ответ в Агент Потребителя данных:
в случае успешной обработки - уведомление об успешном создании структуры данных в топик
<префикс>.replication.in.rs.в случае неуспешной обработки - уведомление об ошибке в топик
<префикс>.replication.in.err.
Агент Потребителя данных:
Отправляет в Ядро СМЭВ4 статус обработки структуры таблиц Витриной данных.
Ядро СМЭВ4:
Регистрирует подписку.
1.4.2.4.2. Информационный обмен по Рассылке
Рисунок - 1.7 иллюстрирует порядок информационного обмена по рассылке, соответствующее описание процесса приведено ниже. Загрузка снапшота осуществляется аналогично последующей загрузке дельт.
Витрина Поставщика данных:
Передаёт в Агент Поставщика уведомление о наличии дельты в топик
<префикс>.delta.notification.
Агент Поставщика данных:
Передаёт уведомление в Ядро СМЭВ4.
Рисунок - 1.7 Диаграмма последовательности – Информационный обмен по рассылке
Ядро СМЭВ4:
по наличию расписания (cronExpression) определяет кто является инициатором запроса дельты – Ядро СМЭВ4 или Потребитель [8]. В случае распределённых подписок расписание не задаётся, инициатором запроса дельты всегда является Потребитель.
если расписание задано, осуществляет запрос дельты самостоятельно (переход к шагу 11). При этом если Потребитель еще не прислал ответ о результате применения предыдущего пакета дельт, новый не запрашивается.
если расписание не задано, осуществляет отправка уведомления Потребителю (переход к шагу 4).
отправляет уведомление о наличии дельты в Агент Потребителя и не запрашивает дельту пока не придёт команда от Потребителя.
Агент Потребителя данных:
передаёт уведомление о наличии дельты Витрине Потребителя в топик
<префикс>.delta.notification.in.
Витрина Потребителя данных:
обрабатывает уведомление о наличии новой дельты;
в случае распределённой подписки, определяет порядок обращения к Поставщикам;
посылает запрос на получение дельты в командный топик
<префикс>.command.podd.
Агент Потребителя данных:
передаёт запрос в Ядро СМЭВ4.
Ядро СМЭВ4:
обрабатывает запрос на получение дельты;
проверяет права доступа Потребителя данных
Если подписка нераспределённая:
Ядро СМЭВ4:
передаёт запрос дельты на Агент Поставщика.
Агент Поставщика данных:
передаёт запрос дельты Витрине Поставщика в топик
<префикс>.delta.rq.
Витрина данных Поставщика:
обрабатывает запрос дельты;
передаёт дельту в Агент Поставщика:
в случае успешной обработки запроса результат в топик
<префикс>.delta.rs.в случае неуспешной обработки запроса - уведомление об ошибке в топик
<префикс>.delta.err.
Агент Поставщика данных:
передаёт дельту в Ядро СМЭВ4.
Если подписка распределённая:
Ядро СМЭВ4:
передаёт запрос ключей (без фильтрации) в Агент Поставщика 1
Агент Поставщика данных 1:
передаёт запрос ключей (без фильтрации) Витрине Поставщика в топик
<префикс>.delta.rq.
Витрина Поставщика данных 1:
обрабатывает запрос;
передаёт дельту в Агент Поставщика 1:
в случае успешной обработки запроса результат в топик
<префикс>.delta.rs.в случае неуспешной обработки запроса - уведомление об ошибке в топик
<префикс>.delta.err.
Агент Поставщика данных 1:
передаёт ключи в Ядро СМЭВ4.
Ядро СМЭВ4:
передаёт запрос ключей (с фильтрацией по ключам Витрины 1) в Агент Поставщика 2.
Агент Поставщика данных 2:
передаёт запрос ключей (с фильтрацией по ключам Витрины 1) Витрине Поставщика 2 в топик
<префикс>.delta.tp.
Витрина Поставщика данных 2:
обрабатывает запрос;
передаёт пересечение ключей в Агент Поставщика 2:
в случае успешной обработки запроса результат в топик
<префикс>.delta.rs.в случае неуспешной обработки запроса - уведомление об ошибке в топик
<префикс>.delta.err.
Агент Поставщика данных 2:
передаёт пересечение ключей в Ядро СМЭВ4.
Ядро СМЭВ4:
( 33 ) передаёт запрос дельты (с фильтрацией по ключам) в Агент Поставщика 1 (2).
Агент Поставщика данных 1 (2):
( 34 ) передаёт запрос дельты (с фильтрацией по ключам) в Витрине Поставщика 1 (2).
Витрина Поставщика данных 1 (2):
( 35 ) обрабатывает запрос;
( 36 ) передаёт дельту в Агент Поставщика 1 (2).
Агент Поставщика данных 1 (2):
( 37 ) осуществляет простановку ЭП Поставщика 1 (2)
( 38 ) передаёт пересечение ключей в Ядро СМЭВ4.
Ядро СМЭВ4:
передаёт дельту в Агент Потребителя
Агент Потребителя данных
( 44 ) проверяет ЭП Поставщика;
( 45 ) передаёт дельту в Витрину Потребителя.
Витрина данных Потребителя:
( 46 ) обрабатывает полученную дельту;
43 ( 47 ). применяет дельту;
( 50 ) передаёт статус применения дельты.
Агент Потребителя данных
( 51 ) передаёт статус применения дельты в Ядро СМЭВ4.
1.4.2.4.3. Удаление подписки
Рисунок - 1.8 иллюстрирует порядок отмены подписки, соответствующее описание процесса приведено ниже.
Рисунок - 1.8 Диаграмма последовательности – Удаление подписки
Запрос на удаление подписки передаётся в СМЭВ4 в соответствии c Раздел 1.5.5.
Ядро СМЭВ4:
осуществляет проверку запроса на отмену подписки на наличие в СМЭВ4 подписки с указанным идентификатором;
отправляет ответ со статусом обработки запроса;
( 11 ) отправляет запрос на отмену подписки всем участвующим в подписке Поставщикам в соответствующие Агенты.
Агент Поставщика данных:
( 12 ) осуществляет проверку ЭП Ядра СМЭВ4;
( 13 ) отправляет запрос Витрине Поставщика в топик
<префикс>.replication.cancel.rq.
Витрина Поставщика данных:
( 14 ) осуществляет проверку запроса на отмену подписки;
( 15 ) отменяет подписку (устанавливает статус подписки – отменённая (CANCELED));
( 16 ) отправляет ответ в Агент Поставщика данных в топик
<префикс>.replication.cancel.rs.
Агент Поставщика данных:
( 17 ) отправляет в Ядро СМЭВ4 статус обработки запроса на отмену подписки.
Ядро СМЭВ4:
удаляет подписку после получения ответа от всех Поставщиков вне зависимости от статуса этих ответов (успех/ошибка). При этом статус Поставщика временно (до удаления) в случае успеха меняется на CANCELLED, а в случае ошибки – ERROR.
1.4.3. Обмен с использованием запросов к REST-сервису ИС Ответчика
1.4.3.1. Общее описание информационного обмена
Обмен с использованием запросов к REST-сервису ИС Ответчика предназначен для сквозного («прозрачного») доступа ИС Инициаторов к REST-сервисам ИС Ответчиков. СМЭВ4 используется в качестве канала передачи данных.
Также данный механизм обеспечивает:
регистрацию REST-сервисов ИС Ответчиков, описываемых спецификацией OpenAPI, в СМЭВ4 через ЛК УВ;
разграничение доступа Инициаторов к REST-сервисам ИС Ответчиков путём использования принципа выдачи/изъятия прав на взаимодействие ИС Потребителя с REST-сервисом ИС Ответчика через ЛК УВ;
форматно-логический контроль запросов ИС Инициаторов и ответов ИС Ответчиков на соответствие спецификации OpenAPI зарегистрированного в СМЭВ4 REST-сервиса;
(опционально) возможность передачи мнемоники Инициатора в REST-сервисы ИС Ответчиков, при использовании заголовка X-PODD-CLIENT-SYSTEM-MNEMONIC;
(опционально) лимитирование запросов к REST-сервисам ИС Ответчика;
(опционально) сохранение данных запросов и ответов, переданных в процессе информационного обмена.
1.4.3.2. Требования к участникам взаимодействия
1.4.3.2.1. Требования к Ответчикам
Ответчик для участия в информационном обмене с использованием запросов к REST-сервису ИС Ответчика должен выполнить следующие требования.
№ |
Требование |
Инструкция [9] |
|---|---|---|
1 |
Зарегистрировать ИС в СМЭВ4 |
Инструкция приведена в документе «Регламент Правила и процедуры работы в СМЭВ 4» |
2 |
Развернуть и настроить в своем контуре Агент СМЭВ4 |
Инструкция приведена в «Руководство администратора Агента СМЭВ4» |
3 |
Обеспечить сетевую связанность Агента с СМЭВ4 |
|
4 |
Развернуть в своем контуре REST-сервис ИС Ответчика |
|
5 |
Настроить REST-сервис ИС Ответчика, который обрабатывает получаемые от СМЭВ4 запросы, для взаимодействия с Агентом СМЭВ4 |
В соответствии с Раздел 2.5 |
6 |
Зарегистрировать REST-сервис ИС Ответчика (Регламентированный запрос типа «REST-сервис») в СМЭВ4 |
Инструкция приведена в «Руководство пользователя ЛК УВ» |
7 |
Добавить критерии доступа для запросов к развернутому REST-сервису |
1.4.3.2.2. Требования к Инициаторам запросов
Инициатор для участия в информационном обмене с использованием запросов к REST-сервису ИС Ответчика должен выполнить следующие требования.
№ |
Требование |
Инструкция [10] |
|---|---|---|
1 |
Зарегистрировать ИС в СМЭВ4 |
Инструкция приведена в документе «Регламент Правила и процедуры работы в СМЭВ 4» |
2 |
Развернуть и настроить в своем контуре Агент СМЭВ4 |
Инструкция приведена в «Руководство администратора Агента СМЭВ4» |
3 |
Обеспечить сетевую связанность Агента с СМЭВ4 |
|
4 |
Настроить ИС, которая выполняет запросы и осуществляет обработку данных, получаемых от СМЭВ4, для взаимодействия с Агентом СМЭВ4 |
В соответствии с Раздел 2.5 |
5 |
Получить право доступа на выполнение запросов к REST-сервису Ответчика (Регламентированному запросу типа «REST-сервис») |
Инструкция приведена в «Руководство пользователя ЛК УВ» |
1.4.3.3. Взаимодействие участников обмена
Механизм обмена с использованием запросов к REST-сервису ИС Ответчика реализован в виде комплекса взаимодействующих программных средств и артефактов, приведенных на Рисунок - 1.9.
Взаимодействие Ядра СМЭВ4 с Агентами СМЭВ4 осуществляется по Протоколу СМЭВ4.
Взаимодействие Агента Инициатора с ИС Инициатора осуществляется с использованием REST-интерфейса в соответствии с Раздел 2.3.1.3.
Взаимодействие Агента Ответчика с ИС Ответчика осуществляется в соответствии со спецификацией OpenAPI, загруженной в СМЭВ4 (см. Раздел 2.5).
Рисунок - 1.9 Информационный обмен с использованием запросов к REST-сервису ИС Ответчика через СМЭВ4
1.4.3.4. Описание этапов
1.4.3.4.1. Регистрация в СМЭВ4 REST-сервиса ИС Ответчика
Подготовка УВ к использованию механизма запросов к REST-сервисам ИС Ответчика описана в Раздел 1.4.3.2 настоящего документа.
Примечание
основные положения по подготовке спецификаций OpenAPI для использования в СМЭВ4 приведены в Раздел 1.5.6 настоящего документа.
1.4.3.4.2. Информационный обмен с использованием REST-РЗ
Взаимодействие ИС Инициатора и ИС Ответчика при выполнении запроса к REST-сервису ИС Ответчика (Рисунок - 1.10):
Агент Инициатора:
Получает запрос к REST-сервису ИС Ответчика.
Проверяет наличие активной блокировки на отправку запросов.
В случае отсутствия блокировки делит запрос на чанк метаданных и чанки тела запроса.
Подписывает чанк метаданных ЭП Инициатора.
Передает чанк метаданных в Ядро СМЭВ4.
Ядро СМЭВ4:
Осуществляет проверку ЭП Инициатора для чанка метаданных.
Осуществляет поиск спецификации OpenAPI REST-сервиса ИС Ответчика.
Проверяет наличие у Инициатора прав доступа для обращения к REST-сервису Ответчика.
Опционально, если в спецификации параметр X-PODD-CLIENT-SYSTEM-MNEMONIC обязательный, то последовательно проверяет:
наличие заголовка X-PODD-CLIENT-SYSTEM-MNEMONIC
значение в заголовке X-PODD-CLIENT-SYSTEM-MNEMONIC и сравнивает его с мнемоникой ИС Потребителя
Выполняет валидацию на соответствие спецификации по чанку метаданных запроса:
валидация осуществляется по параметрам, заголовкам (в т.ч. обязательность наличия) и path
тело запроса не валидируется
Выполняет проверку соответствия ограничениям, заданным на REST-сервис ИС Ответчика:
на количество запросов от ИС Инициатора за интервал времени;
на объем данных, передаваемых ИС Потребителя по всем запросам за интервал времени.
Осуществляет маршрутизацию запроса.
Подписывает ЭП Ядра СМЭВ4 чанк метаданных запроса.
Передает в Агент Ответчика чанк метаданных или возвращает ошибку обработки запроса (при ее возникновении).
Получает подтверждение приема чанка метаданных от Агента Ответчика.
Опционально, если для спецификации установлен признак сохранять данные запроса и ответа. Сохраняет чанк метаданных запроса в хранилище Ядра СМЭВ4.
Передает подтверждение корректности запроса Агенту Инициатора.
Агент Инициатора:
Подписывает ЭП Инициатора чанки тела.
Передает последовательно чанки тела запроса в Ядро СМЭВ4 с сохранением исходного порядка.
Ядро СМЭВ4:
Проверяет ЭП Инициатора каждого чанка тела запроса.
Выполняет проверку соответствия ограничениям, заданным на REST-сервис ИС Ответчика:
на количество запросов от ИС Инициатора за интервал времени;
на объем данных, передаваемых ИС Потребителя по всем запросам за интервал времени.
Подписывает ЭП Ядра СМЭВ4 чанки тела запроса.
Последовательно передает чанки тела запроса в Агент Ответчика по протоколу RSocket.
Получает подтверждение приема чанков тела запроса от Агента Ответчика (через Брокер).
Опционально, если для спецификации установлен признак сохранять данные запроса и ответа. Сохраняет чанк тела запроса в хранилище Ядра СМЭВ4.
Агент Ответчика:
Проверяет ЭП Ядра.
Проверяет ЭП Инициатора.
Если на стороне Агента Ответчика развернут и включен Сервис проверки полномочий:
Сервис проверки полномочий выполняет проверку подтверждения доступа на выполнение запроса к REST-сервису ИС Ответчика для Инициатора, отправившего запрос.
Если для запроса не подтвержден доступ, то Агент Поставщика прекращает выполнение запроса и возвращает Агенту Потребителя соответствующую ошибку в качестве результата запроса с использованием Протокола СМЭВ4. При подтвержденном доступе выполнение запроса продолжается.
Формирует абсолютный URL-адрес запроса к соответствующему методу REST-сервиса ИС Ответчика.
Отправляет запрос данных согласно URL-адресу.
Рисунок - 1.10 Диаграмма прохождения запроса к REST-сервису ИС Ответчика через СМЭВ4
Взаимодействие ИС Инициатора и ИС Ответчика при ответе на запрос к REST-сервису ИС Ответчика (Рисунок - 1.11):
Агент Ответчика:
Получает ответ на запрос от ИС Ответчика.
Делит ответ на запрос на чанк метаданных и чанки тела.
Подписывает чанк метаданных ЭП Ответчика.
Передает чанк метаданных в Ядро СМЭВ4.
Ядро СМЭВ4:
Проверяет ЭП Ответчика чанка метаданных.
Выполняет проверку соответствия ограничениям, заданным на REST-сервис ИС Ответчика, на объем данных, возвращаемых ИС Инициатора по всем запросам за интервал времени.
Маршрутизирует ответ на запрос.
( 21 ) Отправляет чанк метаданных в Агент Инициатора или возвращает ошибку обработки запроса Агенту Ответчика(при ее возникновении).
Получает подтверждение приема чанка метаданных от Агента Инициатора.
Опционально, если для спецификации установлен признак сохранять данные запроса и ответа. Сохраняет чанк метаданных ответа в хранилище Ядра СМЭВ4.
Передает подтверждение корректности ответа на запрос в Агент Ответчика.
Агент Ответчика:
Подписывает ЭП Ответчика чанки тела.
Отправляет последовательно чанки тела в Ядро СМЭВ4.
Ядро СМЭВ4:
Проверяет ЭП Ответчика чанков тела.
Последовательно передает чанки тела в Агент Инициатора (через Брокер) по протоколу RSocket.
Получает подтверждение приема чанков тела от Агента Инициатора (через Брокер).
Опционально, если для спецификации установлен признак сохранять данные запроса и ответа. Сохраняет чанк тела ответа в хранилище Ядра СМЭВ4.
Агент Инициатора:
Выполняет проверку ЭП Ответчика.
Извлекает из ответа на запрос HTTP код и тело (если присутствует).
Отправляет ответ ИС Инициатора.
Рисунок - 1.11 Диаграмма прохождения ответа на запрос к REST-сервису ИС Ответчика через СМЭВ4
1.5. Метаданные СМЭВ4
Метаданные СМЭВ4 содержат информацию о следующих объектах:
модели данных Витрин Поставщиков данных;
определения Регламентированных SQL-запросов;
подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка»;
REST-сервисы ИС Ответчиков, описываемые спецификацией OpenAPI;
права доступа Потребителей данных.
1.5.1. Поддерживаемые форматы
Таблица 1.10 содержит ограничения на формат значений в загружаемых метаданных и сведения о проверках на стороне СМЭВ4.
№ |
Наименование |
Тип |
Требования к формату |
|---|---|---|---|
1 |
Идентификатор |
uuid |
Маска: |
2 |
Мнемоника (Витрины/ Регламентированного запроса типа «SQL-запрос» / Регламентированного запроса типа «Рассылка» /атрибута/параметра) |
String |
Латинские буквы, цифры и символ «_», без пробелов. Первым символом должна быть буква. Регистр не учитывается |
3 |
Мнемоника (Витрины/ Регламентированного запроса типа «SQL-запрос» / Регламентированного запроса типа «Рассылка») |
String |
Запрещено использование зарезервированных ключевых слов SQL [11] |
4 |
Мнемоника (Регламентированного запроса типа «SQL-запрос» /Регламентированного запроса типа «Рассылка») |
String |
Запрещено использование префикса |
5 |
Алиас атрибута в SQL запросе |
String |
Латинские буквы, цифры и символ «_», без пробелов. Первым символом должна быть буква. Регистр не учитывается |
6 |
Версия (Витрины/ Регламентированного запроса типа «SQL-запрос»/ Регламентированного запроса типа «Рассылка») |
String |
Должна соответствовать формату <major>.< minor >:
|
7 |
ОГРН УВ (владельца Витрины/ Регламентированного запроса типа «SQL-запрос» / Регламентированного запроса тип «Рассылка») |
String |
ОГРН владельца Витрины должен соответствовать значению в ранее зарегистрированных версиях Витрины Ожидаемый формат: только цифры |
8 |
Даты поддержки (Витрины/ Регламентированного запроса типа «SQL-запрос» / Регламентированного запроса тип «Рассылка») |
Integer (int64) |
В миллисекундах от эпохи. Временной диапазон периода поддержки Регламентированного запроса типа «SQL-запрос» и Регламентированного запроса тип «Рассылка» должен входить в диапазоны поддержки всех Витрин, которые указаны в SQL данных Регламентированного запроса типа «SQL-запрос» и Регламентированного запроса тип «Рассылка» |
9 |
Текстовое описание (Витрины/ Регламентированного запроса типа «SQL-запрос» / Регламентированного запроса тип «Рассылка») |
String |
Ожидаемый формат: латинские и русские буквы, цифры, печатные символы и символы разметки (пробел, перенос строки), максимум 2000 знаков |
10 |
Текст SQL-выражения (для Регламентированного запроса типа «SQL-запрос» / Регламентированного запроса тип «Рассылка») |
String |
Поддерживаются возможности, указанные в Раздел 3.1 данного документа |
11 |
Тип атрибута |
String |
|
12 |
Тип параметра |
String |
|
13 |
Префикс в URL для REST-сервиса ИС Ответчика (basepath) |
String |
Латинские буквы, цифры, символы. Из зарезервированных символов допустимы „/“ и „_“
|
14 |
Спецификации OpenAPI для REST-сервиса ИС Ответчика |
Поддерживаемые форматы: JSON, YAML. Максимальный размер 1 Мб |
1.5.2. Модель данных Витрины Поставщика данных
Все передаваемые, получаемые и распространяемые посредством СМЭВ4 сведения должны соответствовать моделям данных Витрины Поставщика данных в Ядре СМЭВ4.
Модели данных загружаются в Ядро СМЭВ4 из ФГИС «ЕИП НСУД» в соответствии с инструкцией по работе с ФГИС «ЕИП НСУД»[12].
Модель данных Витрины Поставщика данных содержит:
уникальную мнемонику Витрины;
ОГРН владельца Витрины;
версии Витрины, содержащие структуру сущностей.
Каждая версия Витрины содержит:
номер версии Витрины;
описание для версии Витрины;
срок действия версии Витрины Поставщика данных (дата начала и дата окончания действия версии Витрины);
перечень таблиц версии Витрины со следующей информацией:
мнемоника и описание таблицы;
перечень атрибутов таблицы с указанием типа данных;
первичный ключ, состоящий из мнемоник атрибутов таблицы;
массив уникальных ключей, состоящий из мнемоник атрибутов таблицы.
Правила/ограничения использования:
Модель данных Витрины Поставщика данных загружена в Ядро СМЭВ4, если загружена как минимум одна (первая) версия Витрины.
Значение ОГРН владельца должно быть одинаковым для всех версий Витрины. При несоответствии ОГРН значениям в ранее зарегистрированных версиях Витрины СМЭВ4 вернет ошибку регистрации.
Актуальной версией Витрины считается максимальная по номеру среди действующих.
Если в новой версии Витрины требуется расширить перечень доступных данных, при этом Потребители, уже имеющие полный доступ к Витрине, не должны автоматически получить доступ к новой версии, то изменение следует выполнить через регистрацию новой Витрины (с новой мнемоникой), а не через выпуск новой ее версии.
Для выполнения запроса к определенной версии Витрины необходимо в запросе после мнемоники витрины явно указать номер версии. Пример приведен в
specifying_versionнастоящего документа.
1.5.3. Профиль Витрины Поставщика данных
Способ передачи и поддержка системных параметров при выполнении подзапросов к Витрине определяются в Профиле витрины, информация о которых размещается в метахранилище Ядра СМЭВ4.
Профиль витрины содержит следующие настройки:
subQueryParamSupport – способ передачи подзапроса при выполнении РЗ с параметрами на стороне Витрины, возможные значения:
NOT_SUPPORTED: отправка подзапроса с параметрами, подставленными в SQL-выражение (значение по-умолчанию);
DYNAMIC_PARAM_SUPPORT: отправка подзапроса с блоком динамических параметров, подстановка осуществляется на стороне Адаптера Витрины;
NAMED_PARAM_SUPPORT: отправка подзапроса с блоком именованных параметров, подстановка осуществляется на стороне Адаптера Витрины.
forSystemTimeParameterSupport – поддержка системного параметра РЗ для запроса актуальных, на заданный момент времени, данных из Витрины:
false: Адаптер Витрины не поддерживает обработку параметра;
true: Адаптер Витрины поддерживает обработку параметра (значение по-умолчанию).
Изменения в настройки Профиля витрины могут вносить специалисты службы эксплуатации СМЭВ4 по запросу от участника взаимодействия.
1.5.4. Определения Регламентированных SQL-запросов
Регистрация Регламентированного SQL-запроса в СМЭВ4 осуществляется с использованием ЕИП НСУД в соответствии с инструкцией по работе с ФГИС «ЕИП НСУД» [13].
Состав атрибутов определения Регламентированного SQL-запроса:
мнемоника Регламентированного SQL-запроса;
версии Регламентированного SQL-запроса.
1.5.4.1. Содержание Регламентированного SQL-запроса
Каждая версия Регламентированного SQL-запроса содержит:
описание Регламентированного SQL-запроса (краткое и полное);
ОГРН владельца Регламентированного SQL-запроса;
номер версии Регламентированного SQL-запроса;
срок действия Регламентированного SQL-запроса (дата начала и дата окончания действия, в рамках которых возможно выполнение соответствующего запроса);
SQL-выражение в соответствии с Раздел 3.1 данного документа и указанными ниже ограничениями;
последовательность выполнения подзапросов к витринам поставщиков (только для распределенных запросов);
Признак необходимости сохранять данные запросов и ответов (по умолчанию false). Примечание: может быть изменено по запросу в службу эксплуатации СМЭВ4.»
(при наличии) список параметров. Описание параметра включает в себя:
имя параметра;
тип параметра;
описание параметра;
значение по умолчанию.
(при наличии) список табличных параметров. Описание параметров включает в себя:
имя табличного параметра;
описание колонок табличного параметра:
имя колонки
тип колонки;
описание колонки.
1.5.4.2. Правила/ограничения использования
Версия Регламентированного SQL-запроса не подлежит модификации. При необходимости изменить SQL-выражение создается запрос с новой версией.
ОГРН Владельца и мнемоника Регламентированного SQL-запроса задаются для каждой версии отдельно, поэтому контроль их соответствия у версий ложится на создателей этих версий.
Актуальной версией Регламентированного SQL-запроса считается максимальная по номеру среди действующих.
Если в новой версии Регламентированного SQL-запроса требуется изменить входные или выходные данные, при этом Потребители, уже имеющие доступ к Регламентированному SQL-запросу, не должны автоматически получить доступ к новой версии, то изменение следует выполнить через регистрацию нового Регламентированного SQL-запроса (с новой мнемоникой), а не через выпуск новой его версии.
Временной диапазон срока действия Регламентированного SQL-запроса должен входить в диапазоны поддержки всех Витрин, которые указаны в SQL-выражении данного Регламентированного SQL-запроса.
Параметры Регламентированного SQL-запроса должны соответствовать условиям:
табличные и именованные параметры в SQL-выражении должны соответствовать параметрам в списке;
мнемоники параметров должны быть уникальными в рамках Регламентированного SQL-запроса, уникальность именованных и табличных параметров сквозная;
мнемоника параметра не должна начинаться с
settings_(префикс системного именованного параметра);при задании параметров в SQL-выражении через «?» порядок параметров в списке должен соответствовать порядку их представления в SQL-выражении;
при задании параметров в SQL-выражении через «?» количество параметров в SQL-выражении должно соответствовать количеству параметров в списке;
SQL-выражение для Регламентированного SQL-запроса должно соответствовать условиям:
Витрины, имена возвращаемых атрибутов, таблицы и схема данных должны соответствовать метаданным Витрины, сохраненным в Ядре СМЭВ4;
должна быть указана конкретная версия Витрины (правильно – dtm.1.0.table; неправильно – dtm.table);
указанная версия Витрины должна быть зарегистрирована в СМЭВ4;
не должно быть указано несколько версий одной Витрины;
простой запрос должен быть к одной Витрине;
для простого запроса Витрина в SQL-выражении должна соответствовать Витрине, указанной в полной мнемонике Регламентированного SQL-запроса;
распределенный запрос должен быть к двум или более Витринам;
не должно быть обращений к другим Регламентированного SQL-запроса;
в SQL-выражении должны быть указаны конкретные возвращаемые атрибуты (возврат всех атрибутов через * запрещен). При использовании табличных параметров необходимо явно перечислять поля таблиц, по которым будет выполняться фильтрация записей или объединение таблиц. Исключение: возможно использовать * внутри операторов (пример: count ( * ));
возвращаемые Потребителю атрибуты должны быть уникальны с учетом подставленных алисов.
Возможность указания дополнительных условий фильтрации и операций над получаемыми данными (order by, limit, where и т.д.) при вызове регламентированного SQL-запроса ограничена. При наличии потребности использовать такие надстройки рекомендуется обратиться к поставщику данных для добавления их в SQL-выражение.
Если Регламентированный SQL-запрос планируется использовать в качестве Регламентированного запроса типа «Рассылка», то он должен соответствовать требованиям приведённым в Раздел 1.4.2.1.
Если необходимо получение результата выполнения Регламентированного SQL-запроса в реальном времени (запросы граждан на портале ЕПГУ, предоставление услуг в МФЦ и т.п.), то обязательно указание лимита (limit) с минимально возможным значением (максимально допустимое значение зависит от конфигурации и настроек Витрины Поставщика, по умолчанию равно 1000).
1.5.4.3. Правило создания представлений
Примечание
Данное правило распространется только для витрины версии 2.0.0 и выше
Для каждой таблицы, указанной в основном SQL-выражении, вызываемого SQL-РЗ должны быть предварительно созданы представления view.
Запрос на создание view строиться следующим образом:
CREATE VIEW- команда созданияview;Наименование представления. Формируется по следующему принципу:
v<мажорный номер версии SQL-РЗ>_<наименование таблицы>SELECT * FROM <наименование таблицы>. Запрос, который определяет, какие данные будут отображаться в представлении.
Пример запроса на создание view:
CREATE VIEW v1_tbl1 AS SELECT * FROM tbl1
1.5.5. Подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка»
Подписка предоставляет возможность Потребителю данных оперативно получать изменяющиеся в Витринах Поставщиков данные.
Таблица 1.11 содержит Метаданные подписки.
№ |
Атрибут |
Описание |
|---|---|---|
1 |
subscriptionId |
Уникальный идентификатор подписки. Генерируется СМЭВ4 в соответствии с форматом UUID. |
2 |
RQs |
Массив регламентированных запросов типа «Рассылка». При указании нескольких запросов используется множественная подписка. Использование распределённых запросов в таком случае не допустимо. |
2.1 |
queryMnemonic |
Полная мнемоника Регламентированного запроса: <мнемоника витрины>.<мнемоника РЗ> Для распределенного запроса: podd.<мнемоника РЗ> |
2.2 |
version |
Номер версии Регламентированного запроса в формате: <major>.<minor> |
3 |
datamartMnemonic |
Мнемоника Витрины Потребителя (без учёта версионности) |
4 |
name |
Наименование подписки (для краткой формулировки) Опционально |
5 |
description |
Описание подписки (для подробного описания) Опционально |
6 |
isSnapshot |
Признак того, что сначала Потребителю нужно выгрузить снапшот. Значение по умолчанию - Опционально |
7 |
initiator |
Признак того, кто является инициатором запроса новой дельты:
Значение по умолчанию - PODD Опционально |
8 |
schedule |
Расписание запроса Ядром СМЭВ4 дельт у Витрины Поставщика. Представляет собой cron-выражение. Для подписок, в которых инициатором является Потребитель, значение атрибута всегда отсутствует. Опционально |
9 |
status |
Статус подписки, формируется СМЭВ4 по ходу регистрации и удаления подписки:
|
Функционирование Агента СМЭВ4 и Ядра СМЭВ4 при формировании первоначальной выгрузки и передачи изменений по подписке от Витрины Поставщика данных в Витрину Потребителя данных приведено в Раздел 1.4.3.1 и Раздел 2.4 данного документа.
Регистрация подписки осуществляется через:
ЛК УВ;
ЕИП в случае тиражирования подписок (создание копии подписки, в которой изменяется только идентификатор и витрина потребителя).
СЭ в случае необходимости ручного вмешательства.
Удаление подписки осуществляется через:
ЛК УВ;
СЭ в случае необходимости ручного вмешательства.
1.5.6. REST-сервисы ИС Ответчиков
Регистрация REST-сервиса ИС Ответчика (Регламентированного запроса типа REST-сервис) в СМЭВ4 осуществляется с использованием ЛК УВ в соответствии с инструкцией в «Руководстве пользователя ЛК УВ» [14].
REST-сервис ИС Ответчика в СМЭВ4 определяется следующими атрибутами:
Мнемоника ИС Ответчика.
Префикс в URL методов API (basepath)
Наименование спецификации.
Спецификация OpenAPI, описывающая REST-сервис ИС Ответчика.
Признак необходимости сквозной передачи подписи Инициатора Ответчику (по умолчанию true).
Признак необходимости сохранять данные запросов и ответов (по умолчанию false). Примечание: может быть изменено по запросу в службу эксплуатации СМЭВ4.
Правила разработки спецификаций OpenAPI, используемых для описания и регистрации REST-сервисов Ответчиков в СМЭВ4: [15]
Следует руководствоваться форматом проектирования спецификаций OpenAPI версии 3.0 (в том числе минорных версий 3.0.1, 3.0.2 и т.д.).
В спецификациях OpenAPI могут быть использованы все типы HTTP-методов (POST, GET, PUT и DELETE), выполняющих CRUD-операции (Create/Read/Update/Delete).
Допустимые форматы: YAML или JSON.
Максимальный размер: 1 Мб.
Если требуется передача мнемоники Инициатора до Ответчика, то в Спецификации OpenAPI REST-сервиса Ответчика должен присутствовать заголовок X-PODD-CLIENT-SYSTEM-MNEMONIC. При его наличии в СМЭВ4 осуществляется проверка соответствия мнемоники ИС, с которой пришёл запрос, и мнемоники ИС, указанной в заголовке.
Примеры спецификаций OpenAPI, используемых в работе с REST-сервисами в СМЭВ4:
Спецификация OpenAPI, описывающая REST-сервис с функцией возврата запрошенных данных от ИС Ответчика
{
"openapi": "3.0.1",
"info": {
"title": "Letters content | Содержимое писем",
"version": "1.0"
},
"servers": [
{
"url": "/"
}
],
"tags": [
{
"name": "Letters content | Содержимое писем"
}
],
"paths": {
"/api/v1.0/letters/{mailId}/{date}/pdf": {
"get": {
"tags": [
"Letters content | Содержимое писем"
],
"summary": "Получение содержимого письма в формате PDF",
"operationId": "getLetterPdf",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Authorization header",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mailId",
"in": "path",
"description": "ШПИ",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "Дата",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accessCode",
"in": "query",
"description": "Код доступа",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ОК",
"content": {}
},
"400": {
"description": "Некорректный запрос",
"content": {}
},
"401": {
"description": "Некорректный идентификатор клиента и/или токен",
"content": {}
},
"403": {
"description": "Доступ запрещен",
"content": {}
},
"404": {
"description": "Запрашиваемый ресурс не найден",
"content": {}
},
"500": {
"description": "Внутренняя ошибка сервиса",
"content": {}
}
}
}
},
"/api/v1.0/letters/{mailId}/{date}/content": {
"get": {
"tags": [
"Letters content | Содержимое писем"
],
"summary": "Получение содержимого письма в формате ZIP",
"operationId": "getLetterContent",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Authorization header",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mailId",
"in": "path",
"description": "ШПИ",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "Дата",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accessCode",
"in": "query",
"description": "Код доступа",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ОК",
"content": {}
},
"400": {
"description": "Некорректный запрос",
"content": {}
},
"401": {
"description": "Некорректный идентификатор клиента и/или токен",
"content": {}
},
"403": {
"description": "Доступ запрещен",
"content": {}
},
"404": {
"description": "Запрашиваемый ресурс не найден",
"content": {}
},
"500": {
"description": "Внутренняя ошибка сервиса",
"content": {}
}
}
}
}
},
"components": {}
}
Спецификация OpenAPI, описывающая REST-сервис с функцией модификации данных ИС Ответчика:
{
"openapi": "3.0.2",
"info": {
"description": "Спецификация OpenAPI 3.0 для сервиса записи на приём к врачу",
"version": "1.0",
"title": "Запись на приём к врачу – OpenAPI 3.0"
},
"paths": {
"/booking/book": {
"post": {
"summary": "Бронирование слота",
"description": "Бронирование слота",
"operationId": "book",
"requestBody": {
"description": "Запрос",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Успешная операция",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResponse"
}
}
}
},
"400": {
"description": "Неверные параметры"
},
"500": {
"description": "Внутренняя ошибка"
}
}
}
},
"/booking/cancel": {
"post": {
"summary": "Отмена брони",
"description": "Отмена брони",
"operationId": "cancel",
"requestBody": {
"description": "Запрос",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Успешная операция",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResponse"
}
}
}
},
"400": {
"description": "Неверные параметры"
},
"500": {
"description": "Внутренняя ошибка"
}
}
}
}
},
"components": {
"schemas": {
"BookRequest": {
"type": "object",
"properties": {
"bookId": {
"type": "string"
},
"slotId": {
"type": "string"
},
"patient_id": {
"type": "string"
},
"booking_type": {
"type": "string"
},
"caseNumber": {
"type": "string"
},
"preliminaryReservation": {
"type": "boolean"
},
"referral_id": {
"type": "string"
},
"cards_id": {
"type": "string"
},
"email": {
"type": "string"
},
"mobilePhone": {
"type": "string"
}
},
"required": [
"bookId",
"slotId",
"patient_id"
]
},
"BookResponse": {
"oneOf": [
{
"$ref": "#/components/schemas/BookResponseSuccess"
},
{
"$ref": "#/components/schemas/BookResponseError"
}
]
},
"BookResponseSuccess": {
"type": "object",
"properties": {
"bookExtId": {
"type": "string"
},
"slotId": {
"type": "string"
},
"visitTime": {
"type": "string"
},
"duration": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"areaId": {
"type": "string"
},
"queueNumber": {
"type": "string"
},
"pincode": {
"type": "string"
},
"window": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Status"
}
},
"required": [
"bookExtId",
"slotId",
"visitTime",
"status"
]
},
"BookResponseError": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Status"
}
},
"required": [
"status"
]
},
"CancelRequest": {
"type": "object",
"properties": {
"bookExtId": {
"type": "string"
},
"patient_id": {
"type": "string"
}
},
"required": [
"bookExtId",
"patient_id"
]
},
"Status": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"statusMessage": {
"type": "string"
}
},
"required": [
"statusCode"
]
}
}
}
}
1.6. Типы данных СМЭВ4
Поддерживаемые СМЭВ4 типы данных и соответствующие им физические и логические типы данных avro приведены в Таблица 1.12.
Типы данных приведены к используемым в системе Prostore (каноническое avro).
№ |
Описание типа |
Размерность |
Имя типа СМЭВ4 |
Возможные значения |
Физический тип avro |
Логический тип avro |
Особенности соответствия типов |
|---|---|---|---|---|---|---|---|
1 |
Строка |
STRING |
не ограничено |
string |
|||
2 |
Целое число |
8 байт |
LONG |
от −9223372036854775808 до 9223372036854775807 |
long |
||
3 |
Целое число |
2 байта |
SHORT |
от −32768 до 32767 |
int |
||
4 |
Целое число |
4 байта |
INTEGER |
от -2147483648 до 2147483647 |
int |
||
5 |
Дата |
4 байта |
DATE |
от -2147483648 до 2147483647 |
int |
date |
unix epoch в днях, от -5 883 516 года до 5 883 515 года |
6 |
Время |
8 байт |
TIME |
от −9223372036854775808 до 9223372036854775807 |
long |
time-micros |
|
7 |
Числовые данные с плавающей запятой |
4 байта |
FLOAT |
от – (2-2-23) * 2127 до (2-2-23) * 2127 |
float |
||
8 |
Числовые данные с плавающей запятой |
8 байт |
DOUBLE |
от -1.7 * 10308 до 1.7 * 10308 |
double |
||
9 |
Большие числовые данные с плавающей запятой |
BIG_DECIMAL |
не ограничено |
string |
BigDecimalLogicalType |
||
10 |
Временная метка |
8 байт |
TIMESTAMP |
от −9223372036854775808 |
long |
timestamp-micros или LocalDateTimeLogicalType |
unix epoch в микросекундах, от – 292277 года до 292277 года |
11 |
Двоичные данные |
BINARY |
не ограничено |
bytes или record |
|||
12 |
Булевый тип |
1 байт |
BOOLEAN |
true, false |
boolean |