Методические рекомендации по работе с СМЭВ4

Содержание

• 1. Введение
  • 1.1. Общие Сведения
    • 1.1.1. Нормативно-правовые основания
  • 1.2. Виды информационного обмена с использованием СМЭВ
  • 1.3. Участники информационного обмена с использованием СМЭВ4
  • 1.4. Информационный обмен участников взаимодействия с использованием СМЭВ4
    • 1.4.1. Обмен с использованием Регламентированных SQL-запросов
      • 1.4.1.1. Общее описание информационного обмена
      • 1.4.1.2. Требования к участникам взаимодействия
        • 1.4.1.2.1. Требования к Поставщикам данных
        • 1.4.1.2.2. Требования к Потребителям данных
      • 1.4.1.3. Взаимодействие участников обмена
      • 1.4.1.4. Информационный обмен с использованием SQL-РЗ
    • 1.4.2. Обмен с использованием Рассылок (для Компонента «Витрина данных» версии 1.x)
      • 1.4.2.1. Общее описание информационного обмена
      • 1.4.2.2. Требования к участникам взаимодействия
        • 1.4.2.2.1. Требования к Поставщикам данных
        • 1.4.2.2.2. Требования к Потребителям данных
      • 1.4.2.3. Взаимодействия участников обмена
      • 1.4.2.4. Описание этапов
        • 1.4.2.4.1. Регистрация подписки
        • 1.4.2.4.2. Информационный обмен
        • 1.4.2.4.3. Удаление подписки
    • 1.4.3. Обмен с использованием Рассылок (для Компонента «Витрина данных» версии 2.x)
      • 1.4.3.1. Общее описание информационного обмена
      • 1.4.3.2. Требования к участникам взаимодействия
        • 1.4.3.2.1. Требования к Поставщикам данных
        • 1.4.3.2.2. Требования к Потребителям данных
      • 1.4.3.3. Взаимодействие участников обмена
      • 1.4.3.4. Описание этапов
        • 1.4.3.4.1. Регистрация в СМЭВ4 SQL-РЗ
        • 1.4.3.4.2. Создание материализованного представления
        • 1.4.3.4.3. Информационный обмен
    • 1.4.4. Обмен с использованием запросов к REST-сервису ИС Ответчика
      • 1.4.4.1. Общее описание информационного обмена
      • 1.4.4.2. Требования к участникам взаимодействия
        • 1.4.4.2.1. Требования к Ответчикам
        • 1.4.4.2.2. Требования к Инициаторам запросов
      • 1.4.4.3. Взаимодействие участников обмена
      • 1.4.4.4. Описание этапов
        • 1.4.4.4.1. Регистрация в СМЭВ4 REST-сервиса ИС Ответчика
        • 1.4.4.4.2. Информационный обмен с использованием REST-РЗ
  • 1.5. Метаданные СМЭВ4
    • 1.5.1. Поддерживаемые форматы
    • 1.5.2. Модель данных Витрины Поставщика данных
    • 1.5.3. Профиль Витрины Поставщика данных
    • 1.5.4. Определения Регламентированных SQL-запросов
      • 1.5.4.1. Содержание Регламентированного SQL-запроса
      • 1.5.4.2. Правила/ограничения использования
      • 1.5.4.3. Правило создания представлений
    • 1.5.5. Подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка (для Компонента «Витрина данных» версии 1.x)»
    • 1.5.6. REST-сервисы ИС Ответчиков
    • 1.5.7. Права доступа Потребителя данных СМЭВ4
      • 1.5.7.1. Право доступа на выполнение произвольных SQL-запросов
      • 1.5.7.2. Право доступа на выполнение Регламентированных SQL-запросов
      • 1.5.7.3. Право доступа на выполнение запросов к REST-сервису ИС Ответчика
      • 1.5.7.4. Право доступа на Рассылку
  • 1.6. Типы данных СМЭВ4
• 2. Описание подключения к СМЭВ4
  • 2.1. Подключение участников взаимодействия с использованием СМЭВ4
  • 2.2. Протокол взаимодействия Агента СМЭВ4 и Витрины Поставщика данных
    • 2.2.1. Перечень топиков брокера сообщений Apache Kafka
  • 2.3. Протокол взаимодействия Агента СМЭВ4 и ИС Потребителя данных
    • 2.3.1. REST-интерфейс Агента СМЭВ4 для SQL-запросов к Витринам данных
      • 2.3.1.1. Выполнение SQL-запросов (синхронный режим)
        • 2.3.1.1.1. HTTP-запрос выполнения SQL-РЗ
        • 2.3.1.1.2. HTTP-запрос выполнения SQL-запроса (с возможностью использования надстроек)
        • 2.3.1.1.3. Ответ на HTTP-запрос
      • 2.3.1.2. Выполнение SQL-запросов (асинхронный режим)
        • 2.3.1.2.1. HTTP-запрос выполнения SQL-РЗ (метод POST)
          • 2.3.1.2.1.1. HTTP-запрос выполнения SQL-РЗ
          • 2.3.1.2.1.2. HTTP-запрос выполнения SQL-запроса (с возможностью использования надстроек)
          • 2.3.1.2.1.3. Ответ на HTTP-запрос
        • 2.3.1.2.2. HTTP-запрос получения результата ранее переданного асинхронного SQL-запроса (метод GET)
          • 2.3.1.2.2.1. HTTP-запрос
          • 2.3.1.2.2.2. Ответ на HTTP-запрос
        • 2.3.1.2.3. HTTP-запрос на удаление результата выполнения ранее переданного асинхронного SQL-запроса (метод DELETE)
          • 2.3.1.2.3.1. HTTP-запрос
          • 2.3.1.2.3.2. Ответ на HTTP-запрос
      • 2.3.1.3. Выполнение SQL-РЗ с табличным параметром
        • 2.3.1.3.1. HTTP-запрос выполнения SQL-РЗ с табличным параметром
        • 2.3.1.3.2. HTTP-запрос выполнения SQL-запроса с табличным параметром (с возможностью использования надстроек)
      • 2.3.1.4. Выполнение запроса на получение BLOB по ссылке
        • 2.3.1.4.1. HTTP-запрос (вариант 1)
        • 2.3.1.4.2. HTTP-запрос (вариант 2)
        • 2.3.1.4.3. Ответ на HTTP-запрос
    • 2.3.2. JDBC-интерфейс Агента СМЭВ4 для SQL-запросов к Витринам данных
      • 2.3.2.1. Пример использования JDBC-драйвера в «Kotlin»
      • 2.3.2.2. Коды возврата
    • 2.3.3. REST-интерфейс Агента СМЭВ4 для запросов к REST-сервису ИС Ответчика
      • 2.3.3.1. HTTP-запрос
      • 2.3.3.2. Ответ на HTTP-запрос
  • 2.4. Протокол взаимодействия Агента СМЭВ4 и Витрины Потребителя данных
    • 2.4.1. Перечень топиков брокера сообщений Apache Kafka
  • 2.5. Протокол взаимодействия Агента СМЭВ4 и ИС Ответчика
• 3. Использование СМЭВ4
  • 3.1. SQL-синтаксис
  • 3.2. Выполнение регламентированных SQL-запросов
    • 3.2.1. Правила выполнения
    • 3.2.2. Примеры вызова и преобразования исходного запроса
    • 3.2.3. Выполнение запроса с системным параметром
    • 3.2.4. Выполнение запросов с использованием табличных параметров, передаваемых Потребителем данных для обогащения
      • 3.2.4.1. Запрос с использованием REST-интерфейса
      • 3.2.4.2. Запрос с использованием JDBC-интерфейса
    • 3.2.5. Получение двоичных объектов в результатах запроса
    • 3.2.6. Получение печатной формы в результатах запроса
    • 3.2.7. Выполнение запроса с текстовым поиском
  • 3.3. Выполнение запросов к REST-сервису ИС Ответчика
  • 3.4. Сквозная идентификация запросов
  • 3.5. Лимитирование регламентированных запросов Потребителя к информационным ресурсам Поставщика
    • 3.5.1. Лимиты
    • 3.5.2. Условия для добавления лимитов
    • 3.5.3. Блокировки
    • 3.5.4. Управление лимитами и блокировками
    • 3.5.5. Алгоритм лимитирования
• 4. Приложение А Перечень типовых ошибок и пути их решения
• 5. Термины и сокращения
• 6. История изменений