Предопределенные элементы. Добавление в типовую конфигурацию

Доброго времени суток.

Сегодня поговорим о новшестве в платформе 8.3 касающегося предопределенных элементов.

Вступление

Напомню, что раньше на практике, очень часто хотелось глядя в элемент справочника узнать его предопределенное имя. Например Вы создали два предопределнных контрагента и назвали его ИПСидоров и ОООМетеор. И зашили на них некую логику.

Когда все отладили и отработали, выяснилось, что задача была поставлена наоборот и логика для ИП нужна для ООО, а логика ООО для ИП. "Нет проблем", говорим мы и в режиме предприятия переименовываем элементы. Ведь лезть в код гораздо сложнее. Проходит год и Вам поставлена новая задача: для ИП Сидорова настроить еще какую-то логику. Вы лезете в конфигуратор, пишите логику, начинаете проверять и ничего не работает, т.к. в конфигураторе ИПСидоров, а в предприятии - ОООМетеор. Мозг сломан и эти грабли хочется уничтожить. Самое простое и наглядное - это вывести имя предопределенного элемента в форму списка. Вот тут засада, получить имя предопределенного в 8.2 можно только методом. А метод это свои неудобства, его нельзя получить в запросе. Т.е. первое неудобство - получить имя предопределенного по ссылке на справочник.

Второе неудобство, когда мы уже имеем элемент справочника и нам надо его сделать предопределенным. Мы создаем предопределенный элемент и получаем два элемента в справочнике. Один предопределенный, другой рабочий, на который ссылаются все наши документы. Замена ссылок конечно выручает, но если база большая, то это тяжко.

Теперь по делу

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

Что нам дает это поле? Если оно установлено в "Не обновлять автоматически", то добавив предопределенный элемент, мы его не увидим в справочнике сразу. Т.е. метаданные никак не связаны с данными. И если его не создать в справочнике, то и обращение к нему по его имени через менеджер справочника вызовет синтаксическую ошибку.

Очень интересно, а зачем? Как же нам создать элемент в справочнике? А как хотите, можете создать, а можете и связать его с уже существующим. Теперь у справочника есть реквизит "ИмяПредопределенныхДанных". Мы создаем элемент справочника программно как обычно через "Справочники.Контрагенты.СоздатьЭлемент()" и заполняем его реквизит "ИмяПредопределенныхДанных" равным имени предопределенного элемента. Или же если элемент уже есть, получаем его объект и в нем опять таки заполняем "ИмяПредопределенныхДанных". Все.

И на последок немного сиропа

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

Спасибо за внимание.

Печать (Ctrl+P)

Работа с предопределенными значениями с помощью менеджера объекта

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

ТипПредопределенногоЗначения.ИмяОбъектаМетаданных.Значение


ТипПредопределенногоЗначения – для получения предопределенных значений доступно указание следующих типов данных (написание во
множественном числе):
● Справочники,
● ПланыВидовХарактеристик,
● ПланыСчетов,
● ПланыВидовРасчета,
● Перечисления.
ИмяОбъектаМетаданных

● Значение – может быть одним из следующих:
● для перечислений указывается имя значения перечисления;

● ТочкиМаршрута.ИмяТочки – точка маршрута бизнес-процесса.
В случае, если требуется получить точку маршрута бизнес-процесса, строка, описывающая получаемое значение, будет выглядеть следующим образом:

БизнесПроцессы.ИмяОбъектаМетаданных.ТочкиМаршрута.ИмяТочкиМаршрута
Пример:


Вид = Перечисления.ВидыТоваров.Товар;
// Получение предопределенных данных справочника.
Элемент = Справочники.Валюта.Рубль;
// Точка маршрута бизнес-процесса
Точка = БизнесПроцесс.Согласование.ТочкиМаршрута.Одобрение;

Работа с предопределенными значениями С помощью функции ПредопределенноеЗначение()

В связи с тем, что на стороне клиента недоступны прикладные объекты, получение предопределенных реквизитов с помощью менеджеров объектов становится невозможным. Поэтому для их получения существует метод глобального контекста ПредопределенноеЗначение(). Параметром этого метода является строка, описывающая то, какое предопределенное значение требуется получить. Синтаксис описания предопределенного значения совпадает с синтаксисом оператора ЗНАЧЕНИЕ языка запросов.
Строка, определяющая получаемый реквизит, имеет следующий вид:

Рассмотрим составляющие этой строки подробнее:
ТипПредопределенногоЗначения – для получения предопределенных значений доступно указание следующих типов данных (написание в
единственном числе):
● Справочник ,
ПланВидовХарактеристик ,
● ПланСчетов ,
ПланВидовРасчета ,
● Перечисление,
● БизнесПроцесс .
● ИмяОбъектаМетаданных – указывается имя объекта метаданных так, как оно задано в конфигураторе.
● Значение – может быть одним из следующих

● для перечислений указывается имя значения перечисления;
● для получения предопределенного значения указывается его имя, как оно задано в конфигураторе;
● ТочкаМаршрута.ИмяТочки – точка маршрута бизнес-процесса;
● ПустаяСсылка – для получения пустой ссылки.
В случае необходимости получить значение системного перечисления параметр метода будет выглядеть следующим образом:
ИмяСистемногоПеречисления.ЗначениеСистемногоПеречисления.
Например:

ТипДиаграммы = ПредопределенноеЗначение(“ТипДиаграммы.ВогнутаяПоверхность “);
В случае если требуется получить точку маршрута бизнес-процесса, строка, описывающая получаемое значение, будет выглядеть следующим образом:
Пример:

// Получение значения перечисления.
Вид = ПредопределенноеЗначение (“Перечисление.ВидыТоваров.Товар”);
// Получение значения пустой ссылки.
ПустаяСсылка =
ПредопределенноеЗначение (“Документ.РасходнаяНакл.ПустаяСсылка”);
// Получение предопределенных данных справочника.
Элемент = ПредопределенноеЗначение (“Справочник.Валюта.Рубль”);
// Точка маршрута бизнес-процесса
Точка = ПредопределенноеЗначение (“БизнесПроцесс.Согласование. ТочкаМаршрута.Одобрение”);

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

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

Этот элемент используется во многих модулях конфигурации. Так в документе "Поступление товаров и услуг" при выполнении проведения во всех регистрах, где есть измерение "Качество", подставляется значение предопределенного элемента. Далее приведен листинг заполнения таблицы проведения по регистру "ТоварыОрганизаций":

// ТОВАРЫ ПО РЕГИСТРУ ТоварыОрганизаций. НаборДвижений = Движения. ТоварыОрганизаций; Если ВидПоступления = Перечисления. ВидыПоступленияТоваров. НаСклад Тогда // Получим таблицу значений, совпадающую со структурой набора записей регистра. ТаблицаДвижений = НаборДвижений. Выгрузить() ; // Заполним таблицу движений. ОбщегоНазначения. ЗагрузитьВТаблицуЗначений(ТаблицаПоТоварам, ТаблицаДвижений) ; // Недостающие поля. ТаблицаДвижений. ЗаполнитьЗначения(Организация, " Организация " ) ; ТаблицаДвижений. ЗаполнитьЗначения(Неопределено , " Комиссионер " ) ; ТаблицаДвижений. ЗаполнитьЗначения(Справочники. Качество. Новый , " Качество " ) ; // Заполняем качество из предопределенного элемента

Таким образом, характерные черты предопределенных элементов и их назначение достаточно просты. Рассмотрим способ их хранения в таблицах базы данных и его отличие от обычных элементов.

Различия

В тестовой конфигурации создан справочник "Товары". В нем создана группа "Тестовые элементы". Содержимое группы Вы могли видеть на скриншоте в начале статьи. Для справочника "Товары" в SQL-базе данных имеется соответствующая таблица "_Reference37" со следующей структурой:

Но как определить соответствие реквизитов дереве конфигурации и полей в SQL-таблице?

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

В таблице значений "Поля" мы видим соответствие полей SQL-таблицы и реквизитов объекта в дереве метаданных. В нашем примере мы рассматриваем структуру справочника "Товары". У всех справочников есть стандартный реквизит "Предопределенный"булевого типа, который для предопределенных элементов установлен в ИСТИНА:

По таблице со структурой хранения справочника в базе данных мы однозначно можем сказать, что поле "Предопределенный" соответствует полю "IsMetadata". Если мы просмотрим содержимое таблицы "_Reference37" в SQL-базе, то увидим следующее:

В записи для предопределенного элемента значение поля "IsMetadata" установлено в "0x01", что соответствует флагу ИСТИНА. Для обычных элементов значение установлено в "0x00". В этом и заключается главное отличие предопределенных элементов от обычных. Все остальные поля хранятся в базе данных аналогично полям обычных элементов, добавленных пользователями.

Предопределенным элементам можно найти очень интересное предназначение. С их помощью можно запретить удалять/помечать на удаление группы элементов в справочнике и других объектах, где их можно добавить. Если мы попытаемся удалить или пометить на удаление группу "Тестовые элементы". то получим такие ошибки:

Таким образом, предопределенные элементы делают группу, в которую они помещены, тоже "предопределенной".

Завершение

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

При работе на платформе 1С:Предприятие 8.x часто возникает необходимость привязаться в программном коде к обычным (не предопределенным) элементам справочников. Например у организации может быть пять видов цен, которые используются практически во всех механизмах. При этом программное обращение к конкретной цене в лучшем случае осуществляется либо писком по коду в справочнике, в худшем по наименованию элемента.

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

В результате мы получаем нестабильный отчет, который перестанет работать при изменении наименования типа цены. Если же привязываться к коду элемента, то всегда присутствует возможность его изменения. Например, из-за нарушения уникальности кодов справочника администратор может запустить перенумерацию объектов, что приведет к изменению кодов элементов и отчет перестанет работать корректно.

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

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

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

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

Универсальное решение

Суть универсального решения будет заключаться в следующем: будет создан справочник, в который разработчиком будут добавляться предопределенные элементы. В справочник добавлен реквизит "Значение", тип которого зависит от значений, для которых будет создаваться соответствие "Предопределенный элемент справочника -> Связанной значение". Структура метаданных справочника выглядит следующем образом (см. следующий скриншот).

Для получения предопределенного элемента наилучшим вариантом является использование глобального метода "ПредопределенноеЗначение(<Имя>)" . В качестве параметра в метод передается полный путь к предопределенному элементу. Синтаксис похож на функцию языка запросов "ЗНАЧЕНИЕ()" .

Для удобства разработки рекомендую вынести функцию для получения связанного с предопределенным элементом значения в общий модуль. В тестовой конфигурации, доступной для скачивания по ссылке в конце статьи, создан общий модуль "ЗначенияПредопределенныхЭлементов" с экспортной функцией "ПолучитьЗначениеПредопределенногоЭлемента(<ИмяПредопределенногоЭлемента>)" . Программный код функции получает ссылку на предопределенный элемент, затем запросом получает значений реквизита "Значение". На следующем скриншоте приведен полный листинг функции.

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

Влияние на производительность

Проводил тест на скорость для обоих вариантов поиска: по наименованию и по ссылке из предопределенного элемента. Поиск проходил по справочнику "Товары" с 20000 записей. При проведении тестов на файловой базе были получены следующие результаты:

Результаты показали, что для файлового варианта работы использование предопределенных элементов для получения часто используемых элементов других справочников работает медленнее практически в 4 раза!

В клиент-серверном варианте работы результаты тестов показывают совсем другую картину. Скорость получения ссылка на нужный элемент не снизилась значительно (один из тестов показал 0.002 сек. для поиска по наименованию и 0.0008 сек. при работе через предопределенный элемент), однако надежность работы программы увеличилась в разы!

Выводы

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

За время работы с платформой не раз встречался с ситуациям, когда после изменения наименования, например у элемента справочника "ТипыЦенНоменклатуры", слетала работа у большинства не типовых отчетов.

Чем больше алгоритмов связаны с обычными элементами справочников через код или наименование, тем менее устойчива система.

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

Файлы для загрузки:

  1. Выгрузка тестовой базы с примерами из статьи.

На четвертом уроке нашего мы продолжим знакомиться с программой . Сегодня мы на практических примерах познакомимся с и ерархическими справочниками, а также научимся создавать предопределенные элементы .

Хронометраж 4 урока курса:

00:19 Изменения в справочнике Сотрудники после выполнения домашнего задания по 3 уроку курса
00:35 Редактирование порядка следования реквизитов в справочниках
02:54 Создание справочника Номенклатура
03:40 Создание и настройка иерархического справочника
05:10 Создание групп Услуги и Товары в справочнике Номенклатура
06:05 Заполнение справочника Номенклатура
07:14 3 способа переноса элемента справочника в другую группу
08:21 Создание справочника Склады
09:19 Создание предопределенных элементов справочника
11:25 Заполнение справочника Склады
12:20 Пройти тест по материалу 4 урока

Иерархический справочник – справочник с возможностью иерархического расположения его элементов. Например, в справочнике Номенклатура могут быть созданы группы: Товары, Услуги и т.д., в которых располагаются элементы, относящиеся к этим группам. Кроме того группы справочника могут включать в себя и другие группы, создавая тем самым многоуровневую иерархическую структуру.

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

Формы справочника – визуальное представление справочника. В зависимости от того, какие именно действия мы хотим выполнить с нашим справочником, нам требуется отображать справочник в «различных видах». Так, на 4 уроке курса мы с вами редактировали порядок следования реквизитов в форме списка и в форме элемента справочника.

Система создает (генерирует) формы автоматически, но, при необходимости, разработчик можем «рисовать» формы самостоятельно.

Всего для справочников существует 5 форм (типов форм):

  • форма элемента – для создания или редактирования элемента справочника;
  • форма группы - для создания или редактирования группы справочника;
  • форма списка – для отображения списка элементов справочника;
  • форма выбора - используется, чтобы в поле некой формы выбрать один из элементов данного справочника. Например, чтобы в документе Поступление товара в поле склад выбрать конкретный склад из справочника Склады;
  • форма выбора групп – используется, чтобы в поле некой формы выбрать одну из групп данного справочника.

Предопределенные элементы справочника – элементы справочника, создаваемые разработчиком в режиме Конфигуратора, и к которым можно обращаться из встроенного языка 1с по Имени.

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

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

Домашнее задание по 4 уроку курса

Домашнее задание по четвертому уроку курса будет вам доступно сразу после успешного решения теоретического теста.