Аннотации к схеме

Дополнительные аннотации к схеме

Для упрощения работы технических специалистов участников, связанной с интеграцией различных систем с системой Репозитария, в xsd-схему формата добавлены дополнительные аннотации. Аннотации делятся на текстовые (xsd:documentation), которые могут быть использованы для автоматической генерации документации или пользовательских интерфейсов программ, и флаги (xsd:appinfo), которыми отмечаются некоторые дополнительные признаки полей, введённые Репозитарием НРД.

Каждый блок xsd:documentation содержит два атрибута - xml:lang и source. Первый для аннотаций Репозитария всегда имеет два значения - ru и en, то есть все комментарии Репозитария НРД приводятся на двух языках. Значения второго атрибута рассматриваются в таблице ниже.

Любой узел xsd-схемы может содержать дочерний узел xsd:annotation, в котором и располагаетются упомянутые выше аннотации.

Специфические xsd:documentation и xsd:appinfo

Вид аннотации Пояснения
<xsd:documentation source='nsdr' xml:lang='ru'>
Краткое наименование поля, может использоваться для автоматической генерации интерфейсов и печатных форм.
<xsd:documentation source='ffms' xml:lang='ru'>
Заполняется, если для данного поля есть соответствие в приказе ФСФР.
<xsd:documentation source='stdc' xml:lang='ru'>
Расширенное описание поля.
<xsd:documentation source='nsdn' xml:lang='ru'>
Условия заполнения данного поля, если таковые имеются.
<xsd:appinfo source='mrе'/>
mre – mandatory reporting element.
Поля, обязательные к заполнению. Элементы схемы, отмеченные таким атрибутом обязательно должны быть заполнены в сообщении, присылаемом на регистрацию в репозитарий.
Данный флаг может дополнительно иметь значение, например, <xsd:appinfo source='mre'>1</xsd:appinfo>. Значение задаёт минимально возможное вхождение элемента в сообщение. С точки зрения правил xsd этот атрибут эквивалентен атрибуту minOccurs, однако он не может быть свалидирован стандартными средствами. При наличии у элемента такого флага атрибут minOccurs не учитывается.
<xsd:appinfo source='mfr'/>
mfr – mandatory field reconciliation
Поля обязательной сверки – поля, обязательные и необязательные к заполнению, которые должны совпадать в обоих встречных сообщениях для успешного прохождения регистрации. Заполненные поля в сообщениях одной стороны и незаполненные поля во встречных сообщениях второй стороны признаются несовпадающими. Незаполненные (необязательные к заполнению) поля во встречных сообщениях обеих сторон признаются совпадающими.
<xsd:appinfo source='afr'/>
afr – additional field reconciliation
Поля дополнительной сверки – поля, необязательные к заполнению и для прохождения регистрации. В случае заполнения и полного совпадения этих полей во встречных сообщениях обеих сторон, сведения из этих полей вносятся в реестр договоров. В случае незаполнения этих полей или несовпадения их во встречных сообщениях сторон, сведения из этих полей не вносятся в реестр договоров. Однако факт несовпадения этих полей не влечет за собой отказ в регистрации сообщений, которые будут зарегистрированы в реестре без данных полей.
<xsd:appinfo source='sfr'/>
sfr – special field reconciliation
Поля специальной сверки – поля, обязательные для прохождения регистрации, расхождение в заполнении которых во встречных сообщениях двух сторон, если поля заполнены обеими сторонами, приводит к отказу в регистрации сообщений. В случае, если эти поля заполнены только одной стороной, поля считаются сверенными, а значения этих полей, заполненные одной стороной, вносятся в реестр как значения, принятые для данных полей.
<xsd:appinfo source='ofr'/>
ofr – optional field reconciliation
Поля специальной дополнительной сверки – поля, необязательные для прохождения регистрации, расхождение в заполнении которых во встречных сообщениях двух сторон, если поля заполнены обеими сторонами, не приводит к отказу в регистрации сообщений – сообщения регистрируются, но сведения из этих полей не вносятся в реестр договоров. В случае, если эти поля заполнены только одной стороной, поля считаются сверенными, а значения этих полей, заполненные одной стороной, вносятся в реестр как значения, принятые для данных полей.
<xsd:appinfo source='nfr'/>
nfr – no field reconciliation
Несверяемые поля – поля сообщений, которые не участвуют в процессе сверки. Эти поля служат для передачи технической информации о сообщении (отправитель, номер сообщения и пр.). Значения этих полей из сообщений обеих сторон не вносятся в реестр.
<xsd:appinfo source='ncf'/>
ncf – non-completed field
Незаполняемые поля – поля, предусмотренные в формате сообщений, не используемые в целях обмена сообщениями с репозитарием. Сведения, указанные в таких полях, не заполняются сторонами, а в случае заполнения не подлежат сверке и внесению в реестр.
<xsd:appinfo source='umf'/>
umf – unique matching field
Поля, определяющие уникальность анкеты – поля обязательной либо дополнительной сверки, обеспечивающие уникальность регистрируемых анкет генеральных соглашений, договоров и иных отчетов и поиск встречных анкет при квитовке сообщений.
<xsd:appinfo source='frdig'/>
Цифровое поле, к которому применяется следующее условие: точность до 7 знаков после десятичной точки; например, 30.1234567; значение 30.45 указывается как 30.4500000