3.Описание структуры элементов xml-шаблона статистической отчетности Настоящий раздел содержит описание XML-шаблона электронной версии формы статистической отчетности.
3.1.metaForm Элемент metaForm является элементом верхнего уровня.
Дочерние элементы metaForm:
settings;
title;
sections;
controls;
dics.
Табл. 6.Атрибуты элемента metaForm
Наименование
| Допустимые значения
| Описание
| Обязательность
| code
| unsignedLong
| Уникальный код формы
| Обязательный
| idp
| unsignedInt
| Код идентификатора периодичности формы,
| Обязательный
| idf
| unsignedInt
| Идентификатор формы. Используется для загрузки
| Обязательный
| shifr
| string
| Шифр задачи. Используется для загрузки данных
| Обязательный
| name
| string
| Текстовое наименование формы
| Обязательный
| obj
| string
| Объект наблюдения. Определяет, какое поле из секции является идентификатором объекта наблюдения.
Идентификатор объекта наблюдения – код однозначно определяющий объект наблюдения, установленный в соответствии с утверждённым бланком формы.
| Обязательный
| OKUD
| unsignedInt
| Код формы согласно общероссийского классификатора управленческой документации
| Обязательный
| version
| token
| Версия XML-шаблона (дата его формирования в формате день-месяц-год, например, 16-03-2010)
| Обязательный
| format-version
| token
| Версия формата xml-шаблона
| Обязательный
|
3.1.1.settings Содержит настройки общего назначения.
Элемент необязательный;
Максимальное количество элементов: 1;
Родительский элемент: metaForm;
sign Необходимость подписания документа.
Элемент необязательный;
Максимальное количество элементов: 1;
Родительский элемент: settings
Значение по умолчанию: true;
Допустимые значения:
Значение
| Описание
| true
| Отчет должен быть подписан
| false
| Отчет не должен быть подписан
| validation Необходимость проведения контролей.
Элемент необязательный;
Максимальное количество элементов: 1;
Родительский элемент: settings
Значение по умолчанию: always;
Допустимые значения:
Значение
| Описание
| Always
| проверять всегда - не позволять сохранить отчет как «отчет» без успешного выполнения обязательных контролей
| Prompt
| проводить контроль, но при ошибках предлагать пользователю выбор: сохранять или нет
| Skip
| контроль не проводится - позволяет сохранять ошибочный отчет
| notEmpty Возможность сдачи незаполненного (пустого) отчета.
Элемент обязательный;
Максимальное количество элементов: 1;
Родительский элемент: settings
Значение по умолчанию: true; то есть отчет не может сдаваться незаполненным;
Допустимые значения:
Значение
| Описание
| true
| Отчет должен быть заполнен
| false
| Отчет может сдаваться незаполненным
| 3.1.2.title Описание структуры титульной страницы.
Элемент обязательный;
Максимальное количество элементов: 1;
Родительский элемент: metaForm;
Дочерние элементы: item.
item Поле для заполнения на титульном листе отчета.
Обязательно наличие тэга item, у которого @field=/metaForm/@obj;
Элемент обязательный;
Максимальное количество элементов: неограниченно;
Родительский элемент: title.
Табл. 7 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| field
| string
| Идентификатор поля
| Обязательный
| name
| string
| Название поля, используется при отображении пользователю
| Обязательный
| dic
| string
| Атрибут определяет поле, как идентификационный признак отчета, проверяемого по справочнику, кроме справочника s_okpo, который в xml-шаблон не включается и проверка соответствующего ему поля по справочнику выполняется только при загрузке отчета в программные средства обработки.
| Необязательный
| 3.1.3.sections Список разделов формы.
Элемент обязательный;
Максимальное количество элементов: 1;
Родительский элемент: metaForm;
Дочерние элементы: section.
section Раздел формы.
Элемент обязательный;
Максимальное количество элементов: неограниченно;
Родительский элемент: sections;
Дочерние элементы: columns, rows.
Табл. 8 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| code
| unsignedLong
| Код раздела
| Обязательный
| name
| string
| Название раздела
| Обязательный
| nb
| unsignedInt
| Внутренний идентификатор ССО, используется для загрузки. Сторонние приложения не должны обрабатывать данный атрибут
| Обязательный
| 3.1.3.1.1columns Список всех столбцов раздела.
Элемент обязательный;
Максимальное количество элементов: 1;
Родительский элемент: section;
Дочерние элементы: column.
3.1.3.1.1.1column Столбец раздела.
Элемент обязательный;
Максимальное количество элементов: неограниченно;
Родительский элемент: columns;
Дочерние элементы: default-cell.
Табл. 9 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| code
| string
| Код строки
| Обязательный
| type
| Значение
| Описание
| B
| Столбец-боковик
| Z
| Столбец-значение
| S
| Столбец-специфика
|
| Тип столбца
Столбец-боковик – крайний левый столбец, в котором определяются названия, заполняемых строк.
Столбец-значение – числовое значение показателя.
Столбец-специфика – столбец, значение в котором определяет уникальность множественной строки.
| Обязательный
| fld
| string
| Идентификатор ключевого атрибута в отчете-ЭВФ, если это столбец-специфика. Может принимать значения "s1", "s2", "s3".
| Необязательный
| name
| string
| Отображаемое текстовое название столбца
| Обязательный
| pr_inp
| string
| Условие закрещивания графы - условие на период отчета, задаваемое в соответствии с лексемой <Условие на период> языка описания контролей, который описан в разделе 4.
Допустимые значения:
true- графа недоступна для редактирования;
False- графа не закрещена.
Значение по умолчанию: false; то есть графа не закрещена.
| Необязательный
| 3.1.3.1.1.1.1default-cell Описание ячейки по умолчанию, которая применяется ко всему столбцу.
Элемент необязательный;
Максимальное количество элементов: 1.
Табл. 10 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| column
| string
| Код столбца
| Обязательный
| dic
| string
| Справочник, по которому проверяется значение
| Необязательный
| format
| string
| Описание формата вводимого значения в ячейку отчета-ЭВФ. Например:
C(25) – символьная строка длиной не более 25 знаков (формат допустим для колонок типа ‘B’ и ‘S’) ;
N(15,2) – Числовое поле, у которого целая часть не более 15 знаков, дробная часть не более 2 знаков (формат допустим для колонок типа ‘S’ и ‘Z’).
| Обязательный
| default
| string
| Значение по умолчанию
| Необязательный
| inputType
| Значение
| Описание
| 0
| Ячейка запрещена для ввода
| 1
| Ячейка, обязательная для ввода
| 2
| Ячейка, не обязательная для ввода
|
| Тип ячейки
| Обязательный
| vldType
| Значение
| Описание
| 0
| Проверки не требуется. По умолчанию
| 1
| Проверка по справочнику, указанному в атрибуте dic
| 2
| Проверка на диапазон значений, указанных в атрибуте vld
| 3
| Проверка по списку значений, указанных в атрибуте vld
| 4
| Проверка по приложения, справочник указывается в атрибуте dic, приложение - в атрибуте vld
| 5
| Проверка по справочнику, используя фильтрацию по формуле, указанной в атрибуте vld
|
| Тип проверки значения ячейки
| Необязательный
| vld
| string
| Дополнительные параметры фильтрации зависит от атрибута vldType: vldType=2: диапазон значений вида "1-10"; vldType=3: список значений вида "1,2,5,7"; vldType=4: идентификатор приложения, по которому усекается справочник; vldType=5: фильтр для справочника вида "okp=#5,50,Г" - где: "okp" - дополнительный атрибут в теге "term" справочника, "#5,50,Г" - координата ячейки, из которой берется значение для фильтрации ("5" - раздел формы, "50" - код строки, "Г" - код столбца).
| Необязательный
|
3.1.3.1.2rows Список всех строк раздела;
Элемент обязательный;
Максимальное количество элементов: 1
Родительский элемент: section;
Дочерние элементы: row.
3.1.3.1.2.1row Строка раздела.
Элемент обязательный;
Максимальное количество элементов: неограниченно;
Родительский элемент: rows;
Дочерние элементы: cell.
Табл. 11 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| code
| unsignedLong
| Код строки
| Обязательный
| type
| Значение
| Описание
| C
| Текстовая строка, не предназначена для ввода данных
| F
| Фиксированная строка, предназначенная для ввода данных
| M
| Множественная строка, пользователь имеет возможность ввести данную строку несколько раз
|
| Тип строки
| Обязательный
| grv
| string
| Имеет смысл для множественных строк (type="M"). Перечисленные через запятую коды столбцов специфик (например, “В”), которые являются ключевыми для данной множественной строки
| Необязательный
| name
| string
| Наименование строки
| Обязательный
| pr_inp
| string
| Условие закрещивания строки - условие на период отчета, задаваемое в соответствии с лексемой <Условие на период> языка описания контролей, который описан в разделе 4.
Допустимые значения:
true- строка недоступна для редактирования;
False- строка не закрещена.
Значение по умолчанию: false; т.е. строка не закрещена.
| Необязательный
|
3.1.3.1.2.1.1cell Ячейка строки.
Элемент не обязательный;
Максимальное количество элементов: Неограниченно.
Табл. 12 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| column
| string
| Код столбца
| Обязательный
| dic
| string
| Справочник, по которому проверяется значение
| Необязательный
| format
| string
| Описание формата вводимого значения в ячейку отчета-ЭВФ. Например:
C(25) – символьная строка длиной не более 25 знаков (формат допустим для колонок типа ‘B’ и ‘S’) ;
N(15,2) – Числовое поле, у которого целая часть не более 15 знаков, дробная часть не более 2 знаков (формат допустим для колонок типа ‘S’ и ‘Z’).
| Обязательный
| default
| string
| Значение по умолчанию
| Необязательный
| inputType
| Значение
| Описание
| 0
| Ячейка запрещена для ввода
| 1
| Ячейка, обязательная для ввода
| 2
| Ячейка, не обязательная для ввода
|
| Тип ячейки
| Обязательный
| vldType
| Значение
| Описание
| 0
| Проверки не требуется. По умолчанию
| 1
| Проверка по справочнику, указанному в атрибуте dic
| 2
| Проверка на диапазон значений, указанных в атрибуте vld
| 3
| Проверка по списку значений, указанных в атрибуте vld
| 4
| Проверка по приложения, справочник указывается в атрибуте dic, приложение - в атрибуте vld
| 5
| Проверка по справочнику, используя фильтрацию по формуле, указанной в атрибуте vld
|
| Тип проверки значения ячейки
| Необязательный
| vld
| string
| Дополнительные параметры фильтрации зависит от атрибута vldType: vldType=2: диапазон значений вида "1-10"; vldType=3: список значений вида "1,2,5,7"; vldType=4: идентификатор приложения, по которому усекается справочник; vldType=5: фильтр для справочника вида "okp=#5,50,Г" - где: "okp" - дополнительный атрибут в теге "term" справочника, "#5,50,Г" - координата ячейки, из которой берется значение для фильтрации ("5" - раздел формы, "50" - код строки, "Г" - код столбца).
| Необязательный
| pr_inp
| string
| Условие закрещивания ячейки - условие на период отчета, задаваемое в соответствии с лексемой <Условие на период> языка описания контролей, который описан в разделе 4.
Допустимые значения:
true- ячейка недоступна для редактирования;
False- ячейка не закрещена.
Значение по умолчанию: false; то есть ячейка не закрещена.
| Необязательный
|
3.1.4.controls Список контролей формы.
Элемент обязательный;
Максимальное количество элементов: 1;
Родительский элемент: metaForm;
Дочерние элементы: control.
control Арифметическо-логический контроль.
Родительский элемент: controls.
Элемент необязательный;
Максимальное количество элементов: неограничено;
Табл. 13 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| id
| unsignedInt
| Идентификатор контроля
| Обязательный
| name
| string
| Текстовое описание контроля
| Обязательный
| condition
| string
| Условие выполнения контроля (выражение на языке контролей)
| Обязательный
| rule
| string
| Формула контроля, которая должна выполниться, чтобы контроль считался успешным (выражение на языке контролей)
| Обязательный
| periodClause
| string
| Условие на период отчета (выражение на языке контролей). Значение по умолчанию - true
| Необязательный
| precision
| unsignedByte
| Количество десятичных знаков, до которых округляются значения при операциях сравнения в формулах контроля. Значение по умолчанию 2
| Необязательный
| fault
| decimal
| Допустимое отклонение (допустимые границы отклонения при сравнении). Значение по умолчанию – 0 (отклонения не допускается).
Нарушение контрольных соотношений XML- шаблона приравнивается к ошибке при сравнении на равенство.
| Необязательный
| tip
| Значение
| Описание
| 0
| Необязательный контроль
| 1
| Обязательный контроль
|
| Значение по умолчанию – 1 (обязательный контроль)
| Необязательный
|
Условие выполнения контролей, формула контроля и условие на период отчета задаются на языке описания контролей, который описан в Разделе 4. Условие выполнения контролей описывается лексемой <Условие>. Формула контроля описывается лексемой <Логическое выражение>. Условие на период отчета описывается лексемой <Условие на период>.
3.1.5.dics Справочники формы.
Элемент обязательный;
Максимальное количество элементов: 1;
Родительский элемент: metaForm;
Дочерние элементы: dic.
Обязательно наличие справочников (дочерних элементов) s_year и s_time или s_god и s_mes.
dic Справочник формы или приложение к справочнику.
Элемент обязательный;
Минимальное количество элементов: 2;
Максимальное количество элементов: неограниченно;
Родительский элемент: dics;
Дочерние элементы: term.
Табл. 14 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| name
| string
| Текстовое наименование справочника
| Обязательный
| id
| string
| Идентификатор справочника или приложения (название таблицы)
| Обязательный
| parent
| string
| Имеет смысл только для приложения1. Идентификатор справочника, к которому относится приложение
| Необязательный
|
3.1.5.1.1term Термин - элемент справочника.
Дополнительные атрибуты: возможно наличие дополнительных атрибутов, которые используются для фильтрации справочника. Имена дополнительных атрибутов задаются проектировщиком формы (разработчиком XML-шаблона) произвольно. Справочник, из которого выбираются значения для заполнения некоторого поля, может формироваться по значению некоторого признака – дополнительного параметра фильтрации (подробнее в описании атрибута vld элементов cell и default-cell, в случае vldType=5);
Допустимые значения: string;
Содержимое: текст позиции справочника, только для справочника, приложение не имеет текста позиции;
Элемент обязательный;
Максимальное количество элементов: неограниченно;
Родительский элемент: dic.
Табл. 15 Атрибуты
Наименование
| Допустимые значения
| Описание
| Обязательность
| Id
| string
| Код термина, совместно с дополнительными атрибутами представляет собой ключ
| Обязательный
| |