Войти

Разработка настроечных файлов

  Настроечный файл Адаптера СМЭВ3.х (НФ) позволяет владельцу вида сведений подробно описать аспекты правил отображения и поведения элементов вида сведений в экранных формах веб-интерфейса Адаптера СМЭВ 3.х, предназначенных для просмотра и создания сообщений в СМЭВ. Настроечный файл имеет формат JSON. JSON – это текстовый формат обмена данными, основанный на JavaScript. В Адаптер СМЭВ 3.х НФ загружается в формате *.sf. Так же в архив НФ может входить файл в формате CSS, отвечающий за стили отображаемой формы в Адаптере СМЭВ 3.х.   Список настроечных файлов доступен при переходе на вкладку «Настроечные файлы» карточки вида сведений:

  Настроечный файл можно сгенерировать автоматически по загруженной XSD-схеме. Для этого нажмите "Сгенерировать". Генерация НФ осуществляется строго после настройки сообщений в карточке вида сведений. После генерации НФ находится в состоянии «Не применён». Важно чтобы один НФ из списка имел статус «Применён». Для этого перейдите в необходимый НФ и нажмите "Применить".
Так же сгенерированный НФ можно скачать для ручного редактирования вложенных файлов JSON и CSS.
Файл с расширением .sf можно открыть как архив 7zip. 

Настроечный файл имеет следующую структуру:

Ключ

Тип

Обязательное присутствие

Описание

Условие

version :

string

+

Версия документа

Всегда имеет значение «1.0»

targetNamespace :

string

+

Уникальный идентификатор версии вида сведения

caption

string

Название

description

string

Описание

targetNamespace

string

+

целевое пространство имён

namespace :

object

Префиксы и пространство имён

[prefix]

string

namespace. prefix- префикс

structure :

object

+

Структура отображения

[elementId]

object

elementId - идентификатор элемента

структура зависит от потребностей использования

elements :

object

Элементы

types :

object

Типы

mappers :

object

Мапперы

validation :

object

Валидация с возможностью межреквизитного контроля

string  отображается значения в кавычках “значение”

object  отображается фигурными скобками {}

Боле подробное описание блоков изложено в соответствующей статье. 

Для разработки настроечного файла можно использовать любой текстовый редактор, поддерживающий формат JSON. Детальное описание элементов структуры и применения в настроечном файле см. в разделе «Описание разделов и результаты».

Тестирование настроечных файлов в Адаптере СМЭВ 3.х осуществляется в доступном только для пользователей с ролью «Администратор адаптера», разделе «Инструменты разработчика» (см. «Руководство администратора Адаптера СМЭВ 3.0»).

Инструмент представляет собой функцию загрузки схемы вида сведений XSD, настроечного файла JSON и загрузки файла CSS описывающий стили. На форме отображается отметки о структуре НФ, данных и вложении. Так же есть возможность просмотреть применение НФ в режиме редактирования и просмотра. 

Загрузить настроечный файл в адаптер можно 2-мя способами:

     1. С помощью панели инструментов списка настроечных файлов.

Подготовьте файл .sf. Для этого сгенерируйте архив с Json или Json и css внутри и поменяйте расширение на .sf. Загрузите файл .sf и нажмите "Применить" в карточке НФ.

В дальнейшем пользователи экземпляра адаптера СМЭВ 3.х будут использовать вид сведения с применением правил и аспектов, описанных в выбранном администратором экземпляра адаптера, настроечного файла. 

    2. С помощью Репозитория.

Из карточки версии ВС перейдите на вкладку «Настроечные файлы», выберете нужную версию НФ. Выбор нужного НФ открывает карточку НФ.
На вкладке «Привязанные адаптеры» отображается автоматически формируемый список экземпляров адаптера использующих данный НФ.
Перейдите на вкладку «Доступные адаптеры». Указав отметку напротив мнемоники нужного экземпляра Адаптера СМЭВ 3.х, нажмите «Установить на выбранные адаптеры».
По результатам на вкладке «Привязанные адаптеры» версии НФ отображаются мнемоники использующие данную версию НФ. 
Авторизуйтесь, чтобы оставить комментарий к статье