История изменений ====================== .. table:: История изменений +---------+------------------------------------------------------------------------------------------------------------------+ | Версия | Изменения документа | +=========+==================================================================================================================+ | 2.11.0 | 1. Требования к УВ актуализированы и распределены по разделам соответствующих обменов: | | | | | | - 1.4.1.2, 1.4.2.2, 1.4.3.2 Требования к участникам взаимодействия. | | | | | | 2. Добавлена рекомендация по работе с новыми версиями Витрин и РЗ (предупреждение об автоматическом | | | предоставлении доступа к новой версии): | | | | | | - 1.5.1. Модель данных Витрины Поставщика данных; | | | | | | - 1.5.3. Определения Регламентированных запросов; | | | | | | 3. Актуализирован перечень заголовков: | | | | | | - 2.3.1. Перечень заголовков сообщений в Apache Kafka. | | | | | | 4. Добавлен новый топик для передачи ТП в Витрину с бинарным разбиением на чанки | | | (<мнемоника Витрины>.query.tp.bin): | | | | | | - 2.3.2. Перечень топиков брокера сообщений Apache Kafka. | | | | | | 5. Изменен порядок атрибутов в сообщении с табличными параметрами для Витрины: | | | | | | - 2.3.5.3.1.2. Передача чанков табличных параметров (<мнемоника Витрины>.query.tp / | | | <мнемоника Витрины>.query.tp.bin). | | | | | | 6. Удален атрибут priority из запроса БЛОБ по ссылке: | | | | | | - 2.3.5.3.2.1. Запрос на получение БЛОБ по ссылке от Витрины (<мнемоника Витрины>.blob.rq). | +---------+------------------------------------------------------------------------------------------------------------------+ | 2.12.0 | 1. Добавлена информация о расширении модели данных Витрины массивом уникальных ключей: | | | | | | - 1.5.1. Модель данных Витрины Поставщика данных. | | | | | | 2. Добавлены идентифицирующие атрибуты customerId, customerOgrn, queryMnemonic в структуру сообщений для | | | взаимодействия с Поставщиком: | | | | | | - 2.3.5.3.1.1. Запрос данных из Витрины (<мнемоника Витрины>.query.rq / | | | <мнемоника Витрины>.procedure.query.rq); | | | | | | - 2.3.5.3.1.2. Передача чанков табличных параметров (<мнемоника Витрины>.query.tp / | | | <мнемоника Витрины>.query.tp.bin). | | | | | | 3. Актуализированы ограничения на загружаемые метаданные (на формат и бизнес ограничения): | | | | | | - 1.5.1. Поддерживаемые форматы; | | | | | | - 1.5.2. Модель данных Витрины Поставщика данных; | | | | | | - 1.5.4. Определения Регламентированных запросов. | | | | | | 4. Скорректирован пример выполнения РЗ (в рамках отказа от ``*`` в SQL РЗ): | | | | | | - 3.2.6. Регламентированные запросы. | +---------+------------------------------------------------------------------------------------------------------------------+ | 2.15.0 | 1. Добавлена информация о поддержке FOR SYSTEM_TIME без TIMESTAMP и вычисления интервала в указанной единице | | | времени, символ * удален из примеров поддерживаемых SQL-запросов: | | | | | | - 3.1. Поддерживаемые возможности SQL-синтаксиса. | | | | | | 2. Актуализация информация о работе с моделью данных Витрины: | | | | | | - 1.5.2. Модель данных Витрины Поставщика данных. | | | | | | 3. Добавлено исключение по использованию ``*`` внутри операторов для SQL-выражения РЗ: | | | | | | - 1.5.4. Определения Регламентированных запросов. | | | | | | 4. Произвольные SQL-запросы доступны только для владельцев Витрин данных: | | | | | | - 1.5.6.1. Полномочия на выполнение произвольных SQL-запросов. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.1.0 | 1. Добавлены требования к УВ для отправки запросов к REST-сервису ИС Ответчика более 5 Мб: | | | | | | - 1.4.3.2.1. Требования к Ответчикам: | | | | | | - 1.4.3.2.2. Требования к Инициаторам запросов. | | | | | | 2. Обновлена терминология по запросам к REST-сервису ИС Ответчика: | | | | | | - 1.3. Участники информационного обмена с использованием СМЭВ4; | | | | | | - 1.4.3. Обмен с использованием запросов к REST-сервису ИС Ответчика; | | | | | | - 1.5. Метаданные СМЭВ4. | | | | | | 3. Добавлено описание механизма прохождения запросов к REST-сервису ИС Ответчика более 5 Мб: | | | | | | - 1.4.3.3. Взаимодействие участников обмена; | | | | | | - 1.4.3.4.3. Информационный обмен для механизма с возможностью отправки большого запроса. | | | | | | 4. Добавлена информация об именованных параметрах Регламентированных SQL-запросов: | | | | | | - 1.5.4. Определения Регламентированных SQL-запросов; | | | | | | - 3.3.3. Примеры вызова и преобразования исходного запроса; | | | | | | - 3.3.4. Выполнение запроса с системным параметром. | | | | | | 5. Обновлено описание информационного обмена по рассылкам с учётом возможности распределённой подписки, | | | применена согласованная терминология: | | | | | | - 1.4.2. Обмен с использованием Рассылок; | | | | | | - 1.5.3. Подписки Потребителей данных СМЭВ4; | | | | | | - 1.5.6.4. Полномочия на Рассылку; | | | | | | - 2.3. Протокол взаимодействия Агента СМЭВ4 и Витрины Поставщика данных; | | | | | | - 2.5. Протокол взаимодействия Агента СМЭВ4 и Хранилища данных по подписке Потребителя данных. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.2.0 | 1. Добавлена информация о возможности использования общего набора топиков протокола взаимодействия Агент СМЭВ4 | | | - Витрина: | | | | | | - 2.3. Протокол взаимодействия Агента СМЭВ4 и Витрины Поставщика данных; | | | | | | - 2.5. Протокол взаимодействия Агента СМЭВ4 и Хранилища данных по подписке Потребителя данных. | | | | | | 2. Добавлена возможность вызова РЗ через ``CALL``: | | | | | | - 3.3. Выполнение регламентированных SQL-запросов. | | | | | | 3. Запрещено использование зарезервированных ключевых слов SQL в мнемонике Витрины и Регламентированного | | | SQL-запроса: | | | | | | - 1.5.1. Поддерживаемые форматы. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.3.0 | 1. Добавлены возможные коды возврата СМЭВ4 при ошибках выполнения запроса к REST-сервису ИС Ответчика: | | | | | | - 2.4.1.3. Выполнение запросов к REST-сервису ИС Ответчика. | | | | | | 2. Добавлена информация о работе и задании лимитов для запросов к REST-сервису ИС Ответчика : | | | | | | - 1.4.3.2.1. Требования к Ответчикам; | | | | | | - 1.4.3.4.3. Информационный обмен для механизма с возможностью отправки большого запроса. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.4.0 | 1. Добавлена информация о понятии Диагностический запрос и его использовании: | | | | | | - 3.6. Использование диагностического запроса к Витрине данных; | | | | | | - Термины и сокращения. | | | | | | 2. Добавлена информация о времени жизни запроса (таймауте) по умолчанию: | | | | | | - 2.4.1.1.1. HTTP-запрос (метод POST) (синхронный режим); | | | | | | - 2.4.1.2.1.1. HTTP-запрос (метод POST) (асинхронный режим); | | | | | | - 2.4.1.2.1.2. HTTP-запрос с табличным параметром (метод POST) (асинхронный режим). | | | | | | 3. Добавлены дополнительные сведения по использованию подписок на Рассылку: | | | | | | - 1.4.2.1. Общее описание информационного обмена (подписка не может быть поставлена на паузу); | | | | | | - 1.5.3. Подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка» (При | | | перерегистрации подписки требуется указывать новый идентификатор). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.5.0 | 1. Добавлена информация о статической и динамической регистрации Витрин: | | | | | | - 2.3.3. Настройка Агента СМЭВ4 для работы с несколькими Витринами. | | | | | | 2. Добавлена информация по запросу BLOB по ссылке через REST-интерфейс: | | | | | | - 2.4.1. REST-интерфейс Агента СМЭВ4; | | | | | | - 2.4.1.3. Выполнение запроса на получение BLOB по ссылке; | | | | | | - 3.3.6. Получение двоичных объектов в результатах запроса. | | | | | | 3. Добавлена информация по запросам через REST-интерфейс при подключении к брокеру: | | | | | | - 2.4.1. REST-интерфейс Агента СМЭВ4. | | | | | | 4. Добавлено требование к использованию лимитов (limit), при вызове запросов не являющихся аналитическими: | | | | | | - 3.3.1. Правила выполнения. | | | | | | 5. Добавлены примеры вызова Регламентированных SQL-запросов с параметрами типов TIMESTAMP и DATE: | | | | | | - 3.3.3. Примеры вызова и преобразования исходного запроса. | | | | | | 6. Добавлена информация о сквозной идентификации запросов в СМЭВ4: | | | | | | - 3.7. Сквозная идентификация запросов; | | | | | | - 2.4. Протокол взаимодействия Агента СМЭВ4 и ИС Потребителя данных (формат передачи клиентского | | | идентификатора). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.6.0 | 1. Добавлены требования к алиасам возвращаемого Потребителю атрибута: | | | | | | - 1.5.1. Поддерживаемые форматы; | | | | | | - 1.5.4. Определения Регламентированных SQL-запросов. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.7.0 | 1. Обновлены метаданные подписки и инструменты для управления ими; термин «отмена подписки» заменён на | | | «удаление подписки»; добавлены топики для удаления подписки на потребителе: | | | | | | - 1.4.2. Обмен с использованием Рассылок; | | | | | | - 1.5.3. Подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка»; | | | | | | - 1.5.4. Определения Регламентированных SQL-запросов; | | | | | | - 2.5. Протокол взаимодействия Агента СМЭВ4 и Хранилища данных по подписке Потребителя данных; | | | | | | - Приложение 3 2.5. Удаление подписки. | | | | | | 2. Расширено описание процесса получении двоичных объектов в результатах запросов: | | | | | | - 3.3.6. Получение двоичных объектов в результатах запроса. | | | | | | 3. Добавлен топик scl.signal для Хранилища данных по подписке и добавлены атрибуты для событий связанных с | | | подписками: | | | | | | - 2.5.1. Перечень топиков брокера сообщений Apache Kafka; | | | | | | - Приложение 2 - 3.6. Получение событий от Витрины; | | | | | | - Приложение 3 - 2.6. Получение событий от Витрины. | | | | | | 4. Убрана информация о кодах событий СЦЛ в сообщениях Витрины, в связи с расширением их перечня и | | | неконтролируемостью на стороне СМЭВ4: | | | | | | - Приложение 2. - 3.6. Получение событий от Витрины. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.8.0 | 1. Добавлена информация о системных параметрах ``settings_for_system_time_started`` и | | | ``settings_for_system_time_finished``: | | | | | | - 3.2.3 Выполнение запроса с системным параметром. | | | | | | 2. Добавлена информация о запросах с получением печатной формы: | | | | | | - 1.5.4 Определения Регламентированных SQL-запросов; | | | | | | - 3.2.6 Получение печатной формы в результатах запроса; | | | | | | - Термины и сокращения. | | | | | | 3. Изменено максимальное значение таймаута, задаваемого в SQL-запросе, корректировка терминологии в части | | | вызова запроса с надстройками и без надстроек: | | | | | | - 2.3.1 REST-интерфейс Агента СМЭВ4 для SQL-запросов к Витринам данных. | | | | | | 4. Изменено время хранения результата запроса, вызванного в асинхронном режиме: | | | | | | - 2.3.1 REST-интерфейс Агента СМЭВ4 для SQL-запросов к Витринам данных. | | | | | | 5. Корректировка процесса выполнения запросов к REST-сервису Ответчика: валидация осуществляется Ядром | | | | | | - 1.4.4.4.1 Регистрация в СМЭВ4 REST-сервиса ИС Ответчика. | | | | | | 6. Оптимизация документа. Удалены разделы с описанием технических деталей: | | | | | | - 2.1. Протокол СМЭВ4; | | | | | | - 2.3.1 Перечень заголовков сообщений в Apache Kafka; | | | | | | - 2.3.4 Последовательность исполнения SQL-запроса в контуре Поставщика данных; | | | | | | - 2.5.2 Структуры сообщений для взаимодействия с Потребителем данных; | | | | | | - 3.3.2 Преобразование исходного запроса; | | | | | | - 3.5. Формирование и передача статистики атрибутов Витрины данных Агенту СМЭВ4; | | | | | | - Приложение 2 Структуры сообщений для взаимодействия с Поставщиком; | | | | | | - Приложение 3 Структуры сообщений для взаимодействия с Потребителем данных. | | | | | | 7. Оптимизация документа. Подготовлено описание без технических деталей: | | | | | | - 1.4.1.1 Общее описание информационного обмена; | | | | | | - Термины и сокращения. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.9.1 | 1. Добавлена информация о лимитировании запросов в СМЭВ4: | | | | | | - Раздел 3.5. | | | | | | 2. Убрана информация об управлении подписками через ВС: | | | | | | - Раздел 1.5.5. | | | | | | 3. Доработка документа. Скорректировано описание типов атрибутов и параметров: | | | | | | - Раздел 1.5.1. | | | | | | 4. Доработка документа. Указан заголовок с версией протокола REST-интерфейса Агента СМЭВ4 для SQL-запросов: | | | | | | - Раздел 2.3.1. | | | | | | 5. Удален раздел "Приложение 1 Пример проекта для реализации взаимодействия с Агентом СМЭВ4". | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.10.0 | 1. Добавлена информация об ограничении на использование запросов с надстройками: | | | | | | - Раздел 1.5.4; | | | | | | - Раздел 2.3; | | | | | | - Раздел 3.2.1. | | | | | | 2. Оптимизация и актуализация документа: | | | | | | - Удалён раздел "Примеры реализации взаимодействия с Агентом СМЭВ4 с использованием брокера | | | сообщений Apache Kafka"; | | | | | | - Введены термины "право доступа" и "полномочие". Текст приведён в соответствие с этими терминами. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.11.0 | 1. Добавлена информация о возможности приостановки обмена по подписке: | | | | | | - Раздел 1.4.2.1. | | | | | | 2. Добавлена информация о возможности передачи мнемоники ИС Инициатора запроса Ответчику: | | | | | | - Раздел 1.5.6; | | | | | | - Раздел 2.3.3.2. | | | | | | 3. Добавлена информация об ограничении времени исполнения запросов на получение BLOB по ссылке и к REST-сервису: | | | | | | - Раздел 2.3.1.4; | | | | | | - Раздел 2.3.3.1. | | | | | | 4. Оптимизация и актуализация документа: | | | | | | - Удалён раздел "Настройка Агента СМЭВ4 для работы с Витринами данных". | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.12.0 | 1. Обновлены схемы: | | | | | | - на схемах заменено название Агент ПОДД на Агент СМЭВ4. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.12.1 | 1. Добавлена рекомендация по использованию запроса на удаление результата асинхронно вызванного запроса | | | и его структура: | | | | | | - Раздел 2.3.1.2; | | | | | | - Раздел 2.3.1.2.3. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.13.0 | 1. Обновлено описание и схема процесса обработки запроса к REST-сервису Ответчика с учётом возможности проверки | | | полномочий. | | | | | | 2. Расширено описание поддерживаемых системных параметров с номерами операций. | | | | | | 3. Добавлена спецификация REST-интерфейса Агента СМЭВ4 для выполнения запросов к Витринам Поставщиков данных, а | | | также обновлены примеры запросов в формате *curl*. | | | | | | 4. Добавлено описание возможности по сохранению запросов и ответов при запросах к REST-сервису Ответчика: | | | | | | - Раздел 1.5.6; | | | | | | 5. Перечень типовых ошибок, коды возврата и пути решения вынесены отдельно в Приложении А. | | | | | | 6. Добавлено описание профиля витрины. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.15.0 | Оформление документа, минорные исправления | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.16.0 | 1. Добавлена функция полнотекстового поиска, при информационных обменах | | | с использованием Регламентированных SQL-запросов (Раздел 3.2.7). | | | | | | 2. Добавлена функция задания последовательности выполнения подзапросов, | | | при информационных обменах с использованием распределенных Регламентированных SQL-запросов | | | (задается в ЕИП НСУД) (Раздел 1.4.1.1 и Раздел 1.5.4). | | | | | | 3. Удалено описание информационного обмена с использованием REST-РЗ по старому протоколу взаимодействия | | | (без возможности отправки запросов более 5 Мб) для Агентов старше 3.8.0. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.17.0 | 1. Добавлено описание возможности по сохранению SQL-запросов (Раздел 1.4.1.1). | | | | | | 2. Удалено описание устаревших топиков kafka в описании взаимодействия Агент-Витрина | | | (Таблица 2.5). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.18.0 | 1. Поддержка дополнительных вариантов синтаксиса FOR SYSTEM_TIME в SQL-РЗ (Раздел 3.1). | | | | | | 2. Оформление документа, минорные исправления. | | | | | | 3. Поддержка функции LISTAGG в SQL-РЗ (Раздел 3.1). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.19.0 | 1. Указаны требования к версиям типового ПО для обеспечения работоспособности новых функций СМЭВ4. | | | | | | 2. Добавлено правило создания представлений (Раздел 1.5.4.3). | | | | | | 3. Минорные исправления оформления документа. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.20.0 | 1. Детализировано описание запросов печатных форм (Разделы 1.4.2.2.1, 1.5.4.1, 1.5.4.2 и 3.2.6). | | | | | | 2. Добавлено описание пользовательского таймаута, задаваемого в конфигурации Агента Потребителя | | | (Раздел 2.3.1). | | | | | | 3. Добавлено описание пользовательского таймаута в запросах к REST-сервису ИС Ответчика | | | (Раздел 3.3). | | | | | | 4. Изменено описание версии в запросе выполнения SQL-РЗ (Раздел 2.3.1.1.1). | | | | | | 5. Исключен раздел 1.5.7.5. | | | | | | 6. Минорные исправления оформления документа. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.20.1 | 1. Удалены дублирующиеся сноски. | | | | | | 2. Исправлены орфографические и синтаксические ошибки. | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.21.0 | 1. Удалены упоминания протокола взаимодействия между Агентом СМЭВ4 и Ядром СМЭВ4 Apache Pulsar. | | | | | | 2. Добавлен параметр для определения формата возвращаемых в ответе на запрос данных при взаимодействии ИС и | | | Агента СМЭВ4 через REST-интерфейс (Раздел 2.3.1). | | | | | | 3. Добавлено описание оптимизации SQL-запросов (Разделы 1.5.4.1, 1.5.4.2). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.22.0 | 1. Уточнено определение запроса с надстройками: | | | | | | - Раздел 5; | | | | | | - Раздел 1.5.4.2; | | | | | | - Раздел 3.2.1; | | | | | | - Раздел 2.3.1.1.2; | | | | | | - Раздел 2.3.1.2.1.2; | | | | | | - Раздел 2.3.1.3.2; | | | | | | 2. Добавлена необходимость установки настройки subQueryParamSupport: "DYNAMIC_PARAM_SUPPORT" профиля Витрины | | | при использовании Агента СМЭВ4 совместно с Сервисом проверки полномочий Prohibitor | | | (Раздел 1.5.3). | | | | | | 3. Добавлено описание времени жизни для ссылок на двоичные объекты (Раздел 3.2.5). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.23.0 | 1. Добавлены типовые ошибки при блокировке участников взаимодействия (Раздел 4). | | | | | | 2. Поддержка ``FOR SYSTEM_TIME RAW`` синтаксиса SQL-РЗ (Раздел 3.1). | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.24.0 | Изменений нет | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.25.0 | 1. Удалена оптимизация для простых запросов: | | | | | | - Раздел 1.5.4.1; | | | | | | - Раздел 1.5.4.2. | | | | | | 2. Добавлена возможность обеспечения юридической значимости обменов: | | | | | | - Раздел 1.4.1.1; | | | | | | - Раздел 1.4.4.1; | | | | | | - Раздел 1.5.4.1; | | | | | | - Раздел 1.5.6; | | | | | | - Раздел 3.6. | | | | | | 3. Добавлено описание нового типа информационного обмена Регламентированный SQL-запрос с категорией «Рассылка | | | (для Компонента «Витрина данных» версии 2.x)». | +---------+------------------------------------------------------------------------------------------------------------------+ | 3.26.0 | Добавлено описание нового объекта «Виртуальный кластер» и возможности указания нового параметра ``push`` при | | | вызове SQL-РЗ методом ``/regulated-query/async``: | | | | | | - Раздел 1.5.8; | | | | | | - Раздел 2.3.1.2.4; | | | | | | - Раздел 3.2.8. | | | | | | В разделе 3.5.2 обновлен список условий для добавления лимитов. | +---------+------------------------------------------------------------------------------------------------------------------+