В Личном кабинете участника взаимодействия реализована функция автоматизированного формирования руководства пользователя версии ВС, именуемая Проектирование РП версии вида сведений.
Она доступна пользователям с ролями в ЛК УВ:
-
Представитель УВ;
-
Представитель разработчика.
Функция Проектирование РП версии вида сведений доступна из Карточки версии вида сведений (Рисунок 1), а также является составной частью функции Переноса версии вида сведений в тестовую и продуктивную среды СМЭВ.
Для автоматизированной генерации Руководства пользователя версии ВС используются сведения, которые пользователь ЛК УВ вводил в процессе прохождения шагов мастера визарда:
-
Добавление вида сведений;
- Перенос версии ВС из среды разработки СМЭВ в тестовый и продуктивный среды СМЭВ
- Добавление критерия доступа;
- Добавление версии вида сведений.
Из процессов Добавления вида сведения и Добавление версии вида сведений в руководство пользователя попадают следующие данные:
- Наименование вида сведения (Раздел 1.2 РП);
- Назначение вида сведений (Раздел 1.2 РП);
- Область применения вида сведений (Раздел 1.2 РП);
- Владелец вида сведений (Раздел 1.2 РП);
- Режим сеанса обмена (Раздел 1.2 РП);
- Тип маршрутизации (Раздел 1.2 РП);
- XSD схема (основная и дополнительные при наличии) (Раздел 2.1 РП);
- Описание полей запроса (Раздел 4.1 РП);
- Описание полей ответа (Раздел 4.2 РП);
- Описание комплексных полей (Раздел 4.3 РП).
Из процесса Перенос версии ВС из среды разработки СМЭВ в тестовый и продуктивный среды СМЭВ в руководство пользователя попадают следующие данные:
-
Руководящие документы (Раздел 1.1 РП);
- Эталонные запросы и ответы (Раздел 2.2 РП);
- Описание проверок запроса на стороне поставщика (Раздел 4.4 РП);
- Описание кодов возвратов при ошибках и неуспешных проверках (Раздел 4.5 РП);
- Состав справочной информации (Раздел 5.1 РП);
- Контактная информация (Раздел 5.2 РП).
Из процесса Добавление критерия доступа в руководство пользователя попадают следующие данные:
- Ответчики или Издатели (Раздел 1.2 РП);
- Инициаторы или Подписчики (Раздел 1.2 РП).
Пожалуйста, посмотрите короткое видео или ознакомьтесь с текстом ниже.
Рассмотрим вариант проектирования руководства пользователя на примере отдельной функции из карточки версии ВС (все описанные шаги также присутствуют в ходе переноса версии вида сведений в тестовую и продуктивную среды):
1. Выбрать действие Спроектировать руководство пользователя в карточке версии ВС (Рисунок 1).
Рисунок 1 - Запуск визарда проектирования руководства пользователя.
2. Добавить описание руководящих документов - нормативно-правовых актов, в соответствии и во исполнение которых разработан формат вида сведений.
Рисунок 2 - Форма шага добавления руководящих документов.
Данный шаг является обязательным. В поле можно внести сразу несколько наименований руководящих документов.3. Далее добавить описание проверок на стороне поставщика, если таковые проводятся (Рисунок 3).
Рисунок 3 - Форма шага добавления описания проверок на стороне системы ответчика.
Здесь вводятся наименование технологических полей СМЭВ, бизнес полей запроса или блока электронной подписи, которые подвергаются проверке, а также описание результата данной проверки. Если проверок на стороне ответчика несколько, кнопка Добавить описание проверки, открывает на форме атрибуты для описания проверки 2 и т.д.
Шаг не является обязательным, если проверки не проводятся, можно нажать на надпись Пропустить шаг.
4. Далее необходимо заполнить коды возвратов (Рисунок 4).
Код возврата представляет из себя код статуса, направляемого в случае отказа в предоставлении сведений.
Рисунок 4 - Форма шага добавления описания кодов возвратов.
Здесь можно указать сам код, его значение, описание причины отказа и комментарий в случае необходимости.
При необходимости доступна возможность добавления нескольких описаний кодов возврата. Кнопка Добавить код возврата, открывает на форме атрибуты для Кода возврата 2 и т.д.
Если коды возврата отсутствуют шаг можно пропустить, нажав на кнопку Пропустить шаг.
5. После добавляются используемые справочники (Рисунок 5). А именно код и наименование справочника и ресурс, на котором он размещен.
Рисунок 5 - Форма шага добавления справочной информации.
Если используется несколько справочников, можно добавить дополнительный, используя кнопку Добавить справочник.
В случае отсутствия в версии ВС используемых справочников, шаг можно пропустить, нажав на кнопку Пропустить шаг.
6. Далее необходимо указать информацию об используемых вложениях в версии ВС (Рисунок 6).
Рисунок 6 - Форма шага указания информацию о передаваемых вложениях.
Шаг также заполняется в случае использования вложений. В противном случае пропускается.
Здесь потребуется указать:
-
краткое наименование вложения;
-
корневой элемент, по которому будет передаваться вложение;
-
тип вложения, который можно выбрать из выпадающего списка;
-
способ передачи (внутри сообщения МТОМ или через файловое хранилище СМЭВ по ftp);
-
размер вложения, который выбирается из списка диапазонов (для МТОМ возможно только до 5МБ);
А также отметить, является ли вложение структурированным, архивом, имеет ли обязательный признак.
При необходимости добавления информации о дополнительном вложении, нажать на кнопку Добавить вложение.
7. На следующем шаге потребуется внести контактную информацию представителей разработчика версии ВС (Рисунок 7). Данные контакты необходимы для обращения участников в случае возникновения вопросов.
Рисунок 7 - Форма шага добавления контактной информации.
Шаг не является обязательным только в том случае, если разработчик ВС подключен к Ситуационному Центру.
Внимание! Предоставление персональных данных приравнивается к согласию на передачу и обработку по 152-ФЗ.
8. Далее необходимо загрузить приложение к руководству пользователя, если таковое имеется (Рисунок 8).
Рисунок 8 - Форма шага загрузки приложения к руководству пользователя.
Если приложение отсутствует шаг можно пропустить, нажав на одноименную кнопку.
9. В итоговом окне будут указаны введенные параметры. Здесь необходимо подтвердить генерацию руководства пользователя, нажав на кнопку Да, уверен (Рисунок 9).
Рисунок 9 - Форма шага подтверждения генерации руководства пользователя.
Кнопка Нет, отменить действие ведет к закрытие визарда и переходу на главную страницу без сохранения введенных данных.
После автоматизированного формирования Руководства пользователя версии ВС документ будет доступен для скачивания и редактирования в карточке версии ВС (Рисунок 10).
Рисунок 10 - Карточка версии ВС со сгенерированным Руководством пользователя.