Формат руководства пользователя ВС СМЭВ 3

Наименование ОГВ-Разработчика формата вида сведений
РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ
ВИДА СВЕДЕНИЙ В ЕДИНОЙ СИСТЕМЕ
МЕЖВЕДОМСТВЕННОГО ЭЛЕКТРОННОГО
ВЗАИМОДЕЙСТВИЯ
Сведение «Наименование вида сведений»
ID вида сведений в ФРГУ
Дата: XX.XX.XXXX
Версия: X.X
1
АННОТАЦИЯ
Данный документ является шаблоном руководства пользователя вида
сведений СМЭВ, которое в соответствии с пунктом 48 приказа Министерства
связи и массовых коммуникаций Российской Федерации от 27.12.2010 № 190
«Об
утверждении
технических
требований
к
взаимодействию
информационных систем в единой системе межведомственного электронного
взаимодействия» является обязательным для предоставления поставщиком в
адрес оператора СМЭВ.
Инструкция по использованию:
•
Текст, выделенный курсивом, является примером заполнения
раздела, либо является руководством по заполнению разделов шаблона и при
формировании документа должен быть удален.
•
Текст без специальных выделений является обязательным для
использования в документе и не подлежит удалению.
Заполнение разделов необходимо выполнять согласно приведенной
инструкции. Полное и корректное заполнение разделов позволит избежать
многоитерационной процедуры редактирования документа. Предоставленные
сведения необходимы потребителям информации для успешной интеграции с
видом сведений и оператору СМЭВ для организации эффективной
эксплуатации вида сведений и поддержки его работоспособности.
Заполнение шаблона при разработке вида сведений СМЭВ по ранее
утвержденному формату
На момент подачи на регистрацию разработанного вида сведений
поставщик обязан заполнить полностью все разделы документа.
В момент подачи на регистрацию в СМЭВ вида сведений поставщика,
подготовленное руководство пользователя предоставляется оператору СМЭВ
в zip-архиве специальной структуры, содержащем помимо данного
руководства:
– заявку на регистрацию вида сведений;
– XSD-схема(ы) вида сведений, если схема вида сведений содержит
вложенные схемы, необходимо предоставлять zip-архив, со следующей
структурой: в корневой папке находится целевая схема и папка, в этой папке –
все импортируемые схемы;
– эталонный(е) запрос(ы) и ответ(ы), эталонные запросы и ответы для
вида сведений необходимо именовать Request.xml и Response.xml
соответственно (если эталонных запросов и ответов не одна пара, а несколько,
тогда они должны быть заархивированы в zip-архив, причем каждая пара
запрос-ответ в отдельной папке):
– описание тестового сценария и XSL-схема(ы) тестового(ых)
сценария(ев).
Формат zip-архива должен быть следующей структуры:
\Руководство пользователя
2
\Заявка на регистрацию вида сведений
\Схема.zip
\Эталоны.zip
\Тестовый сценарий.zip
3
СОДЕРЖАНИЕ
Содержание
ОБЩИЕ СВЕДЕНИЯ ............................................................................................................. 6
1.1. Руководящие документы ................................................................................................. 6
1.2. Описание вида сведения ................................................................................................. 6
2. СХЕМА ВИДА СВЕДЕНИЙ И ЭТАЛОННЫЕ ЗАПРОСЫ И ОТВЕТЫ ......................... 7
2.1.
Схема вида сведений ................................................................................................... 7
1.
2.2.
Эталонные запросы и ответы ...................................................................................... 7
3. ТЕСТОВЫЕ СЦЕНАРИИ ...................................................................................................... 8
3.1.
Тестовый сценарий ...................................................................................................... 8
4. СОСТАВ ПЕРЕДАВАЕМОЙ ИНФОРМАЦИИ .................................................................. 9
4.1.
Описание полей запроса .............................................................................................. 9
4.2.
Описание полей ответа на запрос .............................................................................. 9
4.3.
Описание комплексных типов полей (при наличии) ................................................ 9
4.4.
Описание проверок запроса на стороне поставщика.............................................. 10
4.5.
Описание кодов возвратов при ошибках и неуспешных проверок ....................... 10
4.6.
Описание вложений ..................................................................................................... 8
5.
ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ ............................................................................ 11
5.1. Состав справочной информации .................................................................................. 11
5.2. Контактная информация ............................................................................................... 11
5.3. Примечания .................................................................................................................... 11
4
ИЗМЕНЕНИЯ
Версия
Дата
Автор
Изменения
ТЕРМИНЫ/СОКРАЩЕНИЯ
Термин/сокращение
Описание
СМЭВ
Система межведомственного электронного взаимодействия
Поставщик
Организация – владелец вида сведений
WSDL
Web Services Description Language — язык описания вебсервисов.
XSD
XML Schema definition - язык описания структуры XML
документа.
SOAP
Simple Object Access Protocol - протокол обмена
структурированными сообщениями в распределённой
вычислительной среде.
XML
extensible Markup Language — расширяемый язык разметки.
5
1.
ОБЩИЕ СВЕДЕНИЯ
1.1. Руководящие документы
Описание НПА, в соответствии и во исполнение которых разработан формат вида
сведений.
1.2. Описание вида сведения
Наименование
Наименование вида сведений
ID вида
сведений в
ФРГУ
Идентификатор вида сведений в Федеральном реестре государственных
и муниципальных услуг
Содержание
Краткое описание передаваемой информации
Поставщик
Наименование поставщика вида сведений
Потребители
Наименование потребителя/ей вида сведений (возможно использование
категорий потребителей)
Назначение
Краткое описание назначения данного вида сведений
Область
применения
Государственные услуги/государственные функции/обеспечивающие
взаимодействие/
Тип запроса
Запрос или рассылка
Фиксированная или табличная
Тип
маршрутизации
Версия ВС*
Версия вида сведений (формат X.Y.Z)
Версия МР
Версия Методических рекомендаций по работе в Единой системе
межведомственного электронного взаимодействия, в соответствии с
которой разработан формат вида сведений
*Примечание: при разработке новой версии ВС в новой версии руководства пользователя
обязательно необходимо отмечать (с комментариями) по тексту руководства сделанные
изменения XSD-схем, XML-сообщений, тестовых сценариев и т.д.
6
2. СХЕМА ВИДА СВЕДЕНИЙ И ЭТАЛОННЫЕ
ЗАПРОСЫ И ОТВЕТЫ
2.1 Схема вида сведений
Основная схема «название.xsd»:
Текст схемы
Примечание: если схема содержит импортированные схемы, их текст также необходимо
указывать отдельно.
Импортированная схема «название.xsd»:
Текст схемы
Примечание: указывается при наличии; если таких схем несколько, тогда необходимо
указывать их все.
2.2 Эталонные запросы и ответы
Эталонный запрос:
Текст запроса
Эталонный ответ:
Текст запроса
Примечание: указывается не полный конверт, а часть бизнес-данных запроса и ответа; если
у вида сведений существует несколько пар эталонных запросов и ответов, тогда
необходимо указывать их все, причем в связке запрос–ответ.
7
3.
ТЕСТОВЫЕ СЦЕНАРИИ
3.1 Тестовый сценарий
Наименование сценария
Идентификатор сценария (xpath)
Идентификатор сценария (xpath)
Пространство имен, используемое в xpath
Пространство имен используемое в xpath
Примечание: если у вида сведений несколько тестовых сценариев, необходимо указывать
каждый сценарий в отдельном пункте.
Наименование XSL-файла, используемого для генерации автоматического ответа в
данном сценарии.
Текст XSL-файла
Контрольные примеры
Контроль
Идентификатор
ный
контрольного
пример
примера (xpath)
КП 1
Идентификатор
контрольного
примера (xpath)
КП N
Идентификатор
контрольного
примера (xpath)
Пространство имен,
используемое в xpath
Пространство имен,
используемое в xpath
Пространство имен,
используемое в xpath
8
XSL файл для
сценария
Наименование XSLфайла
4.
СОСТАВ ПЕРЕДАВАЕМОЙ ИНФОРМАЦИИ
4.1 Описание полей запроса
№
1
Код
поля
Код
поля в
XSDсхеме
Описание поля
Описание
информации,
передаваемой в
поле
Требования к
заполнению
Описание
требований к
содержанию поля
Способ
заполнения/ Комментарий
Тип
Описание
типа
заполнения
При
необходимост
и указывается
дополнительна
я информация
4.2 Описание полей ответа на запрос
№
1
Код
поля
Код
поля в
XSDсхеме
Описание поля
Описание
информации,
передаваемой в
поле
Требования к
заполнению
Описание
требований к
содержанию поля
Способ
заполнения/ Комментарий
Тип
Описание
типа
заполнения
При
необходимост
и указывается
дополнительна
я информация
4.3 Описание комплексных типов полей (при наличии)
№
1
Код
поля
Код
поля в
XSDсхеме
Описание поля
Описание
информации,
передаваемой в
поле
Требования к
заполнению
Описание
требований к
содержанию поля
9
Способ
заполнения/ Комментарий
Тип
Описание
типа
заполнения
При
необходимост
и указывается
дополнительна
я информация
4.4 Описание проверок запроса на стороне поставщика
Местопо
№ ложение
поля
1
Код
поля
Технолог Код
ические поля
поля
СМЭВ/Б
изнес
поля
запроса/
блок ЭП
Проверка
Описание процедуры
проверки
4.5 Описание кодов
неуспешных проверок
№
1
Код
поля
Код
поля
Результат проверки Комментарий
возвратов
Значение поля
Описание значения,
содержащегося в
поле
Описание
возможных
результатов
проверки и
соответствующих
ответов сервиса
при
При
необходимост
и указывается
дополнительна
я информация
ошибках
и
Причина
Комментарий
Описание причины возникновения
ошибки/отказа в предоставлении
сведений
При
необходимост
и указывается
дополнительна
я информация
Примечание: обязательно должны в явном виде присутствовать коды мотивированного
отказа в предоставлении сведений по причинам:
а) Отсутствия запрашиваемой информации
б) Отказа в предоставлении доступа к запрашиваемой информации
4.6 Описание вложений
Если формат вида сведения подразумевает наличие вложений, то необходимо в
данном разделе описать требования по формату файлов и ограничение по объему к
вложениям, но с учетом ограничения СМЭВ: суммарный объем файлов, передаваемых
одним сообщением не должен превышать 1 Гб.
10
5.
ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ
5.1 Состав справочной информации
Перечень используемых справочников*
*Примечание: все используемые справочники необходимо вносить в Единую систему
нормативно справочной информации (ЕСНСИ).
При отсутствии справочников, владельцем которых не является разработчик
формата вида сведения, в ЕСНСИ, необходимо давать прямую отсылку на ресурс где
опубликован справочник и размещать актуальную версию с обязательным указанием даты
в приложении к руководству пользователя.
5.2 Контактная информация
Контактные данные представителя разработчика формата вида сведений для
обращения пользователей в случае возникновения вопросов*
*Примечание: заполнение контактной информации обязательно только в случае отсутствия
разработчика формата вида сведения в Ситуационном центре электронного правительства
(СЦ). В случае, когда разработчик формата вида сведения, подключен к СЦ,
предоставление иной контактной информации является добровольным.
5.3 Примечания
Иные сведения, которые необходимы потребителям и поставщикам вида сведения.
11