СМЭВ4
Руководство администратора Агента СМЭВ4
Руководство администратора Агента СМЭВ4
1. Введение
1.1. Область применения
1.2. Краткое описание возможностей
1.3. Уровень подготовки пользователя
1.4. Перечень документации для работы с СМЭВ4
2. Назначение и условия применения
2.1. Назначение
2.2. Требования к среде для развертывания Агента СМЭВ4
2.2.1. Минимальные требования к серверу
2.2.2. Перечень коммерческого ПО третьих лиц, необходимого для работы Агент СМЭВ4
2.2.3. СКЗИ для работы Агента СМЭВ4
2.3. Точки подключения к Агенту СМЭВ4
3. Настройка и запуск Агента СМЭВ4
3.1. Порядок загрузки данных и программ
3.2. Подготовка и настройка системы для запуска Агента СМЭВ4 без использования Docker
3.2.1. Состав и содержание дистрибутивного пакета
3.2.2. Предварительные операции (установка «пре-реквизитов»)
3.2.3. Запуск Агента СМЭВ4
3.2.4. Проверка работоспособности Агента СМЭВ4 после включения и запуска сервиса
3.2.5. Настройка ротации логов (опционально)
3.3. Настройка логирования в формате «Гостех» (опционально)
3.4. Включение протоколирования тел запросов/ответов с сохранением с БД Clickhouse (опционально)
3.5. Настройка и запуск Агента СМЭВ4 с использованием Docker
3.5.1. Предварительные условия
3.5.2. Настройка ротации лог-файлов в Docker (опционально)
3.5.3. Состав и содержание дистрибутивного пакета
3.5.4. Подготовка к запуску
3.5.5. Запуск Агента СМЭВ4
3.6. Обновление Агента СМЭВ4
3.6.1. Информация по лицензированию CryptoPro
4. Описание конфигурационного файла Агента СМЭВ4
4.1. Состав и содержание файлов конфигурирования
4.2. Реестр изменений файлов конфигурирования
4.3. Формирование конфигурационного файла Агента СМЭВ4
4.3.1. Общие настройки Агента
4.3.2. Настройка ключей CryptoPro
4.3.3. Настройка подключения к Ядру СМЭВ4, в том числе для работы в гео-распределенной конфигурации
4.3.4. Настройка подключения к NTP
4.3.5. Взаимодействие с Витринами данных через Apache Kafka (версия Витрины 1.x)
4.3.6. Взаимодействие с Витринами данных по HTTP (версия Витрины 2.x)
4.3.7. Настройка модуля подписания печатных форм
4.3.8. Настройки разбиения получаемой информации на чанки (опционально)
4.3.9. Настройка организации информационного обмена через API Gateway (опционально)
4.3.10. Настройка параметров времени активации Агента СМЭВ4 (опционально)
4.3.11. Настройка Агента СМЭВ4 для работы в масштабированном варианте (опционально)
4.3.12. Настройка передачи информации аудита в ГосТех (опционально)
4.3.13. Настройка параметров Сервиса проверки полномочий (опционально)
4.3.14. Настройка таймаутов исполнения запросов по умолчанию (опционально)
4.3.15. Настройка сбора метрик Агента СМЭВ4 (опционально)
4.3.16. Переопределение значений портов REST и JDBC интерфейсов Агента СМЭВ4 (опционально)
5. Типовые вопросы и проблемы
6. Приложение A «Список доступных метрик Агента СМЭВ4»
7. Приложение Б «Настройка и Установка Сервиса проверки полномочий Prohibitor» (опционально)
7.1. Описание конфигурационных файлов Сервиса проверки полномочий
7.1.1. Состав и содержание дистрибутивного пакета
7.1.2. Реестр изменений конфигурационного файла
7.2. Настройка и запуск Сервиса проверки полномочий
7.2.1. Порядок загрузки данных и программ
7.2.2. Предварительные операции (установка «пре-реквизитов»)
7.2.3. Настройка БД для работы Сервиса проверки полномочий
7.2.4. Запуск Сервиса проверки полномочий
7.2.5. Формирование конфигурационного файла Сервиса проверки полномочий
7.2.6. Создание пользователя для работы с Сервисом проверки полномочий
7.3. Запуск консольной утилиты TOTP
7.3.1. Порядок загрузки данных и программ
7.3.2. Предварительные операции
7.3.3. Запуск TOTP CLI
7.4. Настройка и запуск Сервиса проверки полномочий с использованием Docker
8. Приложение В «Настройка и Установка Сервиса подписания и верификации сообщений Notarius» (опционально)
8.1. Описание конфигурационных файлов Сервиса подписания и верификации сообщений
8.1.1. Состав и содержание дистрибутивного пакета
8.1.2. Реестр изменений конфигурационного файла
8.2. Настройка и запуск Сервиса подписания и верификации сообщений
8.2.1. Порядок загрузки данных и программ
8.2.2. Предварительные операции (установка «пре-реквизитов»)
8.2.3. Запуск Сервиса подписания и верификации сообщений
8.2.4. Формирование конфигурационного файла Сервиса подписания и верификации сообщений
8.2.5. Настройка ключей CryptoPro CSP
8.2.6. Настройка модуля подписания печатных форм
8.2.7. Настройка порта сервиса приема запросов
8.2.8. Настройка Notarius для передачи метрик в Prometheus
8.3. Настройка и запуск подписания и верификации сообщений с использованием Docker
9. Приложение Г «Настройка и запуск NTP сервера (опционально)»
9.1. Порядок загрузки данных и программ
9.2. Настройка и запуск NTP сервиса БЕЗ использования Docker
9.2.1. Состав и содержание дистрибутивного пакета
9.2.2. Предварительные операции (установка «пре-реквизитов»)
9.2.3. Запуск NTP сервиса
9.3. Настройка и запуск NTP сервиса с использованием Docker
9.3.1. Предварительные условия
9.3.2. Состав и содержание дистрибутивного пакета
9.3.3. Подготовка к запуску
9.3.4. Запуск NTP
10. Приложение Д «Подготовка Docker образов для возможности запуска приложений под Docker (podman)»
10.1. Подготовительные действия
10.2. Создание Docker образов
11. Термины и определения
12. История изменений документа
Методические рекомендации
Методические рекомендации по работе с СМЭВ4
1. Введение
1.1. Общие Сведения
1.1.1. Нормативно-правовые основания
1.2. Виды информационного обмена с использованием СМЭВ
1.2.1. Классификация регламентированных SQL-запросов
1.3. Участники информационного обмена с использованием СМЭВ4
1.4. Информационный обмен участников взаимодействия с использованием СМЭВ4
1.4.1. Обмен с использованием Регламентированных SQL-запросов
1.4.2. Обмен с использованием Рассылок
1.4.3. Обмен с использованием запросов к REST-сервису ИС Ответчика
1.5. Метаданные СМЭВ4
1.5.1. Поддерживаемые форматы
1.5.2. Модель данных Витрины Поставщика данных
1.5.3. Профиль Витрины Поставщика данных
1.5.4. Определения Регламентированных SQL-запросов
1.5.5. Подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка»
1.5.6. 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.2. JDBC-интерфейс Агента СМЭВ4 для SQL-запросов к Витринам данных
2.3.3. REST-интерфейс Агента СМЭВ4 для запросов к REST-сервису ИС Ответчика
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.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. История изменений
Сторонние инструкции
Синтаксис разметки reStructuredText
Базовые концепции
Заголовки
Выделение текста
Нумерованные списки
Маркированные списки
Вложенные списки
Изображения
Вставка изображения
Вставка изображения в тексте
Вставка ссылки на изображение
Ссылки и сноски
Внешние ссылки
Перекресные ссылки
Ссылки на файлы (текстовые и для загрузки)
Cноски
Таблицы
Работа с таблицами
Вставка ссылки на таблицу
Блоки примечаний
Вставка в текст исходного кода (листинг)
Подключение файлов
Комментарии
Важные особенности
Имена файлов в Sphinx
СМЭВ4
<no title>
Просмотреть исходный код страницы
Другие версии
v: 3.23.0
Версии
3.10.0
3.11.0
3.11.1_cert
3.11.2_cert
3.12.0
3.12.1
3.13.0
3.14.0
3.15.0
3.16.0
3.17.0
3.18.0
3.19.0
3.20.0
3.20.1
3.21.0
3.22.0
3.23.0
3.23.4
3.24.0
3.25.0
3.26.0
3.27.0
3.7.0
3.8.0
3.8.0_cert
3.8.1_cert
3.9.0
3.9.1