Корневой элемент schema:
- описывает структуру данных объекта,
- содержит в себе код управления событиями объекта,
- переадресацию на другую схему.
<?xml version='1.0' encoding='UTF-8'?>
<schemas xmlns="http://www.intertrust.ru/schema/palette/tn-schema">
<schema name="{name}" extends="{schema name}" recalc="true" workflow="false">
<string name="{name}"/>
<enum-ref name="{name}" ref="{enum name}"/>
<enum>
<string name="{name}"/>
</enum>
<schema-ref name="{name}" ref="{schema name}"/>
<param-specification>
<primitive-ref ref="{name}" value="{value}"/>
</param-specification>
<custom-event-handler lang="JavaScript"><![CDATA[...]]></custom-event-handler>
</schema>
</schemas>
schema
Схемы данных в могут быть трех типов:
- Примитив;
- Перечисление;
- Объект.
Для Схемы данных объекта можно создать Настраиваемый обработчик событий (НОС). НОС предназначен для описания специфичной логики обработки сохранения объекта, созданного по соответствующей Схеме данных.
С помощью НОС в НР2 может быть описана обработка событий как для web-клиента, так и для клиента Notes. В качестве языка для описания обработчиков событий для web-клиента используется JavaScript, а для клиента Notes - LotusScript.
Поддерживается настройка обработки трех событий для web-клиента:
- querySave - вызывается непосредственно перед переносом данных из объекта Java API в документ, в котором этот объект хранится. Функция должна возвращать значение типа Boolean. Если функция вернула false - сохранение будет прервано.
- postSave - вызывается сразу после сохранения документа в хранилище.
- recalc - вызывается при пересчете ресурса, в том числе вызов recalc может быть связан в изменением значения поля или нажатием на кнопку «Пересчет секций» (добавлено с СМ 4.5)
Схема типа «Объект» предназначена для описания структуры данных бизнес-объекта. Это может быть документ или его часть.
Рисунок 5: Пример наследования Схем данных
Для Схемы типа «Объект» может быть указана родительская Схема данных, тоже типа «Объект» (Рисунок 5). Это значит, что текущая Схема данных будет наследовать все Свойства, описанные для родительской Схемы. Если родительская Схема, в свою очередь, тоже имеет родительскую, то текущая Схема будет наследовать и ее Свойства. Т.е. дочерняя Схема наследует Свойства всех родительских. Одна Схема может быть родительской для нескольких Схем, но всегда имеет единственную родительскую Схему.
Рисунок 6: Указание Схемы типа «Объект» как Схемы для Свойства другой Схемы
С другой стороны, Схема данных типа «Объект» может быть указана, как Схема для Свойства другой Схемы данных (2.2.1. Общее описание Свойства схемы). Это будет означать, что все Свойства Схемы будут доступны внутри родительской для Свойства Схемы через соответствующее Свойство (Рисунок 6). Это позволит описывать общие для объектов части один раз.
Рисунок 7: Схема данных типа «Объект»
Для создания Схемы данных типа «Объект» (Рисунок 7):
- Открыть представление «Схемы» БД НР и нажать кнопку «Схема» на панели действий.
- В поле «Тип» выбрать значение «объект».
- В поле «Название» указать уникальное в рамках списка Схем название.
- В поле «Наследует» при необходимости выбрать название родительской Схемы. В данном поле может быть указана только Схема типа «Объект».
- Сохранить Схему.
В разделе «Свойства схемы» отображаются Свойства текущей Схемы и их типы (Схемы, указанные для Свойств).
Примечание: Признак «включить recalc» имеет смысл устанавливать только для Схем, описывающих составную часть объекта. Установка признака означает, что в web-клиенте будет доступна операция перевычисления только той части объекта, которая описывается текущей Схемой данных. При этом в коде сервера должна быть предусмотрена отдельная процедура для перевычисления этой части объекта. Таким образом данный признак устанавливается только разработчиками при выполнении доработок и в НР2 и на сервере.
Обработчики событий для иерархии схем
Обработчики событий могут быть созданы к нескольким схемам, объединенным в одну иерархию.
Обработчики события querySave выполняются в порядке наследования схем снизу вверх: сначала событие querySave текущей Схемы объекта, потом событие querySave той Схемы, которую она уточняет, и так далее до события querySave базовой Схемы.
Обработчики события postSave выполняются в обратном порядке, сверху вниз: сначала событие postSave базовой Схемы, потом событие postSave уточняющей Схемы и так далее до текущей Схемы объекта.
Обработчики события recalc выполняются аналогично postSave, сверху вниз.
Если для какой-то из Схем в иерархии Обработчик событий не создан или не содержит описания соответствующего события, то эта Схема пропускается, и выполняется обработчик следующей по порядку обработки Схемы.
Доступ к Java API
Код обработчика событий имеет доступ к Java API системы и подключенным к ней сторонним библиотекам. Для работы с тем или иным Java классом его или пакет, в котором он расположен, предварительно необходимо импортировать в обработчик. Для этого можно использовать функции importPackage() или importClass ().
importPackage (Packages.java.util); - импортирует все классы, расположенные в пакете java.util.
Как и в Java, импортируются только классы, находящиеся непосредственно в указанном пакете. Классы из дочерних пакетов импортированы не будут.
Коду обработчика на JavaScript доступны все public методы реальных классов, реализующих те или иные интерфейсы Java API. Области видимости protected и private недоступны.
Синтаксис работы с объектами Java классов точно такой же, как и с объектами JavaScript.
Конкретизация Схемы позволяет настроить отображение объекта по различным Формам в зависимости от определенных Свойств схемы. Результатом конкретизации является изменение Схемы данных объекта, а по измененной Схеме будет выбрана новая Форма для его отображения. Конкретизация доступна для Схем данных типа «Объект».
Примечание: Раздел «Параметры конкретизации» сохранен для совместимости с НР1. Вместо Параметров конкретизации в НР2 нужно использовать Условия применения (5. Условия применения).
Поскольку при конкретизации Схемы данных происходит изменение Схемы, то для ее использования в НР2 должно быть описано как минимум две Схемы данных: родительская и производная. Родительская Схема связывается с типом документа, а производная будет являться результатом конкретизации родительской. Конкретизация Схемы производится по значениям Свойств родительской Схемы.
Рисунок 8: Конкретизация Схемы данных
Для описания конкретизации Схемы данных типа «Объект» (Рисунок 8):
- Описать родительскую и производную Схемы данных типа «Объект», включая описание Свойств Схем.
- Открыть родительскую Схему данных.
- В разделе «Конкретизация» родительской Схемы данных в поле «Параметры конкретизации схемы» указать Свойства схемы, от значений которых зависит выбор Схемы данных объекта.
- Сохранить родительскую Схему данных.
- Открыть производную Схему данных.
- В разделе «Параметры конкретизации родительской схемы» производной Схемы указать Свойства родительской Схемы и их значения, при которых должна использоваться текущая производная Схема данных. Свойства родительской Схемы добавляются по кнопке «добавить» и выбираются из Свойств родительской Схемы, указанных в поле «Параметры конкретизации схемы».
- Сохранить производную Схему данных.
Дополнительные функции
В описании обработчика событий можно объявлять дополнительные функции и вызывать их из событий.
Внимание: Объекты Notes Java API, переданные в обработчик событий извне (например, параметр document), нельзя передавать в дополнительно объявленные функции. Работать с параметром document можно только внутри событий querySave и postSave.
Schema
<custom-event-handler<?xml version='1.0' encoding='UTF-8'?>
<schemas xmlns="http://www.intertrust.ru/schema/palette/tn-schema">
<schema extends="RkkResource" name="RkkResourceAdvInput" >
<meta>
<category name="Система\Делопроизводство"/>
</meta>
<Примитив>
<Перечисление>
<Объект>
</schema>
</schemas>
Атибуты
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation><![CDATA[Название схемы]]></xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="workflow" type="xs:boolean" use="optional" default="false">
<xs:annotation>
<xs:documentation><![CDATA[Используется WorkFlow]]></xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="recalc" type="xs:boolean" use="optional" default="false">
<xs:annotation>
<xs:documentation><![CDATA[Признак обновления свойств схемы]]></xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="extends" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation><![CDATA[Название родительской схемы]]></xs:documentation>
</xs:annotation>
</xs:attribute>