Редактирование метаданных

Часть функционала Окна редактора метаданных MetaEdit (общий вид окна, его назначение областей, команды контекстного меню, принципы работы окна поиска и т.д.) идентична функционалу Окна объектной модели (см. Объектная модель).

Ниже в данной статье описан только тот функционал, который специфичен именно для MetaEdit.

Общий вид окна MetaEdit показан на Рис.1.

Рисунок 1

В информационном окне отражаются сведения о загрузке и применении метаданных.

Структура данных представлена тремя модулями: База, БизнесМодель, CRM.

База – общий функционал, независимо от предметной области (права, меню, отчеты, импорт и т.д.). При заведении объектных параметров и списков можно использовать только классы модуля База. Дочерние классы можно создавать любых модулей.

БизнесМодель – функционал предметного решения (предметные классы, диаграммы). При заведении объектных параметров и списков можно использовать классы модуля База и БизнесМодель. Дочерние классы можно создавать только модуля БизнесМодель.

CRM - модуль почтовых рассылок. При заведении объектных параметров и списков можно использовать классы модуля База и CRM. Дочерние классы можно создавать только модуля CRM.

Вверху окна расположен раскрывающийся список модулей и кнопка , вызывающая меню (Рис. 2).

Рисунок 2

Раскрывающийся список содержит список модулей, включенных в метаданные. Выбранный модуль используется для создания нового класса, класс создается с учетом логики, описанной выше. Классы, не относящиеся к текущему модулю, будут выделены в дереве серым цветом.

По кнопке  можно настроить отображающиеся в дереве классы: отображать классы только текущего модуля, показывать удаленные.

Отображать классы тек. модуля - Если опция меню отмечена, то при выборе модуля из раскрывающегося списка модулей, в дереве классов будут отображены только классы, принадлежащие выбранному модулю. Если опция не выбрана, то в дереве классов будут показаны все классы, независимо от их модульной принадлежности, но классы, не относящиеся к текущему модулю, будут неактивны, то есть будут выделены в дереве серым цветом. Если у класса, не принадлежащего текущему модулю, есть классы-наследники, принадлежащие текущему модулю, то класс-родитель выделяется в дереве классов синим цветом.

Показывать удаленные - При выборе этой опции меню в дереве классов будут отображены все классы, включая удаленные ранее классы. Удаленные классы выделяются в дереве красным цветом.

Показывать заголовки классов - По умолчанию опция отмечена. Если опция меню отмечена, в дереве классов будут показаны не системные названия классов, а их заголовки, т.е. значения, заданные для соответствующих классов в их дополнительной опции "RepositoryView.Header" (см. Свойства класса).

Классы, принадлежащие текущему модулю (модулю, выбранному из раскрывающегося списка), отображаются в дереве стандартным черным цветом. Классы, не принадлежащие текущему модулю, отображаются серым цветом. Однако, если у класса, не принадлежащего текущему модулю, хотя бы один потомок принадлежит текущему модулю, то класс-родитель отображается в дереве классов синим цветом. Такая подсветка классов позволяет легко ориентироваться в большой и многоуровневой иерархии классов. Для удобства чтения информации о классе, у каждого класса есть пиктограммы. Их значения описаны в Таблица 1 Пиктограммы классов. Все действия с классами производятся из контекстного меню дерева классов, описание пунктов контекстного меню приведено в Таблице 2 Контекстное меню дерева классов.

Пиктограмма	Значение
	Класс - потомок класса "Самостоятельные объекты".
	Перечисление - потомок типа "Перечисления".
	Класс - потомок класса "Строки списков".
	Наличие этого элемента в пиктограмме означает, что класс допускает хранимые ссылки.
	Наличие этого элемента в пиктограмме означает, что класс нехранимый.
	Наличие этого элемента в пиктограмме означает, что класс системный, доступен только для просмотра.
	Наличие этого элемента в пиктограмме означает, что класс пользовательский, есть возможность редактирования.

Таблица 1. Пиктограммы классов

Язык в MetaEdit переключается в правом нижнем углу.

На переключение языка реагируют дерево (при активной опции Показывать заголовки классов) и панель свойств.

Внимание! Ресурсы метаданных (например, "Описание" в классах и параметрах) обязательно должны быть заполнены на Языке по умолчанию (см. Термины). После этого можно заполнять ресурсы на остальных языках.

Форма "Свойства класса" (Рис. 3) вызывается при добавлении нового класса, редактировании или просмотре существующего. Вызов класса на редактирование осуществляется выбором пункта контекстного меню.

Внимание! Создание и редактирование возможно только для пользовательских классов, к  их названию  добавляется префикс usr_.

Внимание! Все пользовательские справочники рекомендуется создавать в классе Основные объекты.

Создание нового класса проходит в несколько этапов:

1. Под классом "Предметные объекты" выбрать класс-родитель, под которым будет создан новый класс.
2. В контекстном меню этого класса выбрать один из пунктов:
   • Добавить – для добавления нового Хранимого класса
   • Добавить новый виртуальный класс – для добавления нового Виртуального класса
3. В появившемся окне Свойства класса необходимо:
   1. Ввести системное название класса без пробелов. Системное название класса может состоять из букв, цифр и знаков подчеркивания. Начинаться может с буквы или со знака подчеркивания. Это уникальный идентификатор класса для использования в базе данных. Если название класса состоит из нескольких слов, то каждое слово должно начинаться с прописной буквы.
   2. На вкладке Доп. опции заполнить опции (подробнее см. Вкладка "Доп. опции").
   3. На вкладке Группы параметров выбрать параметры класса (подробнее см. Вкладка "Группы параметров").
   4. На вкладке Описание заполнить поле описания класса. Важно: описание нового класса должно быть заполнено сначала на Языке по умолчанию.
4. Применить новые метаданные к базе с помощью команды Файл–>Применить к базе данных. Если метамодель не готова к применению к базе, то ее можно сохранить в папку командой Файл–>Сохранить в папку.

На вкладке "Опции" одна часть параметров недоступна для изменений (пользовательские классы и пользовательские строки списков всегда хранимые и допускают хранимые ссылки), а другая часть, касающаяся настроек для версионности может быть задана пользователем (подробнее о том, какими бывают классы с точки зрения версионности см. Свойства веток, Таблица 2).

Внимание! Опцию "Единые данные в ветках" можно изменить только при создании класса. Изменить ее у уже существующих классов (как системных, так и пользовательских) нельзя.

На вкладке "Доп. опции" определяется набор дополнительных опций класса. Из контекстного меню можно вносить доп. опции по категориям. Поддерживается мультистрочный ввод значений дополнительных опций. Удаление опции производится из контекстного меню выбором пункта "Удалить строку". Описание дополнительных опций класса приведено в Таблице 3 Дополнительные опции класса.

Внимание! Для системных классов часть дополнительных опций уже заполнена по умолчанию, такие дополнительные опции недоступны для редактирования и выделяются на вкладке "Доп. опции" серым цветом. Все остальные дополнительные опции для системных классов доступны для заполнения.

Для пользовательских классов все дополнительные опции доступны для заполнения.

Для ряда текстовых опций, таких как ClassHeader, Hint, Description, возможен ввод значений на нескольких языках. Для этого используется префикс, содержащий код языка ("ru", "kz", "by" и т.д.).
Пример. У класса Оргединица указаны следующие опции: RepositoryView.ClassHeader – OrgUnit, RepositoryView.ClassHeader.ru – Оргединица.

Также поддерживаются значения по умолчанию для мультиязычных параметров. Чтобы задать значение по умолчанию для языкового параметра нужно вписывать его значение с языковым суффиксом.

В метаданных в значениях по умолчанию имеется поддержка формулы-ссылки на значение доп. опции класса: =ИмяДопопции.

Для локализации мультиязычных значений ОПУ (параметр Название) нужно добавить язык интерфейса (в MetaEdit через Настройки - Языки Интерфейса), перевести значение ОПУ на этот язык и поместить этот перевод в качестве значения допопции RepositoryView.Header с суффиксом добавленного языка. После этого при применении в добавляемом классе появится значение на соответствующем языке данных в ОПУ. Если нужно завести другую опцию для этих целей, её название должно начинаться с префикса Resx. Рекомендуется называть такие опции Resx_СистемноеНазваниеПараметра.

Логика работы кнопки Заполнить умолчания следующая: если у класса есть параметр Название, то ему в качестве значения по умолчанию выставляется формула со ссылкой на опцию RepositoryView.Header. При этом, если метаданные мультиязычные, то значение по умолчанию задается для всех локализованных параметров (Название_en, Название_ru_RU,…), а ссылка в формуле задается на локализованную опцию на том же языке, что и параметр (RepositoryView.Header.en).

Если метаданные были немультиязычные и у параметра было значение по умолчанию, то при добавлении языков данных в значениях по умолчанию класса должны появиться значения для всех локализованных параметров (если там были ссылки на опцию, то для каждого локализованного параметра должна указываться опция для его языка)

Если же из мультиязычных метаданных делают немультиязычные, то значение по умолчанию для локализованного параметра на основном языке данных должно попасть к мультиязычному параметру, а сама опция - потерять признак языка.

Внимание! Не рекомендуется править файлы ресурсов языков, поставляемых вместе с Business Studio. Они перезаписываются своими новыми версиями в рамках конвертации при обновлении версии программы.

На вкладке "Ключи" задаются ключи для класса - как простые (уникальность проверяется по одному параметру), так и составные (уникальность проверяется по сочетанию нескольких параметров). Удаление ключа производится из контекстного меню по пункту "Удалить строку".

При создании нового класса, требуется вручную завести для него ключи, если на этот класс будут ссылаться с помощью параметров типа "Объект" из других классов.

Это требование применимо, если класс создается в качестве потомка от класса, не имеющего ключей (например, от "Строки списков"). При создании же класса от родителя, имеющего ключи (например, "Объекты системы" - ключ "guid"), отдельно создавать ключи не требуется.

Пример: создание для класса из числа потомков класса "Строки списков" вложенного списка/структуры (получается, что во вложенном списке/структуре окажется объектный параметр "Владелец" со ссылкой на родительский класс).

В случае, если для любого класса из числа потомков класса "Строки списков" (для определённости назовём его "Класс 1") создаётся параметр с типом "Список" или "Структура", необходимо для этого класса сделать следующее:

1. Создать параметр, значения которого будут уникальными в рамках класса, являющегося владельцем класса "Класс 1". Это может быть, например, "Номер документа", если список представляет собой список документов. В дальнейшем потребуется заполнять значение этого параметра для каждой строки списка с соблюдением этого условия по уникальности.
2. В окне редактирования класса, на вкладке "Ключ" создать для класса "Класс 1" новый ключ, в который включить 2 параметра: параметр, созданный в предыдущем пункте, и параметр "Владелец".
3. Применить изменения к базе данных.

Это справедливо и для случаев, когда уровней вложенности несколько: например, если у класса "Класс 1" из числа потомков класса "Строки списков" есть список, ссылающийся на класс "Класс 2", а у того - список, ссылающийся на класс "Класс 3", то описанное выше следует сделать для классов "Класс 1" и "Класс 2".

В системе предусмотрено два вида операций с параметрами классов:

• Создание параметров.
  Параметры создаются в хранимых классах. Хранимый класс соответствует таблице СУБД, в которую добавляются новые колонки.
• Назначение параметров классу.
  Подклассам хранимого класса может быть назначено произвольное подмножество параметров, определенных у хранимого класса или у его хранимых надклассов. Назначение параметров наследуется у подклассов.

Существует два типовых сценария назначения параметров подклассам:

1. Параметр назначается в надклассе и отключается лишь у некоторых подклассов, где он не нужен.
2. Параметр создается в хранимом надклассе и назначается лишь некоторым подклассам, где он нужен.

Необходимо выбирать сценарий с наименьшей трудоёмкостью настройки.

Для настройки назначения параметров классу необходимо:
1. В Окне свойств класса на вкладке Группы параметров выбрать группу:

2. Выбрать состояние флажка:

Пример. Параметр Описание (Description) создан в классе Предметный объект, так как он нужен у нескольких подклассов. Однако в нем нет необходимости у всех предметных объектов. Поэтому на уровне Предметный объект видимость данного параметра по умолчанию выключена (флажок в группе Видимость параметров снят). В классе Оргединица данный параметр выведен на показ по умолчанию (флажок в группе Видимость параметров установлен).

На вкладке "Значения" устанавливаются значения параметров по умолчанию во вновь создаваемом объекте класса. Для параметров с типом Перечисление (см. Свойства перечисления) значение по умолчанию может быть задано как перечислением наименований выбранных по умолчанию элементов перечисления через запятую, так и в бинарном виде - числом, равным сумме параметров Значение этих элементов перечисления.

Внимание! Для класса обязательно задание значений по умолчанию для параметров guid и Название. Значения могут быть сгенерированы автоматически на основе текущего названия класса с помощью нажатия на кнопку "Задать умолчания" в окне добавления/редактирования класса.

На вкладке "Описание" дается многострочное описание функционального назначения класса и его места в объектной иерархии. Если описание оставить пустым, то оно автоматически заполнится заголовком класса.

На вкладке "Мультиязычные параметры" приводится список мультиязычных параметров класса. Для унаследованных от родительских классов мультиязычных параметров, которые тоже присутствуют в этом окне, флажок, отвечающий за мультиязычность на этой вкладке, по умолчанию установлен, но может быть снят пользователем.

Параметры выделенного класса приведены в правой части окна на вкладке "Параметры".

Все действия с параметрами классов (см. Таблицу 6 ниже) производятся из контекстного меню, вызываемого от параметров на этой вкладке.

При создании параметров необходимо учитывать принцип наследования, описанный в Термины и понятия. Не нужно создавать в классе параметры, дублирующие параметры класса-родителя.

Форма "Настройки параметров класса" (Рис. 4) вызывается при добавлении нового параметра или редактировании существующего. Создание и редактирование возможно только для пользовательских параметров, к  их названию  добавляется префикс usr_.

Внимание! Имя пользовательского параметра должно состоять из букв, цифр и знаков подчеркивания. Начинаться такие имена могут с буквы или со знака подчеркивания.

Вызов параметра на редактирование осуществляется либо выбором соответствующей опции всплывающего меню, либо двойным щелчком на параметре левой кнопкой мыши.

Рисунок 4

На вкладке "Опции" необходимо выбрать тип параметра: простой, объектный, список, структура, перечисление.

Если тип параметра Простой, то необходимо уточнить его тип: логический, целый, строка, вещественный, датавремя, бинарный или текст. Для параметра типа Строка необходимо указать длину, максимум 4000 символов. Для параметра типа Вещественный необходимо указать общую длину и длину дробной части (количество знаков после запятой), максимум 28 символов. Если тип параметра Объектный, то необходимо указать класс, который будет являться типом объектов, на которые будет ссылаться этот параметр.

Если тип параметра Список или Структура, то необходимо указать строки списка, которые будут являться типом объектов, на которые будет ссылаться этот параметр. Указанные таким образом классы должны быть конечными (не иметь потомков) и не должны быть созданы под классами, уже указанными в каких-либо параметрах с типом Список или Структура.

Если тип параметра Перечисление, то в качестве типа объектов указывается перечисление.

Тип параметра выбирается по кнопке .

Внимание! Общая длина (сумма длин всех параметров) класса, заданных на одном уровне в иерархии классов, не должна превышать 8000 Байт. Длина параметров различных типов в байтах приведена ниже в Таблице 7 Длина в байтах для различных типов параметров.

Опция параметра Не хранимый отвечает за то, будет ли параметр сам хранить информацию (хранимый параметр) или же не будет, а будет использоваться для вывода данных, хранящихся в других параметрах системы (не хранимый параметр). Пользовательский параметр может быть не хранимым, примеры создания таких параметров см. в Примеры создания нехранимых параметров с помощью MetaEdit.

Опция параметра Мультиязычный отвечает за то, будет ли параметр мультиязычным, т.е. будет ли он поддерживать одновременно разные значения на разных языках базы. У не мультиязычного параметра объекта будет одно значение вне зависимости от количества языков в базе.

На вкладке "Доп. опции" определяется набор дополнительных опций параметра класса. Они позволяют указывать заголовки, управлять порядком и видимостью по умолчанию, настраивать действия. Из контекстного меню можно вносить доп. опции по категориям. Удаление опции производится из контекстного меню выбором пункта "Удалить выделенные строки". Описание дополнительных опций параметра приведено в Таблице 8 Дополнительные опции параметров классов.

Внимание! Для системных параметров часть дополнительных опций уже заполнена по умолчанию, такие дополнительные опции недоступны для редактирования и выделяются на вкладке "Доп. опции" серым цветом. Все остальные дополнительные опции для системных параметров доступны для заполнения.

Для пользовательских параметров все дополнительные опции доступны для заполнения.

На вкладке "Описание" можно дать многострочное описание функционального назначения параметра класса и его места в объектной иерархии. Если описание оставить пустым, то оно автоматически заполнится заголовком параметра класса.

После создания в метаданных параметра с типом "Структура" и применения этих метаданных к базе необходимо для этой базы запустить команду пересохранения структур класса, в котором такой параметр был добавлен.

Вид командной строки: /runcmd="База.КлиентскиеУтилиты.ПересохранитьСтруктурыКласса СИСТЕМНОЕ_ИМЯ_КЛАССА"

Аргументы:

СИСТЕМНОЕ_ИМЯ_КЛАССА - полное системное имя класса Business Studio (например, БизнесМодель.Процессы), в котором был добавлен параметр с типом "Структура". Системное имя класса отображается в Объектной модели.

Подробнее о работе с командной строкой см. Командная строка.

Классы связей создаются под классом Бинарная связь. Действия при создании класса связи аналогичны созданию классов самостоятельных объектов (см. Создание класса объектов).

Для данных классов также действуют опции ClassHeader и AllowedObjectCreationOfClass. Прочие опции, которые необходимо заполнить, представлены в таблице.

Окно Свойства перечисления (Рис. 5) вызывается при добавлении нового перечисления или редактировании существующего. При создании пользовательских перечислений к их названию добавляется префикс "usr_".

На вкладке Элементы задается список элементов перечисления. Параметры перечисления:

• Значение - числовое значение элемента;
• Название - системное название элемента;
• Описание - заголовок элемента, который отображается в интерфейсе программы.

Вызов перечисления на редактирование осуществляется выбором соответствующего пункта контекстного меню.

Редактирование доступно для:

• параметра Описание системных перечислений на всех языках, кроме Языка по умолчанию (см. Термины) и русского (ru);
• всех параметров пользовательских перечислений на всех языках.

Внимание! Не рекомендуется изменять системное название элемента пользовательского перечисления, так как в этом случае потребуется заново вводить значения параметра Описание на всех языках.

Рисунок 5

Удаление элемента перечисления осуществляется выбором соответствующего пункта контекстного меню.

Параметр Множество позволяет задавать параметру объекта несколько значений из перечисления. При изменении параметра Множество во включенное состояние для уже созданных объектов, информация в базе не теряется. При отключении параметра Множество информация в базе по параметрам объектов этого перечисления утратится.

Внимание! Для независимых элементов перечисления-множества, необходимо значениям элементов присваивать степени двойки: 1,2,4,8,…

На вкладке Доп.опции можно задать значение доп. опций "RepositoryView.Visible" и "PropertyView.Header", их работа идентична работе соответствующих опций классов (см. Таблицу 3 в Свойства класса).

На вкладке Описание дается многострочное описание перечисления.

SQL индексы предназначены для ускорения работы фильтров, где фильтрация происходит по параметрам, которые включены в индекс.

Форма "Добавление SQL индекса" (Рис. 6) вызывается при добавлении нового SQL индекса или редактировании существующего. Создание и редактирование SQL индексов возможно для хранимых справочников. В индекс могут входить хранимые параметры всех типов, кроме списков и структур. К названию SQL индекса добавляется префикс STU_.

Внимание! Добавлять SQL индексы для объектных полей не требуется, так как для них уже присутствуют системные индексы по умолчанию.

Добавление новых и изменение существующих индексов производится выбором соответствующего пункта контекстного меню на вкладке "Индексы".

Рисунок 6