Create doc for subsystem integration management (#115)

* #101 разработана документация к подсистеме управления интеграциями * Добавлены примеры заполнения настроек для FTP-сервера и HTTP-сервиса. Добавлен пример записи истории интеграции * Описан программный интерфейс подсистемы * Добавлены примеры для FTP и SFTP * Добавлен пример с отправкой файла на почту * Добавлен пример взаимодействия с внешними источником данных * Добавлены примеры для COM, внешней компоненты и команды системы * Добавлены примеры работы с пользовательскими функциями
firstBitSportivnaya · Nov 21, 2024 · 19185ec · 19185ec
1 parent 116b22c
commit 19185ec
Show file tree

Hide file tree

Showing 11 changed files with 707 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@
 2. [Соответствия объектов ИБ](docs/СоответствиеОбъектовИнформационнойБазы.md)
 3. [Программная модификация форм](docs/МодификацияФорм.md)
 4. [Подписки на события](docs/ПодпискиНаСобытия.md)
-5. Управление интеграциями
+5. [Управление интеграциями](docs/УправлениеИнтеграциями.md)
 6. [Пользовательские функции](docs/ПользовательскиеФункции.md)
 7. [Настройки отбора объектов](docs/ПолучениеДанныхПоНастройкеОтбора.md)
 8. [Загрузка файла через табличный документ](docs/ЗагрузкаФайлаЧерезТабличныйДокумент.md)

diff --git a/docs/images/ERArchitectureIntegrationsSubsystem.svg b/docs/images/ERArchitectureIntegrationsSubsystem.svg
diff --git a/docs/images/ЗаполнениеПредопределенныхПодсистемыИнтеграции.png b/docs/images/ЗаполнениеПредопределенныхПодсистемыИнтеграции.png
diff --git a/docs/images/ЗапускКонфигуратораВПакетномРежиме.png b/docs/images/ЗапускКонфигуратораВПакетномРежиме.png
diff --git a/docs/images/ПодключениеВнешнегоИсточникаДанныхНастройкиИнтеграции.png b/docs/images/ПодключениеВнешнегоИсточникаДанныхНастройкиИнтеграции.png
diff --git a/docs/images/ПодключениеВнешнейКомпонентыИзФайла.png b/docs/images/ПодключениеВнешнейКомпонентыИзФайла.png
diff --git a/docs/images/ПользовательскаяФункцияВыгрузкиВФайл.png b/docs/images/ПользовательскаяФункцияВыгрузкиВФайл.png
diff --git a/docs/images/ПользовательскаяФункцияИнтеграционныйПоток.png b/docs/images/ПользовательскаяФункцияИнтеграционныйПоток.png
diff --git a/docs/images/ПользовательскаяФункцияНастройкаИнтеграции.png b/docs/images/ПользовательскаяФункцияНастройкаИнтеграции.png
diff --git a/docs/puml/ERArchitectureIntegrationsSubsystem.puml b/docs/puml/ERArchitectureIntegrationsSubsystem.puml
@@ -83,6 +83,7 @@ entity "Справочник: Интеграционные потоки" as eInt
     ТочкаВхода : строка (неогр)
     ПользовательскаяФункция : uuid <<FK>>
     ИзмененВручную : булево
+    НаправлениеПотока: uuid <<FK>>
     --
     Параметры входа 
     --
@@ -116,6 +117,12 @@ enum "Перечисление: Типы параметров интеграци
     + Дата
 }
 
+enum "Перечисление: Направления интеграционных потоков" as eIntDirections {
+    + Исходящий
+    + Входящий
+    + Служебный
+}
+
 entity "Справочник: История интеграции" as eIntHistory {
     *УникальныйИдентификатор : uuid <<generated>>
     --
@@ -134,6 +141,8 @@ entity "Справочник: История интеграции" as eIntHistor
     Пользователь : uuid <<FK>>
     ДлительностьОбмена : число (5, 0)
     ДлительностьВызова : число (5, 0)
+    ИмяФайлаСообщения: Строка (150)
+    ФайлСообщения: хранилище значений
     --
     Объекты интеграции
     --
@@ -147,6 +156,8 @@ enum "Перечисление: Статусы интеграции" as eIntStat
     + Загружено
     + ОшибкаВыгрузки
     + ОшибкаЗагрузки
+    + Служебный
+    + ОшибкаСлужебного
 }
 
 enum "Перечисление: Форматы интеграции" as eIntFormates {
@@ -187,6 +198,7 @@ eIntFlows <- eIntFlows : Родитель
 eIntFlows --> eIntSettings : НастройкаИнтеграции
 eIntFlows --> eUserFunctions : ПользовательскаяФункция
 eIntFlows --> eIntParamsTypes : Тип (параметры входа)
+eIntFlows --> eIntDirections : НаправлениеПотока
 
 eIntHistory --> eSysInt : ИнтегрируемаяСистема
 eIntHistory --> eIntStatuses : Статус

diff --git a/docs/УправлениеИнтеграциями.md b/docs/УправлениеИнтеграциями.md