История изменений ====================== .. table:: История изменений +---------+----------------------------------------------------------+------------------------------------------------------------+ | Версия | Доработки | Изменения документа | +=========+==========================================================+============================================================+ | 2.11.0 | 1. [PODD-3480] - Передача запросов с табличными | 1. Требования к УВ актуализированы и распределены по | | | параметрами в Витрину (обновление) | разделам соответствующих обменов | | | | | | | 2. [PODD-4413] - Расширение состава идентифицирующих | - 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. [PODD-3480] - Реализация Rest для управления | 1. Добавлена информация о расширении модели данных Витрины | | | метаданными Витрин | массивом уникальных ключей | | | | | | | 2. [PODD-4416] - Управление метаданными РЗ через ЛК УВ | - 1.5.1. Модель данных Витрины Поставщика данных | | | Q3 | | | | | 2. Добавлены идентифицирующие атрибуты customerId, | | | 3. [PODD-4735] - Корректировки протокола Агент-Витрина | 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. [PODD-4927] - Не требуется timestamp перед датой в | 1. Добавлена информация о поддержке FOR SYSTEM_TIME без | | | for_system_time | TIMESTAMP и вычисления интервала в указанной единице | | | | времени, символ * удален из примеров поддерживаемых | | | 2. [PODD-4928] - Прокидывать единицу времени (day и др) | SQL-запросов | | | при операциях с датами | | | | | - 3.1. Поддерживаемые возможности SQL-синтаксиса | | | | | | | | 2. Актуализация информация о работе с моделью данных | | | | Витрины | | | | | | | | - 1.5.2. Модель данных Витрины Поставщика данных | | | | | | | | 3. Добавлено исключение по использованию ``*`` внутри | | | | операторов для SQL-выражения РЗ | | | | | | | | - 1.5.4. Определения Регламентированных запросов | | | | | | | | 4. Произвольные SQL-запросы доступны только для владельцев | | | | Витрин данных | | | | | | | | - 1.5.6.1. Полномочия на выполнение произвольных | | | | SQL-запросов | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.1.0 | 1. [PODD-4932] - Передача вложений по API Gateway | 1. Добавлены требования к УВ для отправки запросов к | | | (запросы к REST-сервису ИС Ответчика) более 5 мб | REST-сервису ИС Ответчика более 5 Мб | | | | | | | 2. [PODD-4891] - Именованные параметры в | - 1.4.3.2.1. Требования к Ответчикам | | | Регламентированных SQL-запросах | | | | | - 1.4.3.2.2. Требования к Инициаторам запросов | | | 3. [PODD-4327] - Реализация распределенных подписок | | | | | 2. Обновлена терминология по запросам к REST-сервису ИС | | | | Ответчика | | | | | | | | - 1.3. Участники информационного обмена с | | | | использованием ПОДД СМЭВ | | | | | | | | - 1.4.3. Обмен с использованием запросов к REST-сервису | | | | ИС Ответчика | | | | | | | | - 1.5. Метаданные ПОДД СМЭВ | | | | | | | | 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. Подписки Потребителей данных ПОДД СМЭВ | | | | | | | | - 1.5.6.4. Полномочия на Рассылку | | | | | | | | - 2.3. Протокол взаимодействия Агента СМЭВ4 и | | | | Витрины Поставщика данных | | | | | | | | - 2.5. Протокол взаимодействия Агента СМЭВ4 и | | | | Хранилища данных по подписке Потребителя данных | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.2.0 | 1. [PODD-4890] - Доработка конфигурирования Агента ПОДД | 1. Добавлена информация о возможности использования общего | | | и схем Витрин (возможность использования общих | набора топиков протокола взаимодействия Агент СМЭВ4 | | | топиков для нескольких схем Витрин) | -Витрина | | | | | | | 2. [PODD-5280] - Вызов РЗ с именованными параметрами для | - 2.3. Протокол взаимодействия Агента СМЭВ4 и | | | ЦА | Витрины Поставщика данных | | | | | | | | - 2.5. Протокол взаимодействия Агента СМЭВ4 и | | | 3. [PODD-5372] - Ошибка регистрации регламентированного | Хранилища данных по подписке Потребителя данных | | | запроса с мнемоникой, содержащей зарезервированное | | | | ключевое слово SQL | 2. Добавлена возможность вызова РЗ через CALL | | | | | | | | - 3.3. Выполнение регламентированных SQL-запросов | | | | | | | | 3. Запрещено использование зарезервированных ключевых слов | | | | SQL в мнемонике Витрины и Регламентированного | | | | SQL-запроса | | | | | | | | - 1.5.1. Поддерживаемые форматы | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.3.0 | 1. [PODD-4885] - Лимиты для запросов к REST-сервису ИС | 1. Добавлены возможные коды возврата ПОДД при ошибках | | | Ответчика | выполнения запроса к REST-сервису ИС Ответчика | | | | | | | | - 2.4.1.3. Выполнение запросов к REST-сервису ИС | | | | Ответчика | | | | | | | | 2. Добавлена информация о работе и задании лимитов для | | | | запросов к REST-сервису ИС Ответчика | | | | | | | | - 1.4.3.2.1. Требования к Ответчикам | | | | | | | | - 1.4.3.4.3. Информационный обмен для механизма с | | | | возможностью отправки большого запроса | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.4.0 | 1. [PODD-5435] – Использование диагностического запроса | 1. Добавлена информация о понятии Диагностический запрос и | | | к Витрине данных | его использовании | | | | | | | 2. [PODD-5470] – Обеспечение поддержки времени жизни | - 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. Подписки Потребителей данных ПОДД СМЭВ на | | | | регламентированный запрос типа «Рассылка» (При | | | | перерегистрации подписки требуется указывать новый | | | | идентификатор) | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.5.0 | 1. [PODD-5459] - Конфигурирование функций агента ПОДД | 1. Добавлена информация о статической и динамической | | | | регистрации Витрин: | | | 2. [PODD-5745] - Запрос BLOB по ссылке при | | | | взаимодействии ИС Потребителя с Агентом через | - 2.3.3. Настройка Агента СМЭВ4 для работы с | | | REST-интерфейс | несколькими Витринами | | | | | | | 3. [PODD-5598] - Сквозная идентификация запросов | 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. Добавлена информация о сквозной идентификации запросов | | | | в ПОДД СМЭВ: | | | | | | | | - 3.7. Сквозная идентификация запросов | | | | | | | | - 2.4. Протокол взаимодействия Агента СМЭВ4 и ИС | | | | Потребителя данных (формат передачи клиентского | | | | идентификатора) | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.6.0 | 1. [PODD-6320] - [3ЛП][ПОДД] При регистрации РЗ в ЕИП | 1. Добавлены требования к алиасам возвращаемого | | | НСУД через REST пропали префиксы таблицы в атрибутах | Потребителю атрибута: | | | | | | | | - 1.5.1. Поддерживаемые форматы | | | | | | | | - 1.5.4. Определения Регламентированных SQL-запросов | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.7.0 | 1. [PODD-5442] – [Проектирование+Реализация] процесс | 1. Обновлены метаданные подписки и инструменты для | | | управления подписками в ЛК УВ | управления ими; термин «отмена подписки» заменён на | | | | «удаление подписки»; добавлены топики для удаления | | | | подписки на потребителе: | | | | | | | | - 1.4.2. Обмен с использованием Рассылок; | | | | | | | | - 1.5.3. Подписки Потребителей данных ПОДД СМЭВ на | | | | регламентированный запрос типа «Рассылка»; | | | | | | | | - 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. Убрана информация о кодах событий СЦЛ в сообщениях | | | | Витрины, в связи с расширением их перечня и | | | | неконтролируемостью на стороне ПОДД СМЭВ: | | | | | | | | - Приложение 2. - 3.6. Получение событий от Витрины | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.8.0 | 1. [PODD-7151] – Расширение перечня системных параметров | 1. Добавлена информация о системных параметрах | | | | ``settings_for_system_time_started`` и | | | 2. [PODD-7039] – Доработка подписания запросов печатных | ``settings_for_system_time_finished``: | | | форм | | | | | - :numref:`system_param_query` | | | 3. [PODD-7161] – Реорганизация обработки запросов к | | | | REST-сервису Ответчика | 2. Добавлена информация о запросах с получением печатной | | | | формы: | | | 4. [PODD-6388] – Изменены значения таймаутов | | | | | - :numref:`sql_request_definition` | | | | | | | | - :numref:`printable_form_output` | | | | | | | | - :numref:`terms` | | | | | | | | 3. Изменено максимальное значение таймаута, задаваемого | | | | в SQL-запросе, корректировка терминологии в части | | | | вызова запроса с надстройками и без надстроек: | | | | | | | | - :numref:`consumer_sql_rest_interface` | | | | | | | | 4. Изменено время хранения результата запроса, вызванного | | | | в асинхронном режиме: | | | | | | | | - :numref:`consumer_sql_rest_interface` | | | | | | | | 5. Корректировка процесса выполнения запросов к | | | | REST-сервису Ответчика: валидация осуществляется Ядром | | | | | | | | - :numref:`rest_respondent_registration` | | | | | | | | - :numref:`interaction_without_large_request` | | | | | | | | 6. Оптимизация документа. Удалены разделы с описанием | | | | технических деталей: | | | | | | | | - 2.1. Протокол ПОДД СМЭВ | | | | | | | | - 2.3.1 Перечень заголовков сообщений в Apache Kafka | | | | | | | | - 2.3.4 Последовательность исполнения SQL-запроса в | | | | контуре Поставщика данных | | | | | | | | - 2.5.2 Структуры сообщений для взаимодействия с | | | | Потребителем данных | | | | | | | | - 3.3.2 Преобразование исходного запроса | | | | | | | | - 3.5. Формирование и передача статистики атрибутов | | | | Витрины данных Агенту СМЭВ4 | | | | | | | | - Приложение 2 Структуры сообщений для взаимодействия с | | | | Поставщиком | | | | | | | | - Приложение 3 Структуры сообщений для взаимодействия с | | | | Потребителем данных | | | | | | | | 7. Оптимизация документа. Подготовлено описание без | | | | технических деталей: | | | | | | | | - :numref:`rz_exchange_description` | | | | | | | | - :numref:`terms` | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.9.1 | 1. [PODD-5671] – Добавлена возможность лимитирования | 1. Добавлена информация о лимитировании запросов в СМЭВ4: | | | регламентированных запросов Потребителя | | | | к информационным ресурсам Поставщика данных | - :numref:`limiting_requests` | | | | | | | 2. [PODD-6670] – Удалён механизм по управлению | 2. Убрана информация об управлении подписками через ВС: | | | подписками через ВС | | | | | - :numref:`distribution_subscription` | | | | | | | | 3. Доработка документа. Скорректировано описание типов | | | | атрибутов и параметров: | | | | | | | | - :numref:`supported_formats` | | | | | | | | 4. Доработка документа. Указан заголовок с версией | | | | протокола REST-интерфейса Агента ПОДД для SQL-запросов: | | | | | | | | - :numref:`consumer_sql_rest_interface` | | | | | | | | 5. Удален раздел "Приложение 1 Пример проекта для | | | | реализации взаимодействия с Агентом СМЭВ4" | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.10.0 | 1. [PODD-6979] – Ограничена возможность исполнения | 1. Добавлена информация об ограничении на использование | | | запросов с использованием SQL-РЗ с дополнительными | запросов с надстройками: | | | условиями фильтрации и операциями над получаемыми | | | | данными (запросов с надстройками) | - :numref:`sql_request_definition` | | | | | | | 2. [PODD-6930] – Для запросов, вызванных в асинхронном | - :numref:`consumer_protocol` | | | режиме и выполненных через транспорт RSocket, | | | | реализован возврат времени, до которого доступен | - :numref:`executing_rules` | | | результат выполнения запроса (ранее было доступно | | | | только при передаче через транспорт Pulsar) | 2. Оптимизация и актуализация документа: | | | | | | | | - Удалён раздел "Примеры реализации взаимодействия с | | | | Агентом ПОДД СМЭВ с использованием брокера сообщений | | | | Apache Kafka" | | | | | | | | - Введены термины право доступа и полномочие. | | | | Текст приведён в соответствие с этими терминами. | | | | | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.11.0 | 1. [PODD-7345] – Обеспечена возможность приостановки | 1. Добавлена информация о возможности приостановки обмена | | | и возобновления информационного обмена по подписке | по подписке: | | | при возникновении сбое | | | | | - :numref:`distribution_interaction_description` | | | 2. [PODD-9241] – Обеспечена возможность передачи | | | | мнемоники ИС Инициатора запроса Ответчику. | 2. Добавлена информация о возможности передачи мнемоники | | | При добавлении в Спецификацию OpenAPI REST-сервиса | ИС Инициатора запроса Ответчику: | | | Ответчика специального заголовка, ПОДД осуществляет | | | | проверку соответствия мнемоники ИС, с которой пришёл | - :numref:`respondent_rest_services` | | | запрос, и мнемоники ИС, указанной в заголовке | | | | | - :numref:`respondent_response` | | | 3. [PODD-6347], [PODD-6370] – Ограничено время исполнения| | | | запросов на получение BLOB по ссылке и к REST-сервису | 3. Добавлена информация об ограничении времени исполнения | | | ИС Ответчика. | запросов на получение BLOB по ссылке и к REST-сервису: | | | | | | | | - :numref:`blob_sql_request` | | | | | | | | - :numref:`respondent_request` | | | | | | | | 4. Оптимизация и актуализация документа: | | | | | | | | - Удалён раздел "Настройка Агента СМЭВ4 для работы с | | | | Витринами данных" | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.12.0 | - | 1. Обновлены схемы: | | | | | | | | - на схемах заменено название Агент ПОДД на Агент СМЭВ4 | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.12.1 | 1. [PODD-10175] - [3ЛП] Копится очередь на запись в lager| 1. Добавлена рекомендация по использованию запроса на | | | | удаление результата асинхронно вызванного запроса | | | | и его структура: | | | | | | | | - :numref:`consumer_sql_async_request` | | | | - :numref:`consumer_async_sql_delete_response` | +---------+----------------------------------------------------------+------------------------------------------------------------+ | 3.13.0 | 1. [PODD-10022] - Контроль выполнения РЗ API GW на | 1. Обновлено описание и схема процесса обработки запроса к | | | стороне Агента ПОДД | REST-сервису Ответчика с учётом возможности проверки | | | | полномочий (см :numref:`interaction_with_large_request`)| | | 2. [PODD-10087] - Поддержка системных именованных | | | | параметров, отвечающих за номер операции в Просторе | 2. Расширено описание поддерживаемых системных параметров | | | | с номерами операций (см :numref:`system_param_query`) | | | 3. [PODD-9539] - Хранилище запросов-ответов при запросах | | | | к REST-сервису Ответчика | 3. Добавлена спецификация REST-интерфейса Агента СМЭВ4 для | | | | выполнения запросов к Витринам Поставщиков данных, а | | | 4. [PODD-7066] - Перенос профилей витрин в Ядро ПОДД | также обновлены примеры запросов в формате curl | | | | (см :numref:`consumer_sql_rest_interface`) | | | | | | | | 4. Добавлено описание возможности по сохранению запросов и | | | | ответов при запросах к REST-сервису Ответчика: | | | | | | | | - (см :numref:`respondent_rest_services`) | | | | | | | | - (см :numref:`storage_request_response_access`) | | | | | | | | 5. Перечень типовых ошибок, коды возврата и пути решения | | | | вынесены отдельно в :numref:`annex_at` | | | | | | | | 6. Добавлено описание профиля витрины | +---------+----------------------------------------------------------+------------------------------------------------------------+