Кнопки действий с заявлением

Оглавление

• Термины и сокращения
• Общая информация
• Интерфейс СТА на портале ЕПГУ
• Интерфейс СТА в МП «Госуслуги»
• Настройка СТА на портале ЕПГУ
• Настройка СТА «Простые действия»
• Настройка СТА «Простые действия» в МП «Госуслуги»
• Настройка СТА «Проактивное создание заявлений»
• Настройка СТА «Шаблонизируемые действия»

Термины и сокращения

Термин/сокращение	Определение
ЕПГУ	Федеральная государственная информационная система «Единый портал государственных и муниципальных услуг (функций)»
ЛК	Личный кабинет пользователя с деталями заявления на портале ЕПГУ или в мобильном приложении «Госуслуги»
МП	Мобильное приложение
МП «Госуслуги»	Мобильные приложения «Госуслуги» – набор независимых мобильных приложений для операционных систем iOS и Android, разработанных с использованием нативных средств разработки. Мобильные приложения «Госуслуги» имеют идентичную функциональность, осуществляющих взаимодействие мобильных устройств пользователя с инфраструктурой электронного правительства и предоставляющих пользователю возможность использовать наиболее популярную функциональность ЕПГУ для ФЛ, с оптимизированным для каждой ОС пользовательским интерфейсом
API	Application programming interface (программный интерфейс приложения, интерфейс прикладного программирования) – набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) или операционной системой для использования во внешних программных продуктах
CTA	Call to action (призыв к действию)
HTTP	Сетевой протокол прикладного уровня передачи данных (от англ. HyperText Transfer Protocol)
REST	Архитектурный стиль взаимодействия компонентов распределённого приложения в сети. Архитектурный стиль – это набор согласованных ограничений и принципов проектирования, позволяющий добиться определённых свойств системы
REST-сервис	Архитектурный стиль взаимодействия компонентов распределенного приложения в сети
REST API	REST API – репрезентативная передача состояния (REST) – это архитектурный стиль, который осуществляет реализацию клиента и сервера независимо друг от друга. Сервисы в REST API взаимодействуют по протоколу HTTP
URL	Uniform Resource Locator (единый указатель ресурса) – стандартизированный способ записи адреса ресурса в сети Интернет

Общая информация

CTA (Call to Action, переводится как «призыв к действию») — это функциональность ЕПГУ, которая призывает настроить условия для отображения и содержание кнопок в ЛК пользователя в деталях заявления. Кнопки позволяют пользователю ЕПГУ выполнять действия с заявлением в соответствии с установленными настройками CTA. К примеру, при нажатии на кнопку пользователь может к перейти по ссылке или выполнить действие с заявлением через REST запрос

Интерфейс СТА на портале ЕПГУ

Блок СТА, отображаемый в деталях заявления, может состоять из:

• заголовка (опционально)
• описания (опционально)
• кнопок (не более 3)

При нажатии на кнопку CTA возможен один из следующих вариантов действия:

• переход по ссылке
• отправка REST API запроса для действий с заявлением

Если кнопка СТА содержит настройки для перехода по ссылке, то при нажатии кнопку пользователя перенаправляет на сконфигурированную ссылку

Если кнопка СТА содержит настройки для отправки REST API запроса, то возможна мгновенная отправка запроса без подтверждения в модальном окне, либо происходит отображение модального окна для подтверждения действия, которое содержит следующие элементы:

• заголовок (опционально)
• описание
• кнопку подтверждения
• кнопку отмены

В случае, если возникла ошибка при отправке REST API запроса, то пользователю будет отображено модальное окно с ошибкой. Модальное окно содержит следующие элементы:

• заголовок ошибки (опционально)
• описание ошибки
• кнопку закрытия модального окна

Интерфейс СТА в МП «Госуслуги»

Блок СТА, отображаемый в деталях заявления МП «Госуслуги», может состоять из:

• заголовка (опционально)
• описания (опционально)
• подсказки, которая отображается при нажатии на элемент «подробнее» (опционально)
• кнопок (не более 3)

При нажатии на кнопку СТА в МП «Госуслуги» возможен один из следующих вариантов действия:

• переход по ссылке
• отправка REST API запроса

Если кнопка СТА содержит переход по ссылке, то при нажатии кнопку происходит простой переход по ссылке

Если при нажатии на кнопку СТА происходит отправка REST API запроса, то возможна мгновенная отправка запроса без подтверждения действия от пользователя

В случае, если требуется подтверждение действия пользователя перед отправкой REST API запроса, то происходит отображение модального окна для подтверждения действия, которое содержит следующие элементы:

• заголовок
• описание
• кнопку подтверждения
• кнопку отмены

После успешной отправке и выполнения REST API запроса в МП «Госуслуги» происходит одно из доступных действий:

• обновление экрана
• переход на экран, содержащий кнопку с перенаправлением пользователя по ссылке из ответа REST API запроса

Если происходит обновление экрана, то в МП «Госуслуги» будет отображено всплывающее сообщение с текстом об успешной отправке REST API запроса

При переходе на экран, содержащий кнопку с перенаправлением пользователя по ссылке из ответа REST API запроса, происходит отображение экрана, который содержит:

• заголовок (опционально)
• описание окна
• кнопку для перехода по ссылке из ответа REST API запроса

В случае, если возникла ошибка при отправке REST API запроса, то в МП «Госуслуги» будет отображено всплывающее сообщение с описанием ошибки

Настройка СТА на портале ЕПГУ

Для дальнейшего осуществления настройки CTA в ВКУ в разделе «Настройки услуги» необходимо перейти во вкладку «Кнопки действий с заявлением»

Возможна настройка трёх видов СТА:

1. Простые действия. Данная настройка доступна в режиме разработчика. Предоставляет возможность настроить СТА, которые будут зависеть от статусов заявления по услуге без дополнительных условий
2. Проактивное создание заявлений. Данная настройка доступна предоставляет возможность настроить СТА, связанные с комплексной услугой с последовательным оказанием услуг
3. Шаблонизирумые действия. Данная настройка доступна в режиме разработчика. Предоставляет возможность настроить СТА, которые будут зависеть от статусов заявления и условий, указанных в FTL-шаблоне

Настройка СТА «Простые действия»

Для добавления и возможности дальнейшей настройки CTA необходимо нажать на элемент «Добавить элемент»

После добавления элемента появляется блок с настройками CTA. На каждый отдельный CTA требуется добавлять отдельный элемент

В основных полях блока с настройками СТА необходимо заполнить следующее:

Наименование поля	Описание
Наименование действия	В данном поле записывается внутреннее наименование СТА, которое не отображается пользователю
Портальные статусы, на которых будут отображаться кнопки	В данном поле устанавливаются портальные статусы в которых будет отображаться CTA. Отображение одного и того же блока CTA можно настроить для нескольких портальных статусов Важно! Если на одну и ту же услугу требуется настроить разные кнопки на разных статусах, то для каждой новой кнопки необходимо конфигурировать новый блок CTA, который будет привязываться к статусу
Заголовок	Заголовок, отображаемый в блоке СТА на портале ЕПГУ
Описание	Текст с описанием, отображаемый в блоке СТА на портале ЕПГУ
Настроить содержимое блока для мобильного приложения «Госуслуги»	Данная настройка определяет необходимость отображения блока СТА в МП «Госуслуги». По умолчанию блок СТА не отображается в МП «Госуслуги». При выборе чек-бокса отображается блок с настройками СТА в МП «Госуслуги»

После добавления основных настроек необходимо добавить кнопки. Добавление кнопок осуществляется в блоке «Добавить кнопки» по нажатию на элемент «Добавить элемент». Максимальное количество кнопок, доступное для добавления в блок СТА, составляет 3 кнопки. После добавления элемента появляется блок с настройкой кнопок. Для каждой кнопки требуется добавлять отдельный элемент

В основных полях блока «Добавить кнопки» необходимо заполнить следующие поля:

Наименование поля	Описание
Выбор действия	Данная настройка определяет тип действия, которое будет происходить при нажатии на кнопку в СТА на портале ЕПГУ. Доступны два вида действия: «Перейти по ссылке» «Отправить REST запрос»
Текст на кнопке	Текст, отображаемый на кнопке блока СТА на портале ЕПГУ. Возможны следующие варианты: Вернуть на доработку Добавить Записаться Заполнить Изменить Исправить Обжаловать Открыть Отменить Отозвать Отправить Перейти Подписать Продолжить Создать
Хост	Настройка, содержащая доменное имя хоста, куда будет осуществлён переход по ссылке или отправлен REST API запрос. Если необходимое доменное имя хоста отсутствует в выпадающем списке, то необходимо выбрать значение «Нет в списке» и указать хост в ручном режиме без параметров
Хост не из списка	Доменное имя хоста, задаваемое в ручном режиме в формате структуры полного доменного имени, включающий в себя все необходимые уровни. Можно задать значение находящееся в «белом листе». При необходимости добавления нового значения в конфигурацию необходимо согласовывать с ИБ. В случае отсутствия конфигурации в «белом листе» будет возвращена ошибка 409
Путь и параметры URL без хоста	Настройка, настраивающая URL-путь без учёта хоста, включающий в себя query-параметры запроса
Настроить для мобильного приложения «Госуслуги»	Данная настройка определяет необходимость настроек кнопок блока СТА в МП «Госуслуги» Необходимо заполнять если СТА требуется отображать в МП «Госуслуги»

В случае если установлено действие «Отправить REST запрос», то будут отображены дополнительные поля для настройки данного действия

Для настройки вида действия «Отправить REST запрос» необходимо заполнить следующие поля:

Наименование поля	Описание
Тип REST запроса	Данная настройка определяет тип HTTP-метода REST API запроса. Возможны следующие типы: POST — создание ресурса GET — получение ресурса PUT — обновление ресурса
Тело запроса	Настройка позволяет заполнить тело, передаваемое в HTTP-методе REST API запроса. Не требуется заполнять при GET запросе
Показывать модальное окно для подтверждения действия	Настройка, определяющая необходимость отображения модального окна для подтверждения действия пользователя при нажатии на кнопку в блоке СТА на портале ЕПГУ
Заголовок ошибки	Заголовок, отображаемый в модальном окне при возникновении ошибки при осуществлении REST API запроса
Текст ошибки	Текст ошибки, отображаемый в модальном окне при возникновении ошибки при осуществлении REST API запроса

При необходимости подтверждения действия пользователя при нажатии на кнопку в блоке СТА на портале ЕПГУ требуется осуществить настройку модального окна

Для настройки модального окна на портале ЕПГУ необходимо заполнить следующие поля:

Наименование поля	Описание
Заголовок	Заголовок, отображаемый в модальном окне для подтверждения действия пользователем
Описание	Текстовое описание, отображаемое в модальном окне для подтверждения действия пользователем
Текст на кнопке подтверждения	Текст, отображаемый на кнопке подтверждения в модальном окне для подтверждения действия пользователем. Возможны следующие варианты: Добавить Записаться Заполнить Изменить Исправить Обжаловать Открыть Отправить Подписать Продолжить
Текст на кнопке отмены	Текст, отображаемый на кнопке отмены в модальном окне для подтверждения действия пользователем. Всегда имеет настройку «Закрыть»

Настройка СТА «Простые действия» в МП «Госуслуги»

В случае необходимости настройки СТА в МП «Госуслуги» требуется выбрать соответствующий чек-бокс и настроить содержимое блока для мобильного приложения «Госуслуги»

Важно: если не настраивать кнопки СTA в МП «Госуслуги», то кнопки будут отображаться только на портале ЕПГУ. Также, через спецификацию нельзя настроить отображение кнопок CTA в МП «Госуслуги» без настройки для портала ЕПГУ

Для осуществления настройки блока СТА в МП «Госуслуги» необходимо заполнить следующие поля:

Наименование поля	Описание
Заголовок	Заголовок, отображаемый в блоке СТА в МП «Госуслуги»
Описание	Текст с описанием, отображаемый в блоке СТА в МП «Госуслуги»
Подсказка	Текста подсказки, отображаемый в всплывающем окне в МП «Госуслуги» при нажатии на элемент «подробнее»

Далее требуется настроить кнопки для отображения в блоке СТА в МП «Госуслуги». Количество кнопок в блоке СТА портала ЕПГУ и МП «Госуслуги» должно совпадать, так как настройка производится в одних общих блоках «Добавить кнопки». По умолчанию первая кнопка в блоке СТА МП «Госуслуги» всегда будет синего цвета, так как это должна быть кнопка с основным действием. Последующие кнопки в CTA блока должны реализовывать дополнительную или альтернативную логику, по умолчанию они всегда будут белого цвета

Для настроек кнопок в МП «Госуслуги» необходимо заполнить следующие поля:

Наименование поля	Описание
Выбор действия	Данная настройка определяет тип действия, которое будет происходить при нажатии на кнопку в СТА в МП «Госуслуги». Доступны два вида действия: «Перейти по ссылке» «Отправить REST запрос»
Текст на кнопке	Текст, отображаемый на кнопке блока СТА в МП «Госуслуги». Возможны следующие варианты: Вернуть на доработку Добавить Записаться Заполнить Изменить Исправить Обжаловать Открыть Отменить Отозвать Отправить Перейти Подписать Продолжить Создать
Кнопка для «негативного» сценария	Чек-бокс для изменения цвета текста на кнопке. При включенном состоянии делает текст кнопки красным. Данная настройка не предназначена для первой кнопки в блоке СТА МП «Госуслуги». Необходимо использовать только для второй или третьей кнопки
Хост	Настройка, содержащая доменное имя хоста, куда будет осуществлён переход по ссылке или отправлен REST API запрос. Если необходимое доменное имя хоста отсутствует в выпадающем списке, то необходимо выбрать значение «Нет в списке» и указать хост в ручном режиме
Хост не из списка	Доменное имя хоста, задаваемое в ручном режиме в формате структуры полного доменного имени, включающий в себя все необходимые уровни
Путь и параметры URL без хоста	Настройка, настраивающая URL-путь, включающий в себя query-параметры запроса

В случае если установлено действие «Отправить REST запрос», то будут отображены дополнительные поля для настройки данного действия в МП «Госуслуги»

Для настройки вида действия «Отправить REST запрос» необходимо заполнить следующие поля:

Наименование поля	Описание
Тип REST запроса	Данная настройка определяет тип HTTP-метода REST API запроса. Возможны следующие типы: POST — создание ресурса GET — получение ресурса PUT — обновление ресурса
Тело запроса	Настройка позволяет заполнить тело, передаваемое в HTTP-методе REST API запроса. Не требуется заполнять при GET запросе
Показывать модальное окно для подтверждения действия	Настройка, определяющая необходимость отображения модального окна для подтверждения действия пользователя при нажатии на кнопку в блоке СТА в МП «Госуслуги»
После успешного выполнения запроса	Действие после успешного выполнения REST API запроса. Возможны следующие виды действий: «Обновить экран» «Перенаправить пользователя по ссылке из REST ответа» При выборе действия «Обновить экран» после успешной отправки REST API запроса будет обновлён экран в МП «Госуслуги» с отображением всплывающего сообщения с текстом об успешной отправке REST API запроса При выборе действия «Перенаправить пользователя по ссылке из REST ответа» будет отображён экран с кнопкой для перехода по ссылке из ответа REST API запроса
Заголовок	Опциональное поле при выборе вида действия «Перенаправить пользователя по ссылке из REST ответа». Позволяет настроить заголовок, отображаемый на экране с кнопкой для перехода по ссылке из ответа REST API запроса
Описание окна	Текст, отображаемый во всплывающем сообщении об успешной отправке REST API запроса, или текст, отображаемый на экране с кнопкой для перехода по ссылке из ответа REST API запроса
Описание ошибки	Текст ошибки, отображаемый в всплывающем сообщении с описанием ошибки при выполнении REST API запроса

При необходимости подтверждения действия пользователя при нажатии на кнопку в блоке СТА в МП «Госуслуги» требуется осуществить настройку модального окна

Для настройки модального окна в МП «Госуслуги» необходимо заполнить следующие поля:

Наименование поля	Описание
Заголовок	Заголовок, отображаемый в модальном окне для подтверждения действия пользователем
Описание	Текстовое описание, отображаемое в модальном окне для подтверждения действия пользователем
Текст на кнопке подтверждения	Текст, отображаемый на кнопке подтверждения в модальном окне для подтверждения действия пользователем. Возможны следующие варианты: Добавить Записаться Заполнить Изменить Исправить Обжаловать Открыть Отправить Подписать Продолжить
Текст на кнопке отмены	Текст, отображаемый на кнопке отмены в модальном окне для подтверждения действия пользователем. Всегда имеет настройку «Закрыть»

Настройка СТА «Проактивное создание заявлений»

Для добавления и возможности дальнейшей настройки CTA необходимо нажать на элемент «Добавить элемент»

После добавления элемента появляется блок с настройками CTA. На каждый отдельный CTA требуется добавлять отдельный элемент

Первоначально необходимо заполнить код услуги дочерних заявлений для отображения основных настроек:

Наименование поля	Описание
Код услуги дочерних заявлений	В данном поле указывается код услуги дочерних заявлений при котором будет отображаться СТА

После заполнения кода услуги дочерних заявлений будут отображены основные настройки СТА.

В основных полях блока с настройками СТА необходимо заполнить следующие поля:

Наименование поля		Описание
Наименование действия		В данном поле записывается внутреннее наименование СТА, которое не отображается пользователю
Портальные статусы, на которых будут отображаться кнопки		В данном поле устанавливаются портальные статусы в которых будет отображаться CTA. Отображение одного и того же блока CTA можно настроить для нескольких портальных статусов Важно: Если на одну и ту же услугу требуется настроить разные кнопки на разных статусах, то для каждой новой кнопки необходимо конфигурировать новый блок CTA, который будет привязываться к статусу
Срок отображения кнопки, дней		В данном поле указывается количество дней, в которое кнопка будет доступна пользователю в текущем статусе. Срок отображения отсчитывается с момента присвоения заявлению последнего актуального статуса. Допустимы целые числа от 1 до 100
Проверять наличие дочерних заявлений		Настройка, определяющая необходимость проверки наличия поданных дочерних заявлений. В случае если проверка вернула положительный результат, то будет отображён альтернативный СТА
Статусы проверяемые в дочерних заявлениях		Данная настройка позволяет задать проверяемые статусы дочерних заявлений. Если настройка не задана, то будет проверяться наличие дочерних заявлений в 3 статусе или в не финальных статусах
Описание действия
	Заголовок	Заголовок, отображаемый в блоке СТА на портале ЕПГУ
	Текст	Текст с описанием, отображаемый в блоке СТА на портале ЕПГУ
	Текст кнопки	Текст, отображаемый на кнопке блока СТА на портале ЕПГУ. Возможны следующие варианты: Вернуть на доработку Добавить Записаться Заполнить Изменить Исправить Обжаловать Открыть Отменить Отозвать Отправить Перейти Подписать Продолжить Создать
	Текст в модальном окне при возникновении ошибки	Текст ошибки, отображаемый в модальном окне при возникновении ошибки при осуществлении REST API запроса
Альтернативное описание действия в случае наличия дочерних заявлений
	Заголовок	Заголовок, отображаемый в блоке СТА на портале ЕПГУ при наличии поданных дочерних заявлениях
	Текст	Текст с описанием, отображаемый в блоке СТА на портале ЕПГУ при наличии поданных дочерних заявлениях
	Текст кнопки	Текст, отображаемый на кнопке блока СТА на портале ЕПГУ при наличии поданных дочерних заявлениях. Возможны следующие варианты: Вернуть на доработку Добавить Записаться Заполнить Изменить Исправить Обжаловать Открыть Отменить Отозвать Отправить Перейти Подписать Продолжить Создать
	Хост	Настройка, содержащая доменное имя хоста, куда будет осуществлен переход по ссылке
	Путь и параметры URL без хоста	Настройка, настраивающая URL-путь без учета хоста, включающий в себя query-параметры запроса

Настройка СТА «Шаблонизируемые действия»

Для добавления и возможности дальнейшей настройки CTA необходимо нажать на элемент «Добавить элемент»

После добавления элемента появляется блок с настройками CTA. На каждый отдельный CTA требуется добавлять отдельный элемент

В основных полях блока с настройками СТА необходимо заполнить следующие поля:

Наименование поля	Описание
Наименование действия	В данном поле записывается внутреннее наименование СТА, которое не отображается пользователю
Портальные статусы, на которых будут отображаться кнопки	В данном поле устанавливаются портальные статусы в которых будет отображаться CTA. Отображение одного и того же блока CTA можно настроить для нескольких портальных статусов Важно: Если на одну и ту же услугу требуется настроить разные кнопки на разных статусах, то для каждой новой кнопки необходимо конфигурировать новый блок CTA, который будет привязываться к статусу
FTL-шаблон конфигурации	В данном поле указывается FTL-шаблон, на основании условий которого будет сконфигурирован и отображён СТА