Новости 
База знаний 
Документация 
Форум 
ЛК УВ 
Назад
Данная статья содержит описание следующих блоков элементов «Structure», «Elements», «Types», «Mappers» и «Validation».
Structure
Блок structure : object – обязательный блок элементов настроечного файла имеет следующую структуру:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[mode] : |
array |
Список отображаемых блоков. mode - режим |
Допустимые варианты значений: · "request" - запрос · "resonse" - ответ |
В [mode] входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
source : |
string |
Источник данных |
допустимые варианты значений: · "message" - сообщение |
|
|
from : |
string |
Уточнение расположения данных |
Допустимые варианты значений для источника message: "Content" - всё сообщение (не директивный вид сведений) "General" - общая часть сообщения (директивный вид сведений) "Registry" - реестровая часть сообщения (директивный вид сведений) |
|
|
element : |
string |
Идентификатор корневого элемента, для отображения блока |
||
|
dynamicRouting : |
boolean |
Наличие блока динамической маршрутизации |
||
|
attachments : |
object |
Настройки блока вложений |
В attachments входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
pasportIds : |
array |
Список допустимых значений идентификаторов паспортов |
pasportIds : |
Elements
В блоке elements : object описываются элементы настроечного файла, которые в дальнейшем распределяются по запросной или ответной части вида сведения и имеет следующую структуру:|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[id] : |
object |
Элемент id – уникальный идентификатор элемента (в списке элементов) |
[id] : в свою очередь имеет следующую структуру:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
path : |
string |
Путь к узлу дерева XML - как правило соответствует имени тега, который описывает элемент |
|
|
|
typeId : |
string |
Идентификатор типа - ссылка на тип (по умолчанию используется простой тип, с "base" : "string") |
||
|
caption : |
string |
Название элемента, отображаемое пользователю |
||
|
description : |
string |
Расширенное описание поля |
||
|
required : |
boolean |
Обязательность заполнения данных (по умолчанию false) |
||
|
repeatable : |
object |
Описание повторяемости элемента |
||
|
readOnly : |
boolean |
Доступность элементов для редактирования (по умолчанию false) |
||
|
default : |
string |
Значение элемента по умолчанию |
В repeatable входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
path |
string |
путь к повторяющемуся узлу дерева XML - как правило соответствует имени тега, который описывает повторяющийся элемент |
|
|
|
min : |
number |
Минимальное количество элементов [0 - 1] (по умолчанию 0) |
|
|
|
max : |
number |
Максимальное количество элементов [1 - 2^7] или unbounded (по умолчанию unbounded) |
||
|
caption : |
string |
Заголовок повторяемого элемента с добавление текущего индекса начиная с 1 (по умолчанию название головного элемента) |
||
|
addCaption : |
string |
Название кнопки для добавления повторяемого элемента (по умолчанию "Добавить") |
||
|
removeCaption : |
string |
Название кнопки для удаления повторяемого элемента (по умолчанию "Удалить") |
Types
В блоке types : object описываются типы элементов настроечного файла
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[id] : |
object |
Элемент id – уникальный идентификатор элемента (в списке элементов) |
[id] : в свою очередь имеет следующую структуру:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
description : |
string |
Расширенное описание поля |
||
|
base : |
string |
Базовый тип |
Допустимые варианты значений: · "boolean" - логический · "number" - числовой · "string" - строковый |
|
|
content : |
object |
содержимое типа |
||
|
restriction : |
object |
описание ограничений |
||
|
widget : |
object |
виджет |
В content входят следующие элементы
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
mode : |
string |
Режим обработки содержимого |
допустимые варианты значений: · "sequence" - последовательно · "choice" - выборочно, только один |
|
|
elementIds : |
array |
Список идентификаторов элементов в порядке отображения |
||
|
xmlOrder : |
array |
Список идентификаторов элементов в порядке, требуемом форматом XML (по умолчанию используется порядок из elementIds) |
В restruction входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
enumeration : |
object |
Список вариантов |
||
|
pattern : |
string |
Регулярное выражение |
||
|
whitespace : |
string |
Обработка пробелов |
допустимые варианты значений: · "preserve" - сохранение всех white space символов · "collapse" - замена всех white space символов, устранение повторяющихся пробелов на единичные · "replace" - замена всех white space символов |
|
|
length : |
number |
Длина текста |
||
|
minLength : |
number |
Минимальная длина текста |
||
|
maxLength : |
number |
Максимальная длина текста |
||
|
minInclusive : |
number |
Минимальное числовое значение включая указанное |
||
|
maxInclusive : |
number |
Максимальное числовое значение включая указанное |
||
|
minExclusive : |
number |
Минимальное числовое значение исключая указанное |
||
|
maxExclusive : |
number |
Максимальное числовое значение исключая указанное |
||
|
totalDigits : |
number |
Точное число разрешенных цифр [1- 2^7] |
||
|
fractionDigits : |
number |
Максимальное допустимое число десятичных знаков [0 - 2^7] |
В enumeration входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[value] : |
string |
Человекочитаемаый текст. value - значение |
В widget входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
name : |
string |
имя |
||
|
params : |
object |
параметр |
... : структура зависит от виджета |
Mappers
В блоке mappers : object описывают соответствие данных между потенциально различными семантиками одного объекта или разных объектов. В данный блок входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[id] : |
object |
Маппер id – название маппера |
||
|
class : |
string |
Класс маппера |
допустимые варианты значений: - "DateFormat" - форматированное значение даты и время |
|
|
params : |
object |
Перечень параметров зависит от класса |
В params входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[name] : |
string |
Значение параметра. name – название параметра |
Validation
В блоке validation : object описывается валидация с возможностью межреквизитного контроля.
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
validation : |
object |
Валидация с возможностью межреквизитного контроля |
В блок validation входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
[elementId] : |
array |
Список ошибок. elementId идентификатор корневого элемента для применения правил |
В elementId входят следующие элементы:
|
Ключ |
Тип |
Обязательное присутствие |
Описание |
Условие |
|
rule : |
string |
Правило поиска ошибочных вариантов |
||
|
message : |
string |
Сообщение |
