Added automatic creation of predefined elements (#144)

* Добавлена автоматическая генерация/изменение предопределенных элементов, оповещения о конфликтах предопределенных элементов и документация
firstBitSportivnaya · Nov 20, 2024 · 2b99cf1 · 2b99cf1
1 parent 9b2965a
commit 2b99cf1
Show file tree

Hide file tree

Showing 20 changed files with 614 additions and 83 deletions.
diff --git a/docs/images/ФормаРазрешенияКонфликтов.png b/docs/images/ФормаРазрешенияКонфликтов.png
diff --git a/docs/ПредопределенныеЗначения.md b/docs/ПредопределенныеЗначения.md
@@ -19,6 +19,71 @@
 КонецПроцедуры
 ```
 
+## Уникальность предопределенных элементов
+
+Для обеспечения целостности данных и управления предопределёнными значениями реализован механизм контроля изменений. Он основан на вычислении хеша с использованием алгоритма **MD5**, учёте пометки на удаление, ручных изменений и проверке уникальности идентификаторов.
+
+### Основные этапы проверки
+1. **Первоначальная проверка уникальности идентификаторов:**
+    - На этапе инициализации идентификаторы всех элементов проверяются на уникальность.
+    - Если обнаружены коллизии (дублирующиеся идентификаторы), будет выдано сообщение об ошибке, и такие элементы будут пропущены.
+2. **Хеш и состояние элемента:**
+    - Хеш вычисляется для каждого элемента и сохраняется в регистре **состояний предопределённых элементов**.
+      - **Ключи хеша:**
+        - ИдентификаторНастройки
+        - Наименование
+        - Родитель (если включена иерархия)
+        - ЭтоГруппа (если включена иерархия групп и элементов)
+        - Изменяемые реквизиты при расчете не учитываются
+        - Остальные ключи опционально, зависят от типа объекта метаданных (см. [область Структуры колонок таблиц](../src/cf/CommonModules/пбп_ПредопределенныеЗначенияПереопределяемый/Ext/Module.bsl#247-343) и [исключаемые поля для расчета хеша](../src/cf/CommonModules/пбп_ПредопределенныеЗначенияПереопределяемый/Ext/Module.bsl#345-381))
+    - Если элемент изменяется в пользовательском режиме, устанавливается флаг **ручное изменение:**
+      - Такой элемент исключается из проверки хеша при последующих обновлениях.
+3. **Обработка элементов с пометкой на удаление:**
+    - Если элемент помечен на удаление и его хеш отличается от нового:
+      - Значения элемента обновляются данными из кода.
+      - Пометка на удаление снимается автоматически.
+    - Если элемент не помечен на удаление и его хеш отличается от нового:
+      - Формируется уведомление о конфликте для дальнейшего разрешения.
+
+**Пример решения конфликтов при создании/обновлении предопределенных элементов**
+
+![image](images/ФормаРазрешенияКонфликтов.png)
+
+Виды ошибок:
+- Коллизии идентификаторов
+  - Эта ошибка не решается в пользовательском режиме, для ее устранения необходимо перейти в общий модуль ``пбп_ПредопределенныеЗначенияПереопределяемый`` и исправить конфликтующие элементы.
+- Расхождение элемента с кодом
+  - Для элемента установлен флаг обновления: Элемент будет обновлен данными из программного кода, а также обновится хеш элемента в регистре сведений **``пбп_СостоянияПредопределенныхЭлементов``**.
+  - Для элемента не установлен флаг обновления: Элемент не будет обновлен. В записи регистра сведений **``пбп_СостоянияПредопределенныхЭлементов``** будет установлен флаг **``Ручное изменение``**, указывающий на то, что элемент был изменен вручную и не подлежит автоматическому обновлению в будущем.
+
+  **Примечание** - Флаг ``Заменить элементом из кода`` активен только для элементов с видом ошибки ``Расхождение элемента с кодом``
+
+## Автоматическое создание новых элементов
+
+Для автоматизации процесса заполнения предопределенных элементов необходимо модифицировать/добавить в расширение общий модуль **``ОбщегоНазначенияПереопределяемый``**. В процедуре **``ПриДобавленииСерверныхОповещений``** требуется добавить новое серверное оповещение.
+
+**Пример кода для подключения через расширение**
+
+```BSL
+&После("ПриДобавленииСерверныхОповещений")
+Процедура пбп_ПриДобавленииСерверныхОповещений(Оповещения)
+
+    // Создаем новое серверное оповещение для предопределённых значений
+    Оповещение = СерверныеОповещения.НовоеСерверноеОповещение("пбп_ПредопределенныеЗначения");
+	
+    // Указываем модуль для получения и отправки сообщений
+    Оповещение.ИмяМодуляОтправки  = ""; // В данном случае используется рег. задание для отправки
+    Оповещение.ИмяМодуляПолучения = "пбп_ПредопределенныеЗначенияСлужебныйКлиент";
+    
+    // Настраиваем периодичность проверки (в секундах)
+    Оповещение.ПериодПроверки = 300;
+	
+    // Добавляем новое оповещение в список оповещений
+    Оповещения.Вставить(Оповещение.Имя, Оповещение);
+
+КонецПроцедуры
+```
+
 ## Добавление новых элементов
 
 В модуле **пбп_ПредопределенныеЗначенияПереопределяемый** значения добавляются через метод **Добавить()** коллекции **Результат**, которая представляет собой таблицу предопределённых значений. Каждая новая запись в этой таблице может быть настроена как группа путём установки свойства ЭтоГруппа в значение Истина.  

diff --git a/src/cf/CommonForms/пбп_ФормаРазрешенияКонфликтовПредопределенныхЭлементов/Ext/Form.xml b/src/cf/CommonForms/пбп_ФормаРазрешенияКонфликтовПредопределенныхЭлементов/Ext/Form.xml
@@ -116,6 +116,14 @@
 					<ContextMenu name="ТаблицаКонфликтовЗаменитьЭлементомИзКодаКонтекстноеМеню" id="27"/>
 					<ExtendedTooltip name="ТаблицаКонфликтовЗаменитьЭлементомИзКодаРасширеннаяПодсказка" id="28"/>
 				</CheckBoxField>
+				<InputField name="ТаблицаКонфликтовКоллизииИдентификатора" id="36">
+					<DataPath>ТаблицаКонфликтов.Ошибка</DataPath>
+					<ReadOnly>true</ReadOnly>
+					<EditMode>EnterOnInput</EditMode>
+					<ExtendedEditMultipleValues>true</ExtendedEditMultipleValues>
+					<ContextMenu name="ТаблицаКонфликтовКоллизииИдентификатораКонтекстноеМеню" id="37"/>
+					<ExtendedTooltip name="ТаблицаКонфликтовКоллизииИдентификатораРасширеннаяПодсказка" id="38"/>
+				</InputField>
 				<ColumnGroup name="ГруппаЭлементВБазе" id="19">
 					<Title>
 						<v8:item>
@@ -176,6 +184,17 @@
 						<v8:Type>xs:boolean</v8:Type>
 					</Type>
 				</Column>
+				<Column name="Ошибка" id="2">
+					<Title>
+						<v8:item>
+							<v8:lang>ru</v8:lang>
+							<v8:content>Ошибка</v8:content>
+						</v8:item>
+					</Title>
+					<Type>
+						<v8:Type>cfg:EnumRef.пбп_ВидыОшибокПредопределенныхЭлементов</v8:Type>
+					</Type>
+				</Column>
 			</Columns>
 		</Attribute>
 		<Attribute name="ОбработатьЭлементы" id="4">

diff --git a/...cf/CommonForms/пбп_ФормаРазрешенияКонфликтовПредопределенныхЭлементов/Ext/Form/Module.bsl b/...cf/CommonForms/пбп_ФормаРазрешенияКонфликтовПредопределенныхЭлементов/Ext/Form/Module.bsl
@@ -14,6 +14,8 @@
 		ОбработатьКонфликтныеЭлементы(АдресТаблицы);
 	КонецЕсли;
 
+	УстановитьУсловноеОформление();
+
 КонецПроцедуры
 
 &НаКлиенте
@@ -76,13 +78,14 @@
 	ДобавляемыеРеквизиты = Новый Структура;
 	Для Каждого Колонка Из Таблица.Колонки Цикл
 		Если ИсключаемыеПоля.Свойство(Колонка.Имя)
-			Или СтрНачинаетсяС(Колонка.Имя, "Служеб_") Тогда
+			Или СтрНачинаетсяС(Колонка.Имя, "Служебный_") Тогда
 			Продолжить;
 		КонецЕсли;
 		ДобавляемыеРеквизиты.Вставить(ПрефиксКод + Колонка.Имя, Колонка.ТипЗначения);
 		ДобавляемыеРеквизиты.Вставить(ПрефиксБаза + Колонка.Имя, Колонка.ТипЗначения);
 		Поля.Добавить(Колонка.Имя, Колонка.Имя);
 	КонецЦикла;
+
 	пбп_РаботаСФормами.СоздатьРеквизитыТаблицы(ЭтотОбъект, "ТаблицаКонфликтов", ДобавляемыеРеквизиты);
 
 	ШиринаКолонки = 5;
@@ -121,7 +124,7 @@
 
 	МенеджерОбъекта = пбп_ОбщегоНазначенияСлужебный.МенеджерОбъектаПоПолномуИмени(ИмяФормыВладельца);
 
-	СписокПредопределенных = Таблица.ВыгрузитьКолонку("Служеб_ПредопределенныйЭлемент");
+	СписокПредопределенных = Таблица.ВыгрузитьКолонку("Служебный_ПредопределенныйЭлемент");
 
 	Запрос = Новый Запрос;
 	Запрос.Текст = 
@@ -150,14 +153,18 @@
 			нСтрока[ПрефиксКод + КлючЗначение.Ключ] = КлючЗначение.Значение;
 		КонецЦикла;
 
+		Если Строка.Служебный_ДублированиеИдентификаторов Тогда
+			нСтрока.Ошибка = Перечисления.пбп_ВидыОшибокПредопределенныхЭлементов.ДублированиеИдентификаторов;
+		Иначе
+			нСтрока.Ошибка = Перечисления.пбп_ВидыОшибокПредопределенныхЭлементов.РасхождениеЭлементаСКодом;
+		КонецЕсли;
+
 		Выборка.Сбросить();
-		Если Выборка.НайтиСледующий(Строка.Служеб_ПредопределенныйЭлемент, "Ссылка") Тогда
+		Если Выборка.НайтиСледующий(Строка.Служебный_ПредопределенныйЭлемент, "Ссылка") Тогда
 			ЗаполнитьЗначенияСвойств(БазоваяСтруктура, Выборка);
 			Для Каждого КлючЗначение Из БазоваяСтруктура Цикл
 				нСтрока[ПрефиксБаза + КлючЗначение.Ключ] = КлючЗначение.Значение;
 			КонецЦикла;
-		Иначе
-			СообщитьОбОтсутствииЭлемента(Строка.ИдентификаторНастройки);
 		КонецЕсли;
 	КонецЦикла;
 
@@ -181,13 +188,23 @@
 	Таблица.Индексы.Добавить(ИдентификаторНастройки);
 	Для Каждого Строка Из ТаблицаКонфликтов Цикл
 		Стр = Таблица.Найти(Строка[ПрефиксКод + ИдентификаторНастройки], ИдентификаторНастройки);
+
+		Если Строка.Ошибка = Перечисления.пбп_ВидыОшибокПредопределенныхЭлементов.ДублированиеИдентификаторов Тогда
+			Таблица.Удалить(Стр);
+			Продолжить;
+		КонецЕсли;
+
 		Если Строка.ЗаменитьЭлементомИзКода Тогда
-			Стр.Служеб_ОбновитьЭлемент = Истина;
+			Стр.Служебный_ОбновитьЭлемент = Истина;
 		Иначе
-			Стр.Служеб_УстановитьФлагРучноеИзменение = Истина;
+			Стр.Служебный_УстановитьФлагРучноеИзменение = Истина;
 		КонецЕсли;
 	КонецЦикла;
 
+	Если Не ЗначениеЗаполнено(Таблица) Тогда
+		Возврат;
+	КонецЕсли;
+
 	Менеджер = пбп_ОбщегоНазначенияСлужебный.МенеджерОбъектаПоПолномуИмени(ИмяФормыВладельца);
 	ДопПараметры = пбп_ПредопределенныеЗначения.ДопПараметрыОбработкиПредопределенныхЭлементов(
 		Таблица, Менеджер);
@@ -199,24 +216,31 @@
 Процедура ЗаполнитьОтметки(ЗначениеОтметки)
 	Модифицированность = Истина;
 	Для Каждого Строка Из ТаблицаКонфликтов Цикл
+		Если Строка.Ошибка =
+			ПредопределенноеЗначение("Перечисление.пбп_ВидыОшибокПредопределенныхЭлементов.ДублированиеИдентификаторов") Тогда
+			Продолжить;
+		КонецЕсли;
 		Строка.ЗаменитьЭлементомИзКода = ЗначениеОтметки;
 	КонецЦикла;
 КонецПроцедуры
 
-#Область СообщенияОСобытии
-
 &НаСервере
-Процедура СообщитьОбОтсутствииЭлемента(Идентификатор)
+Процедура УстановитьУсловноеОформление()
+
+	УсловноеОформление.Элементы.Очистить();
 
-	ТекстСообщения = НСтр("ru = 'Элемент '%1' отсутствуют в базе!';
-							|en = 'The element '%1' is missing from the database!'");
-	ТекстСообщения = пбп_СтроковыеФункцииСлужебныйКлиентСервер.ПодставитьПараметрыВСтроку(
-		ТекстСообщения,
-		Идентификатор);
-	пбп_ОбщегоНазначенияСлужебный.СообщитьПользователю(ТекстСообщения);
+	Элемент = УсловноеОформление.Элементы.Добавить();
+
+	ПолеЭлемента = Элемент.Поля.Элементы.Добавить();
+	ПолеЭлемента.Поле = Новый ПолеКомпоновкиДанных(Элементы.ТаблицаКонфликтовЗаменитьЭлементомИзКода.Имя);
+
+	ОтборЭлемента = Элемент.Отбор.Элементы.Добавить(Тип("ЭлементОтбораКомпоновкиДанных"));
+	ОтборЭлемента.ЛевоеЗначение = Новый ПолеКомпоновкиДанных("ТаблицаКонфликтов.Ошибка");
+	ОтборЭлемента.ВидСравнения = ВидСравненияКомпоновкиДанных.Равно;
+	ОтборЭлемента.ПравоеЗначение = Перечисления.пбп_ВидыОшибокПредопределенныхЭлементов.ДублированиеИдентификаторов;
+
+	Элемент.Оформление.УстановитьЗначениеПараметра("ТолькоПросмотр", Истина);
 
 КонецПроцедуры
 
 #КонецОбласти
-
-#КонецОбласти
diff --git a/src/cf/CommonModules/пбп_МетодыРегламентныхЗаданийСервер/Ext/Module.bsl b/src/cf/CommonModules/пбп_МетодыРегламентныхЗаданийСервер/Ext/Module.bsl
@@ -48,4 +48,15 @@
 
 КонецПроцедуры
 
+// Заполнение предопределенных элементов, с выводом серверного оповещения при возникновении конфликтов.
+//
+Процедура ЗаполнениеПредопределенныхЭлементов() Экспорт
+
+	пбп_ОбщегоНазначенияСлужебный.ПриНачалеВыполненияРегламентногоЗадания(
+		Метаданные.РегламентныеЗадания.пбп_ЗаполнениеПредопределенныхЭлементов);
+
+	пбп_ПредопределенныеЗначения.ЗаполнениеПредопределенныхЭлементов(Истина);
+
+КонецПроцедуры
+
 #КонецОбласти
diff --git a/src/cf/CommonModules/пбп_ОбновлениеИнформационнойБазыПБП/Ext/Module.bsl b/src/cf/CommonModules/пбп_ОбновлениеИнформационнойБазыПБП/Ext/Module.bsl
@@ -74,7 +74,7 @@
 Процедура ПриДобавленииПодсистемы(Описание) Экспорт
 
 	Описание.Имя = "ПроектнаяБиблиотекаПодсистем";
-	Описание.Версия = "1.0.3.12";
+	Описание.Версия = "1.0.4.13";
 
 	// Требуется библиотека стандартных подсистем.
 	Описание.ТребуемыеПодсистемы.Добавить("СтандартныеПодсистемы");
@@ -126,14 +126,7 @@
 
 Процедура НачальноеЗаполнениеПредопределенныхЭлементов() Экспорт
 
-	Типы = Метаданные.ОпределяемыеТипы.пбп_ПредопределенныеВсеСсылкиПереопределяемый.Тип.Типы();
-
-	Для Каждого Тип Из Типы Цикл
-		ПолноеИмя = Метаданные.НайтиПоТипу(Тип).ПолноеИмя();
-		Менеджер = пбп_ОбщегоНазначенияСлужебный.МенеджерОбъектаПоПолномуИмени(ПолноеИмя);
-
-		пбп_ПредопределенныеЗначения.ИнициализироватьПредопределенныеЗначения(Менеджер);
-	КонецЦикла;
+	пбп_ПредопределенныеЗначения.ЗаполнениеПредопределенныхЭлементов();
 
 КонецПроцедуры