Standart

Описание команд всех библиотек и сервисов, которые входят в состав Standart.

Список версий

16.0.0

• Добавлен сервис аналитики analytics

15.0.0

• Добавлен ReadyStatus в BasicServicePreparer и RegistrationAndHealthModule. Статус Ready назначается только после инициализации всех обязательных компонентов приложения
• Библиотеки Verdi обновлены до версии 3.1.0

13.1.1

sed-comment

• Добавлен токен COMMENT_SHOULD_CHECK_SNAPSHOT, который начинает учитывать снэпшотные стадии - у предыдущих стадий скрываются кнопки действий
• Добавлен isSnapshot в ответы к комментариям FRGU-2461

13.1.0

• Добавлена команда sedTaskManager_deleteTaskAttaches
• Изменён формат ответа команды sedTaskManager_createTaskWithAttachByResponsible, команда возвращает кортеж из списка созданных задач и вложений
• Добавлено каскадное удаление вложений при удалении задачи
• Обновлено verdi до 1.11.7
• Добавлены команды в клиент сервиса job-scheduler
• Добавлена команда создания выходных в сервисе job-scheduler

sed-comment

• Добавлена иконка обязательности поля для отрицательной резолюции FRGU-2351
• Добавлена возможность проверки прав на комментирование FRGU-690
• Добавлен токен для выполнения действия при нажатии на ФИО пользователя в комментарии FRGU-2462 -Убраны кнопки для взаимодействия с комментариями атрибутов предыдущих стадий -Добавлен инпут isSnapshot(комментарий предыдих стадий) для компонента std-comment-snippet-container -Аналогично другим кнопкам, если нет прав, вместо дизейбла добавлено скрытие кнопки голосования FRGU-2461 -Скорректировано обновление данных и перерисовка внутри компонента std-comment-snippet-container FRGU-896
• Добавлен токен COMMENT_FILTER_FUNCTION для фильтрации комментариев FRGU-2421

@standart/components - Добавлено событие close для PopoverComponent. - Добавлена возможность управлять закрытием элемента с AttachedOverlayDirective при клике за его границу. FRGU-2374 - Добавлена функция isPresentPredicate - Добавлен оператор controlValue FRGU-690

12.2.0

• Добавлена библиотека для работы с сагами - saga-lib
• Добавлена команда jsch_validateConditions
• Добавлена команда jsch_scheduleDateAuto
• В sedComment добавлена команда sedComment_deleteCommentInternal
• Добавлена команда jsch_getDurationDraftReserve
• STND-92 Неправильные настройки health check
• Добавлены команды jsch_createLimitGroup, jsch_updateLimitGroup, jsch_restoreLimitGroup, jsch_deleteLimitGroup, jsch_getLimitGroup, jsch_listLimitGroup
• Добавлена команда jsch_scheduleDateGet
• Добавлена команда jsch_scheduleDateReplaceInternal
• Переработан трейт с Handler
• Удалён LoggableStageTF и заменено его использование в логировании в Handler
• Трейт WithTracingUserContext отмечен Deprecation и заменён в трейтах на его реализацию

13.0.0

• Обновление Verdi 1.12

12.0.1

job-scheduler

• Добавлены actions: ManageScheduleDate (https://jira.dev.embedika.ru/browse/SEDNMD-3379)

12.0.0

job-scheduler

• Добавлены actions: EditPlanCalendarSettings, DeletePlanCalendarSettings
• Добавлены actions: ManageScheduleDate (https://jira.dev.embedika.ru/browse/SEDNMD-3379)
• Добавлено чтение топика entityObjectEvent

11.3.1

sed-task-manager - Доработка TaskEnricher, для работы с несколькими полями

11.3.0

• Обновление verdi 1.11.6

job-scheduler

• Добавлены action: ViewPlanCalendarSettings, ViewPlanCalendar

11.2.0

job-scheduler

• Реализованы команды:
  • jsch_createSubjectOnObjectGroupLimit
  • jsch_updateSubjectOnObjectGroupLimit
  • jsch_deleteSubjectOnObjectGroupLimit
  • jsch_listSubjectOnObjectGroupLimit
  • jsch_scheduleDateDraft
  • jsch_scheduleDateApply
  • jsch_scheduleDateRevert
  • jsch_scheduleDateReplace
  • jsch_scheduleDateStats

11.1.4

• STND-92 Неправильные настройки health check

11.1.3

• Исправлена работа метода UserClientImpl#changeUserStatus

11.1.0

• Обновление verdi 1.11.5
• В TechConstantsRegistrar заменён вызов registerConstant на внутреннюю команду registerConstantInternal
• Обновление сервисов и библиотек Cursor/Verdi до версии 1.11.5 FRGU-1901

11.0.2

• В клиент mon добавлены команды registerUser и changeUserStatus

11.0.1

• Добавлено сравнение картинок при слиянии документов

11.0.0

@standart/comment

• Добавлены новые токены для передачи компонентов со стороны проекта
  • COMMENT_SNIPPET_HEADER_COMPONENT - Кастомный компонент шапки комментария
  • COMMENT_REPLY_ADDITIONAL_CONTENT_COMPONENT - Компонент, дополняющий контент ответа на комментарий
  • COMMENT_REPLY_CREATE_MODAL_STATE - Сервис, позволяющий передать стейт для модалки ответа на комментарий. Это дает возможность прикреплять data к ответу на комментарий по аналогии с обычными комментариями. SEDNMD-2994
• [BreakingChanges] Изменен интерфейс CommentData - удалено поле employee SEDNMD-2994
• [BreakingChanges] Изменен интерфейс Comment - теперь это дженерик с параметром T (по умолчанию CommentData), а поле data теперь тип T
• [BreakingChanges] Изменен интерфейс CommentWithThreadData - теперь это дженерик с параметром T (по умолчанию CommentData), а поле commentData теперь тип T SEDNMD-2994
• CommentApiService теперь дженерик с параметром T (по умолчанию CommentData) SEDNMD-2994

10.5.0

• Обновление vedi 1.11.4 STND-75

job-scheduler - Добавлен сервис нагрузки SEDNMD-3113

10.4.0

• Обновление сервисов и библиотек Cursor/Verdi до версии 1.11.2 STND-63

crypto-service - Добавлен сервис хранения электронных подписей FRGU-1644

standart-libs - Добавлены миксин JournalingHandler для обработчиков команд с журналированием.

[BreakingChanges] com.embedika.standart.commands.tf.handlers: - Типы тела команды и результата обработки "спрятаны внутрь" класса CommandHandler, то есть теперь являются абстрактными членами-типами, а не типопараметрами. - В связи с пунктом выше отпала необходимость в классе CommandHandlersModuleDef, ибо вместо подробного описания всех типов теперь можно обойтись строчкой many[CommandHandler[F]].add[MyHandler[F]]. - В связи с пунктом выше отпала необходимость в пакете com.embedika.standart.boot.tf.modules.commands. Класс CommandsModule перемещён на уровень выше. - Удалены классы HttpCommandHandler, KafkaCommandHandler, и, соответственно, AuthorizedHttpCommandHandler и AuthorizedKafkaCommandHandler. Теперь за тип приёма команды отвечает новый пункт dispatchType в CommandDescription. - Класс AuthorizeOneActionDTO переехал из объекта AuthorizedHandler в вышестоящий пакет.

standart-libs - [Deprecation] Трейт BaseClient будет удален в будущем. - Изменён подход к описанию клиентов для сервисов. Теперь набор базовых методов для отправки команд добавляется в класс не посредством примешивания трейта BaseClient, а посредством прокидывания в качестве зависимости экземпляра ExtendedDispatcherTF/ExtendedDispatcher. - Функционал отправки асинхронных команд с запросом результата вынесен в подкласс AsyncPollingDispatcherTF. - На основании вышеприведённых доработок создан TF клиент сервиса иерархий. - В качестве временной меры добавлены клиенты сервисов buzzer и erika. Будут удалены после появления таковых в verdi-libs.

@standart/components

• Добавлены операторы and и or для логического объединения списка Observable FRGU-1613
• Исправлена XSS уязвимость в компоненте RecordComponent FRGU-1654
• Добавлены операторы not и inverse для инверсии булевых значений потоков. FRGU-1026

hierarchy-entities - В таблице HierarchyEntityObject добавлен foreign key для поля parentId, ссылающийся на поле id в той же таблице. - Добавлены в сервис и клиент команды deleteHierarchyEntityObjectWithChildrenCheck и deleteHierarchyEntityObjectBatchWithChildrenCheck, позволяющие различными способами обработать (каскадно удалить, прикрепить к другой сущности и т. д. ) дочерние сущности перед удалением родительской. STND-63

standart-libs В механизме слияния документов (WordDocumentProcessorImpl.mergeDocumentStreams) изменена используемая внутри библиотека с docx4j на apache poi. Пользовательское апи никак не изменено. Рекомендуется в проектах, использующих данный функционал и логирование через slf4j, подключить зависимость "org.apache.logging.log4j" % "log4j-to-slf4j" % "2.17.1", чтобы работали внутренние механизмы логирования apache poi (они обращаются к апи log4j).

Версия 10.3.0

• verdi 1.11.3

sed-task-manager

• Добавлены команды: AssignTask, TakeOffTask, AssignTaskToUser, TakeOffTaskFromUser
• Добавлены AuthorizeKafka и JournalKafka Handlers
• Добавлена команда ReopenTask

iua-adapter

• Микросервис для работы с ИУА СМЭВ

standart-libs

• Библиотека для работы с iua-adapter: iua-adapter-client
• Библиотека для конвертации xml в json и обратно: transformer-lib

Версия 10.2.0

hierarchy-entities

• [BlockingChanges] Добавлен трейт с пакетными командами в стандарт
• Добавлены пакетные команды в сервис иерархий SEDNMD-2982

standart-libs

• Добавлены сортировки по умолчанию, раньше по ним пе фильтровалось. STND-58
• com.embedika.standart.service.BaseClient.sendCommandAsync Завершается на финальных стадиях SEDNMD-3029

@standart/components

• Добавлена функция handleAsyncRequest для обработки асинхронных запросов FRGU-1522
• В методе SearchFilter.create добавлен необязательный аргумент для создания фильтров через ||
• Доработан SearchFilter.merge, метод может принимать неограниченное количество аргументов FRGU-1523

Версия 10.1.0

standart-libs

• Добавлены типы для работы с типизированным RouteStage
• Добавлен класс для получения из routeClient типизированного RouteStage
• Добавлен JsonHelper
• Добавлен chimney 1.3.0 SEDNMD-2648
• Поправлено применение несколько значений в фильтре FRGU-1476

ui-libs

• В npm-пакете "@standart/comment" добавлена возможность комментировать атрибуты массивов объектов FRGU-1196

Версия 8.0.7

hierarchy-entities - В таблице HierarchyEntityObject добавлен foreign key для поля parentId, ссылающийся на поле id в той же таблице. - Добавлены в сервис и клиент команды deleteHierarchyEntityObjectWithChildrenCheck и deleteHierarchyEntityObjectBatchWithChildrenCheck, позволяющие различными способами обработать (каскадно удалить, прикрепить к другой сущности и т. д. ) дочерние сущности перед удалением родительской. STND-63

standart-libs В механизме слияния документов (WordDocumentProcessorImpl.mergeDocumentStreams) изменена используемая внутри библиотека с docx4j на apache poi. Пользовательское апи никак не изменено. Рекомендуется в проектах, использующих данный функционал и логирование через slf4j, подключить зависимость "org.apache.logging.log4j" % "log4j-to-slf4j" % "2.17.1", чтобы работали внутренние механизмы логирования apache poi (они обращаются к апи log4j).

Версия 8.0.6

standart-libs - В клиент для s3 добавлен мехазим ретраев. - Ошибки клиента для s3 сделаны более читаемыми. - Класс OutgoingRequestsSettings переехал из модуля boot в модуль domain. Версия из модуля boot временно существует, также в модуль UtilsModule добавлено преобразование из legacy модели. Данное преобразование и старый класс будут удалены в ближайших релизах. STND-64

Версия 10.0.0

sed-comment

• Изменён запрос sedComment_listThreadsWithComments на использование SQLFilterComponent, исправлено подставление значения через #$ на $
• Изменён конфиг sedTaskManager_searchTaskAnalytics, добавлены переменные ANALYTICS_DATA_ALLOWED и ANALYTICS_DATA_ALLOWED_FIELDS для защиты от подстановки инъекции в название поля FRGU-1352
• Отображение даты (modified, created) комментариев и сортировка настраивается в зависимости от проекта
• Добавлены новые токены для настройки, их необходимо прокидывать в каждом проекте отдельно COMMENT_DATE_KEY - Поле для отображения даты комментария + ключ для сортировки комментариев COMMENT_SORTING_DROPDOWN_ITEMS- Список опций для сортировки в компоненте std-comment-sorting COMMENT_SORTING_OPTION_DEFAULT- Опция для сортировки по умолчанию COMMENT_SORTING_MAP- Словарь, сопоставляющий sortingOption из std-comment-sorting с Sorting, для сортировки на сервере COMMENT_SORTER_MAP- Словарь сопоставляющий sortingOption из std-comment-sorting с функциями для локальной сортировки
• Сделана сортировка comment.modified для listThreadsWithCommentsFlat FRGU-1358

standart-libs

• Убран у модуля boot зависимость на worddocumentprocessor STND-53
• Обновление сервисов и библиотек Cursor/Verdi до версии 1.11 FRGU-1464

ui-libs

• Изменены основные интерфейсы, связанные с RecordComponent, RecordRendererComponent Добавлены новые функции recordRendererReadonly, recordRendererEditable, recordRendererContext для создания через ts-файлы. Добавлены пайпы record, recordHref, recordLink для создания через html-шаблоны STND-50
• Обновление сервисов и библиотек Cursor/Verdi до версии 1.11 FRGU-1465

Версия 9.0.0

standart-libs

• LiveTechConstantsClient изменён на LiveTechConstantsClientTF
• FRGU-1089
• Обновление сервисов и библиотек Cursor/Verdi до снэпшотной версии 1.11 STND-45

ui-libs

• Обновление сервисов и библиотек Cursor/Verdi до версии 1.11 STND-46

Версия 8.0.5

hierarchy-entities

• Добавлен трейт с пакетными командами в стандарт

• Добавлены пакетные команды в сервис иерархий SEDNMD-2982 standart-libs

• Добавлены сортировки по умолчанию, раньше по ним пе фильтровалось. STND-58

• com.embedika.standart.service.BaseClient.sendCommandAsync Завершается на финальных стадиях SEDNMD-3029

Версия 8.0.4

-обновлено verdi/cursor до 1.10.1 SEDNMD-3026

Версия 8.0.1

hierarchy-entities

• Связаны поля HierarchyEntityObject.hierarchyEntityId и HierarchyEntity.id через foreign key.
• Добавлена команда deleteHierarchyEntity в клиент. STND-51

Версия 8.0.0

standart-libs

• Дополнения: Добавлена новая либа document-merger и модуль DocumentMergerModule.
• Несовместимые изменения: Изменено название и расположение модулей, отвечающих за чтение команд и событий из kafka: standart-libs/standart-boot-lib/src/main/scala/com/embedika/standart/boot/tf/modules/KafkaConsumerModule.scala → standart-libs/standart-boot-lib/src/main/scala/com/embedika/standart/boot/tf/modules/kafka/KafkaCommandsConsumerModule.scala standart-libs/standart-boot-lib/src/main/scala/com/embedika/standart/boot/tf/modules/KafkaEventsConsumerModule.scala → standart-libs/standart-boot-lib/src/main/scala/com/embedika/standart/boot/tf/modules/kafka/KafkaEventsConsumerModule.scala SEDNMD-2672

sed-comment

• Добавлена возможность прокидывать buttonStyles, dropdownStyles в sed-comment/std-comment-sorting
• Добавлен фильтр removed: false в sed-route/std-solution-list, чтобы скрыть удалённые решения на стадии
• Добавлены токены COMMENT_SORTING_DROPDOWN_STYLE, COMMENT_SORTING_BUTTON_STYLE для возможности конфигурировать стили компонента std-comment-sorting. STND-28

Версия 7.2.0

sed-comment

• Проставленные резолюции не зависят от COMMENT_REACTION_MODE(Режим, позволяющий оставлять реакции на комментарий, проставлять резолюции) и отображаются всегда при наличии FRGU-748

sedTaskManager

• Добавлена команда UpdateTasks
• Добавлен custom.conf SEDNMD-2341

Версия 7.1.0

sed-comment

• дополнено DTO данными modified + modifiedBy
• добавлен фильтр c.modified FRGU-971

ui-libs

• Добавлен токен CAN_DO_COMMENT_ACTION для отображения кнопки контекстного меню с действиями по комментарию FRGU-690

sedTaskManager

• Реализована универсальная команда для построения аналитики задач с фильтрами по полям Task(в том числе по полям data) "sedTaskManager_searchTaskAnalytics" FRGU-1112

Версия 7.0.1

standart-libs

• Изменена команда авторизации с sed_authorize на oberto_AuthorizeV2 STND-34

Версия 7.0.0

Обновлено до версии 1.10.0 Cursor/Verdi

STND-23 STND-25

hierarchy-entities

• Возможность поиска по тексту в команде отображения дерева
• Возможность запроса корневых сущностей SEDNMD-2774

sed-comment

• Добавлены экшены CreateVote, DeleteVote, UpdateVote, DeleteComment FRGU-987

sed-route

• Поправлен запрос для клонирования маршрута - чтобы можно было делать переходы с одного маршрута на предыдущий FRGU-1037

ui-libs

• Добавлена возможность фильтрации по не совпадению - фильтр negation FRGU-989
• Добавлена кнопка "Комментарии в веб-просмотре" для прямого перехода к документу из секции комментариев FRGU-1101
• В @standart/route добавлен конструктор маршрутов STND-6

standart-libs

• Добавлен tf Kafka консьюмер для событий FRGU-1072
• В клиенте mon прописан infinitPaging в запросе пользователей по группе SEDNMD-2782
• Клиент для расчета срока стадии FRGU-1079

Версия 6.3.0

standart-libs

• Добавлен метод в userClient для получения списка пользователей с info с полем data FRGU-977

ui-libs

• Добавлен Generic-параметр для RouteStageData FRGU-958
• для Observable disabled$ убран пайп filter и в map пайпе учтено, что измененный комментарий не должен быть идентичен изначальному SEDNMD-2618

Версия 6.2.0

standart-conf

Добавлен payload в логи для случаев когда команда с ошибкой завершилась FRGU-109

standart-libs

• Добавлен сервис провайдер атрибутов и интерфейсы для него, dsl для составление условий в политиках SEDNMD-2497
• в QueryExtensionComponent добавлена обязательная сортировка по id SEDNMD-2290
• Рефакторинг SEDNMD-2661

Версия 6.1.0

Обновлено до версии 1.9.1 Cursor/Verdi

• Бэк
• Фронт

hierarchy-entities

В клиент сервиса иерархии вынесена команда hierarchyEntities_listHierarchy SEDNMD-2664 Доработка запроса для выбора модели - Поддержка серверной части

sed-comment

Добавлена команда для кол-ва комментариев с резолюциями FRGU-707

sed-route

Миграция для старых данных FRGU-870

standart-libs

• Добавлены новые миграционные TF классы SEDNMD-2659 Сервис для поддержки CRUD директорий
• Добавлен клиент файловой системы для F[_] и подвинуты модули для более удобного его использования SEDNMD-2665 Обработка приходящих шаблонов из КИС БА

Версия 6.0.0

• Доработан процесс сборки и публикации в проектах FRGU-766

• Изменено расположение http-модулей для более простой поддержки сервисов, имеющих эндпоинты помимо verdi-команд SEDNMD-2623

sed-comment

• Добавлена новая внутренняя команда sedComment_threadRelationProcessAttribute SEDNMD-2497 Рефакторинг прав
• Переименована сортировка в комментариях FRGU-235 Переименовать сортировку "Сначала с отрицательной оценкой"

sed-route

• Добавлена команда для асинхронного обновления RouteStage
• Добавлены ретраи, чтобы ничего не умирало от нагрузки
• OutOfMemoryError в миграции, переход на потоковую обработку
• Поменялся способ хранения поля number в поле data у сущности RouteStage, кроме номера для отображения там теперь содержится ещё и номер для сортировки, присутствующий у всех стадий, в том числе не имеющих номера для отображения FRGU-807 SEDNMD-2538 Неправильно сортируются стадии без номера
• Изменилась структура данных Stage.data. фронт изменил отображение номеров стадий в соответствии с новой структурой FRGU-808 Неправильно сортируются стадии без номера

Версия 5.0.0

• Доработка api сервисов Стандарт

sed-comment

• команда sedComment_addComment переименована в sedComment_createCommentWithThread, для лучшей удобочитаемости

sed-task-manager

• команда sedTaskManager_сreateTaskWithAttaches - изменила формат, теперь в ней передается список задач c аттачами, для множественного создания

• добавлена команда sedTaskManager_createTaskWithAttachByResponsible - она является старой версией команды sedTaskManager_сreateTaskWithAttaches, с немного измененным форматом

• добавлена команда sedTaskManager_userTaskAnalytics для получение аналитики по задачам пользователя - обобщённая система обогащения задач

sed-route

• Добавлены команды для смены стадии у routeEntity - sedroute_changeRouteEntityStage sedroute_changeRouteEntityStageByEntity

• Добавлены команды для смены маршрута у routeEntity - sedroute_changeRouteEntityRouteVersion sedroute_changeRouteEntityRouteVersionByEntity

• Добавлен в Стандарт тип перехода стадии, который уже был. Чтобы в одном месте все находилось.

FRGU-606 Выделение логики из crud команд FRGU-635 Комментирование атрибутов отображать на всех стадиях FRGU-649 Поиск и фильтрация списка задач SEDNMD-2547 Типы переходов routeStageLink

• Доработка Open Search

В OpenSearchStorageClient добавлено поле index в DeleteByQueryRequest

SEDNMD-2357

Версия 4.0.0

• Все библиотеки объединены в standart-libs(standart-system-lib и standart-client-libs удалены)
• Изменено расположение объектов и классов согласно их функционалу
• Удален гпн-сэд специфичный код
• Удален излишний и неиспользуемый код
• Оптимизированы зависимости библиотек
• Обновлено до Angular 17
• Убран запрос к cnmd-api-adapter для получения данных пользователя. Вместо него сделан конфигурируемый обобщенный клиент с параметрами

FRGU-595 Обновиться до Angular 17 FRGU-608 Оптимизировать библиотеки Стандарта FRGU-609 Почистить библиотеки Стандарт от не используемого кода FRGU-610 Почистить зависимости сервисов Стандарт

Обновлено до версии 1.9 Cursor/Verdi

• Бэк
• Фронт

Версия 3.0.0

Обновлено до версии 1.8.2 Cursor/Verdi

1. FRGU-625
2. SEDNMD-2456
3. SEDNMD-2478

sed-route

• Доработка

Добавлен параметр для управления уведомлением на стадии SEDNMD-2433 Изменить уведомление "Изменение стадии маршрута"

UI-libs-sed-comment

• Исправление багов FRGU-520 Комментирование атрибутов

Версия 2.2.0

sed-comment

• Доработка

1. FRGU-519 Реализована возможность привязывать комментарии к атрибутам.
2. FRGU-519 Доработка listThreads для отображения кол-ва комментариев

• Исправление бага SEDNMD-2389 При открытии модалки для добавления коммента/ответа срабатывает валидация

sed-route

• Доработка

SEDNMD-2401 Модальное окно выбора решения в Запросах маршрутов

sed-libs

• Доработка

1. В библиотеке standart-storage-lib добавлены общие трейты для Queries для того, чтобы была возможность фильтроваться и сортировать по Search не наследуясь от трейта Modifiable FRGU-514 Интерфейс Управления миграциями
2. Создан обобщенный клиент хранилища. Добавлена возможность перехода от использования только ElasticSearch на переключаемый между ElasticSearch и OpenSearch FRGU-495 Добавить поддержку sed-analytic и sed-report поддержку openSearch

UI-libs

• Доработка

В либе добавлен раздел комментирования атрибутов FRGU-520 Комментирование атрибутов

Версия 2.1.0

sed-comment

• Доработка SEDNMD-2315 Вынести проставление резолюций в отдельную команду

• Исправление бага

• SEDNMD-2321 Не происходит переход к комментарию фрагмента файла документа

• SEDNMD-2354 У комментария слетает привязка к фрагменту текста файла документа

sed-components

• Добавление новых компонентов (popover, control-error), директив (control-error, popover, loader), сервиса catalog.store SEDNMD-2331 Исследовать вынесение общего кода фронта в Standart

• Исправление бага SEDNMD-2338 При нажатии ENTER модальные окна открываются одно на другом

sed-route

• Создание библиотеки SEDNMD-2331 Исследовать вынесение общего кода фронта в Standart

Версия 2.0.0

Обновлено до версии 1.8 Cursor/Verdi

• Добавлен функционал лицензирования (сервисы apigateway и oberto)
• Добавлено разлогинивание пользователя при его блокировке
• Подняты версии библиотек mon

Список изменений:

Verdi: Версия 1.8 Cursor: Версия 1.8

Версия 1.0.1

Добавлен на фронте option-dependencies, чтобы либы не зависили сами от себя

Версия 1.0.0

Вынесен общий код из СЭД в общий репозиторий Standart

SEDNMD-2296 FRGU-377

Общая библиотека:

• sed-libs - ранее "gpn-libs"

Сервисы:

• sed-task-manager - сервис задач
• sed-route - сервис маршрутов
• sed-comment - ранее "gpn-comment" - сервис комментариев

Созданы UI-библиотеки:

FRGU-393

• sed-comment
• sed-components - вынесены общие модели, функции, директивы, пайпы и компонентыю Планируется ее постепенное наполнение

Переименованы команды сервиса комментариев

FRGU-407 SEDNMD-2296

analytics: сервис аналитики

Сервис читает события EntityObjectEvent и формирует представления по заданным настройкам, по полученным представлением можно строить аналитику трёх видов - Сводная таблица, круговая диаграмма и гистограмма. Настройки аналитики хранятся в виджетах и могут быть настроены.

Команды могут приходить как по HTTP, так и через Kafka в топик analytics_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Информацию по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/analytics_db
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • ANALYTICS_DB_HOST
  • ANALYTICS_DB_PORT
  • ANALYTICS_DB_NAME
  • ANALYTICS_DB_USER
  • ANALYTICS_DB_PASSWORD

Запуск из консоли с помощью SBT

ANALYTICS_DB_HOST=localhost ANALYTICS_DB_PORT=5432 ANALYTICS_DB_NAME=analytics_db ANALYTICS_DB_USER=postgres ANALYTICS_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса analytics

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса analytics

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, ANALYTICS_LOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• ANALYTICS_LOGGING_SRC_IP, для параметра src в логах
• ANALYTICS_LOGGING_SRC_HOST, для параметра shost в логах
• ANALYTICS_LOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Список команд сервиса analytics

В сервисе реализованно 3 команды:

• Создание представления
• Создание виджета
• Получение аналитики по виджеты

ImportView

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

На входе описание представления

{
  "table": "Registry",
  "columns": [
    {
      "table": "Registry",
      "name": "id",
      "isMultiple": false,
      "displayName": "ID услуги",
      "dataType": "StringType",
      "isId": true
    },
    {
      "table": "Registry",
      "name": "name",
      "isMultiple": false,
      "displayName": "Наименование",
      "dataType": "StringType",
      "isId": false
    },
    {
      "table": "Registry",
      "name": "isDraft",
      "isMultiple": false,
      "displayName": "Признак черновика",
      "dataType": "BooleanType",
      "isId": false
    }
  ],
  "events": [
    {
      "affectType": {
        "affectType": "Upsert"
      },
      "entityType": "Registry",
      "eventType": "update",
      "entityObjectFilter": {
        "key": "status",
        "values": [
          "New",
          "InProcess"
        ]
      },
      "fields": [
        {
          "from": "name",
          "to": "name",
          "fieldAffectType": {
            "fieldAffectType": "Replace"
          }
        }
      ]
    },
    {
      "affectType": {
        "affectType": "Upsert"
      },
      "entityType": "AnotherRegistry",
      "eventType": "update",
      "fields": [
        {
          "from": "draft",
          "to": "isDraft",
          "fieldAffectType": {
            "fieldAffectType": "Replace"
          }
        }
      ]
    },
    {
      "affectType": {
        "affectType": "Delete"
      },
      "entityType": "Registry",
      "eventType": "update",
      "entityObjectFilter": {
        "key": "status",
        "values": [
          "Removed"
        ]
      },
      "fields": []
    }
  ]
}

На выходе создаётся предсталвение с название Registry, с колонками id, name и isDraft, колонка id берётся из id сущности Registry, колонка name обновляется по событиям обновления сущности Registry с полем status равным New или InProcess. Колонка isDraft обновляется при событии обновления сущности AnotherRegistry и берётся из колонки draft . Запись удаляется из представления по событию обновления поля status = Removed у сущности Registry.

• Input: ViewInfo
• Output: Пустое тело ответа

ImportWidget

Добавляет новый виджет, который является запросом над представлениями.

На входе описание виджета

Первый вариант, создаёт сводную таблицу

{
  "name": "summaryWidget",
  "title": "Сводная таблица",
  "table": {
    "name": "Registry",
    "tableDef": "SimpleTable"
  },
  "view": [
    {
      "alias": "countId",
      "level": 1,
      "table": null,
      "column": "id",
      "function": {
        "aggType": "Count",
        "distinct": false
      },
      "displayName": "Количество сущностей",
      "transformationType": "Aggregate"
    },
    {
      "alias": "countName",
      "level": 1,
      "table": null,
      "column": "name",
      "function": {
        "aggType": "Count",
        "distinct": true
      },
      "displayName": "Количество уникальных наименований",
      "transformationType": "Aggregate"
    }
  ]
}

Второй вариант, круговая диаграмма

{
  "name": "pieChartWidget",
  "title": "Круговая диаграмма",
  "table": {
    "joins": [
      {
        "left": {
          "name": "Registry",
          "alias": "Registry",
          "joinColumn": "columnRegistry"
        },
        "right": {
          "name": "AnotherRegistry",
          "alias": "AnotherRegistry",
          "joinColumn": "anotherColumn"
        },
        "joinType": {
          "joinType": "InnerJoin"
        }
      }
    ],
    "tableDef": "TableJoins"
  },
  "view": [],
  "settings": {
    "columns": [
      "name"
    ],
    "chartSettingsType": "PieChartSettings"
  }
}

• Input: Widget
• Output: Пустое тело ответа

GetAnalytics

Получает аналитику по заданному виджету.

• Input: AnalyticsInput
• Output: Chart]

На входе название виджета и Search

{
    "widget": "summaryWidget",
    "search": {
        "query": "level",
        "context": {
            "level": {
                "values": ["Init"],
                "kind": "any"
            }
        }
    }
}

Пример вывода (сводная таблица)

{
        "tableData": {
            "columns": [
                {
                    "name": "countId",
                    "isMultiple": false,
                    "displayName": "Количество сущностей",
                    "dataType": "StringType"
                },
                {
                    "name": "countName",
                    "isMultiple": false,
                    "displayName": "Количество наименований",
                    "dataType": "StringType"
                }
            ],
            "rows": [
                {
                    "countId": 561,
                    "countName": 269
                }
            ]
        },
        "chartType": "Summary"
    }

Пример вывода (круговая диаграмма)

{
  "values": [
    {
      "value": "Territorial",
      "count": 2.0,
      "percentOfParent": 2.5,
      "percentOfTotal": 2.5,
      "subLayers": []
    },
    {
      "value": "Central",
      "count": 78.0,
      "percentOfParent": 97.5,
      "percentOfTotal": 97.5,
      "subLayers": []
    }
  ],
  "chartType": "PieChart"
}

Сущности сервиса Analytics

ViewInfo

ColumnInfo

DataType

Тип данных колонки, может быть StringType для строк, NumericType для чисел (scala-тип BigDecimal), BooleanType для булевых значений

AffectingEvent

AffectType

Тип обновления представления, Insert, Update, Upsert, Delete

AffectingField

FieldAffectType

Тип обновления колонки, реализование один тип - Replace, полная замена значения колонки

EntityObjectFilter

Widget

TableDef

Описание таблицы, может быть SimpleTable или TableJoins

SimpleTable

TableJoins

TableJoin

TableWithAlias

JoinType

Тип соединения, InnerJoin, LeftJoin, RightJoin

Transformation

Описание преобразования над представлением, бывает:

• Select - выбор конкретных столбцов из представления
• GroupBy - группировка по столбцам представления
• Filter - фильтрация представления
• MathExpression - создание новой колонки посредством математического выражения
• Aggregate - аггрегация данных

Select

SelectField

GroupBy

GroupByColumn

Filter

FilterCondition

Условие фильтрации, бывает In, More, Less, ILike

In

More

Less

ILike

MathExpression

MathOperation

Условие фильтрации, бывает Add, Subtract, Multiply

Aggregate

MathOperation

Условие фильтрации, бывает Avg, ArrayAgg, Sum, Max, Count

ChartSettings

Условие фильтрации, бывает PieChartSettings, HistSettings

PieChartSettings

HistSettings

AnalyticsInput

Chart

Тип графика для аналитики:

• Summary - сводная таблица
• PieChart - круговая диаграмма
• Hist - гистограмма

Summary

TableInfo

ShortColumnInfo

PieChart

PieChartValue

Hist

HistValue

crypto-service: сервис для примера

Сервис принимает запросы для работы с игроками и командами. Состояние хранится в PostgreSQL. Команды могут приходить как по HTTP, так и через Kafka в топик crypto_service_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Информацию по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/cryptoservice_db
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • CRYPTO_SERVICE_DB_HOST
  • CRYPTO_SERVICE_DB_PORT
  • CRYPTO_SERVICE_DB_NAME
  • CRYPTO_SERVICE_DB_USER
  • CRYPTO_SERVICE_DB_PASSWORD

Запуск из консоли с помощью SBT

CRYPTO_SERVICE_DB_HOST=localhost CRYPTO_SERVICE_DB_PORT=5432 CRYPTO_SERVICE_DB_NAME=cryptoservice_db CRYPTO_SERVICE_DB_USER=postgres CRYPTO_SERVICE_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса crypto-service

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса crypto-service

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, CRYPTO_SERVICE_LOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• CRYPTO_SERVICE_LOGGING_SRC_IP, для параметра src в логах
• CRYPTO_SERVICE_LOGGING_SRC_HOST, для параметра shost в логах
• CRYPTO_SERVICE_LOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Список команд сервиса crypto-service

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованы следующие команды

• Создание подписи
• Получение подписи
• Получение сущности с подписями

CreateSignature

Создает новую подпись, сохраняет переданный контент в .sig файл, связывает подпись и внешнюю сущность.

• Input: SignatureCreateDTO
• Output: Signature

DeleteSignature

Удаляет подпись

• Input: [String]
• Output: -

DeleteSignaturesByEntity

Удаляет подпись

• Input: ExtId
• Output: -

GetSignature

Возвращает подпись по Id.

• Input: [String]
• Output: Signature

GetEntityWithSignatures

Возвращает внешнюю сущность со всеми связанными подписями.

• Input: ExtId
• Output: EntityWithSignature

SignatureCreateDTO

Signature

SignatureFileMeta

fileId: ObjectFileId, name: String, extension: String, size: Long, url: String, created: TimeStamp, md5: String,

EntityInfo

ExtId

EntityWithSignature

hierarchy-entities

Сервис принимает команды и хранит состояние в PostgreSQL. Команды могут приходить как по HTTP, так и через Kafka в топик hierarchy_entities_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain, в котором содержатся все доменные модели и их различные представления.
• commands, в котором содержатся всё, что связано с командами, их описанием и обработчиками.
• storage, содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service, содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot, содержит зависимости и описание для сборки и запуска сервиса.

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/hierarchyentities
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • HIERARCHY_ENTITIES_DB_HOST
  • HIERARCHY_ENTITIES_DB_PORT
  • HIERARCHY_ENTITIES_DB_NAME
  • HIERARCHY_ENTITIES_DB_USER
  • HIERARCHY_ENTITIES_DB_PASSWORD

Запуск из консоли с помощью SBT

HIERARCHY_ENTITIES_DB_HOST=localhost HIERARCHY_ENTITIES_DB_PORT=5432 HIERARCHY_ENTITIES_DB_NAME=hierarchyentities HIERARCHY_ENTITIES_DB_USER=postgres HIERARCHY_ENTITIES_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса hierarchy-entities

Все доступные переменные окружения для настройки сервиса.

Список команд сервиса hierarchy-entities

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованы следующие команды:

• Создание иерархичной сущности
• Обновление иерархичной сущности
• Удаление иерархичной сущности
• Восстановление иерархичной сущности
• Получение иерархичной сущности по ID
• Список иерархичных сущностей

• Создание объекта иерархий
• Создание объектов иерархий пакетное
• Обновление объекта иерархий
• Обновление объектов иерархий пакетное
• Удаление объекта иерархий
• Удаление объекта иерархий с обработкой детей
• Удаление объектов иерархий пакетное
• Удаление объектов иерархий пакетное с обработкой детей
• Восстановление объекта иерархий
• Получение объекта иерархий по ID
• Список объектов иерархий

• Иерархичный список с фильтрацией

CreateHierarchyEntity

На входе атрибуты для создания иерархичной сущности

{
  "id": "HierarchyEntityId",
  "title": "title",
  "description": "description",
  "data": {
    "someInfo": "info"
  }
}

На выходе ID новой задачи

"HierarchyEntityId"

Добавление новой иерархичной сущности.

• Input: HierarchyEntityCreateDTO
• Output: Id созданной задачи

UpdateHierarchyEntity

На выходе атрибуты для обновления иерархичной сущности

{
  "id": "HierarchyEntityId",
  "title": "title",
  "description": "description",
  "data": {
    "someInfo": "info"
  },
  "version": 1
}

На выходе признак успешности обновления

true

Обновление иерархичной сущности.

• Input: HierarchyEntityUpdateDTO
• Output: Boolean

DeleteHierarchyEntity

На входе ID иерархичной сущности

"hierarchyEntityId"

На выходе признак успешности удаления

true

Удаление иерархичной сущности.

• Input: ID иерархичной сущности
• Output: Boolean

RestoreHierarchyEntity

На входе ID иерархичной сущности

"hierarchyEntityId"

На выходе признак успешности восстановления

true

Восстановление иерархичной сущности.

• Input: ID иерархичной сущности
• Output: Boolean

GetHierarchyEntity

На входе ID иерархичной сущности

"hierarchyEntityId"

На выходе атрибуты иерархичной сущности

{
  "id": "HierarchyEntityId",
  "title": "title",
  "description": "description",
  "data": {
    "someInfo": "info"
  },
  "created": 1664292962695,
  "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "modified": 1664292962695,
  "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "removed": false,
  "version": 2
}

Получение иерархичной сущности.

• Input: UUID задачи
• Output: HierarchyEntity

ListHierarchyEntities

На входе параметры поиска, сортировки и пагинации (Search) Возможна фильтрация и сортировка по полям data. Для строковых значений префикс data (Например "data.someInfo.info) Для числовых значений префикс dataNumber (Например "dataNumber.someInfo.numberInfo)

{
  "query": "",
  "context": {},
  "sorting": {
    "fieldName": "title",
    "order": "desc"
  },
  "paging": {
    "page": 1,
    "count": 5
  }
}

На выходе список иерархичных сущностей и их общее количество

{
  "items": [
    {
      "id": "HierarchyEntityId",
      "title": "title",
      "description": "description",
      "data": {
        "someInfo": {
          "info": "info",
          "numberInfo": 10
        }
      },
      "created": 1664292962695,
      "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
      "modified": 1664292962695,
      "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
      "removed": false,
      "version": 2
    }
  ],
  "total": 1
}

Получение списка иерархичных сущностей с поиском, сортировкой и пагинацией.

• Input: Search
• Output: Page[HierarchyEntity]

CreateHierarchyEntityObject

На входе атрибуты для создания объекта иерархий

{
  "hierarchyEntityId": "HierarchyEntityId",
  "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
  "data": {
    "title": "objectTitle",
    "objectNumber": 3
  }
}

На выходе ID нового объекта иерархий

"ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"

Добавление нового объекта иерархий.

• Input: HierarchyEntityObjectCreateDTO
• Output: Id объекта иерархий

CreateHierarchyEntityObjectBatch

На входе атрибуты для создания объектов иерархий

[
  {
    "hierarchyEntityId": "HierarchyEntityId",
    "data": {
      "title": "objectTitle",
      "objectNumber": 1
    }
  },
  {
    "hierarchyEntityId": "HierarchyEntityId",
    "data": {
      "title": "objectTitle",
      "objectNumber": 2
    }
  }
]

На выходе список ID новых объектов иерархий

[
  "2513bdc2-8083-4e88-b09c-3978e05e5076",
  "8fe7159d-c457-432e-a58d-ca41af44e5d7"
]

Добавление нового объекта иерархий.

• Input: HierarchyEntityObjectCreateDTO[]
• Output: UUID[] список Id объектов иерархий, порядок в списке возвращаемых идентификаторов соответствует порядку списка DTO

UpdateHierarchyEntityObject

На входе атрибуты для обновления объекта иерархий

{
  "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "hierarchyEntityId": "HierarchyEntityId",
  "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
  "data": {
    "title": "objectTitle",
    "objectNumber": 3
  },
  "version": 1
}

На выходе признак успешности обновления

true

Обновление объекта иерархий.

• Input: HierarchyEntityObjectUpdateDTO
• Output: Boolean

UpdateHierarchyEntityObjectBatch

На входе список атрибутов для обновления объектов иерархий

[
  {
    "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
    "hierarchyEntityId": "HierarchyEntityId",
    "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
    "data": {
      "title": "objectTitle",
      "objectNumber": 3
    },
    "version": 1
  },
  {
    "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
    "hierarchyEntityId": "HierarchyEntityId",
    "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
    "data": {
      "title": "objectTitle",
      "objectNumber": 3
    },
    "version": 1
  }
]

На выходе признак успешности обновления

true

Обновление объекта иерархий.

• Input: HierarchyEntityObjectUpdateDTO[]
• Output: Boolean

DeleteHierarchyEntityObject

На входе ID объекта иерархий

"ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"

На выходе признак успешности удаления

true

Удаление объекта иерархий.

• Input: ID объекта иерархий
• Output: Boolean

DeleteHierarchyEntityObjectWithChildrenCheck

На входе данные для удаления объекта иерархий

{
  "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "childrenAction": {
    "childrenActionKind": "CascadeDelete",
    "returnChildrenIds": true
  }
}

На выходе ID удаленных дочерних сущностей (если указано их удалять и возвращать)

[
  "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"
]

Удаление объекта иерархий с обработкой детей.

• Input: HierarchyEntityObjectDeleteWithChildrenCheckDTO
• Output: Option[HierarchyEntityObject[]]

DeleteHierarchyEntityObjectBatch

На входе список ID объектов иерархий

[
  "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"
]

На выходе признак успешности удаления

true

Удаление объекта иерархий пакетное.

• Input: список ID объектов иерархий
• Output: Boolean

DeleteHierarchyEntityObjectBatchWithChildrenCheck

На входе список ID объектов иерархий

{
  "ids": [
    "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
    "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"
  ],
  "childrenAction": {
    "childrenActionKind": "CascadeDelete",
    "returnChildrenIds": true
  }
}

На выходе ID удаленных дочерних сущностей (если указано их удалять и возвращать)

[
  "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"
]

Удаление объекта иерархий пакетное с обработкой детей.

• Input: HierarchyEntityObjectDeleteBatchWithChildrenCheckDTO
• Output: Option[HierarchyEntityObject[]]

RestoreHierarchyEntityObject

На входе ID объекта иерархий

"ccdeecc5-ff63-4c98-80d6-bab044cc5f1e"

На выходе признак успешности восстановления

true

Восстановление объекта иерархий.

• Input: ID объекта иерархий
• Output: Boolean

GetHierarchyEntityObject

На входе ID объекта иерархий

"hierarchyEntityId"

На выходе атрибуты объекта иерархий

{
  "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "hierarchyEntityId": "HierarchyEntityId",
  "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
  "data": {
    "title": "objectTitle",
    "objectNumber": 3
  },
  "created": 1664292962695,
  "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "modified": 1664292962695,
  "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
  "removed": false,
  "version": 2
}

Получение объекта иерархий.

• Input: UUID объекта иерархий
• Output: HierarchyEntityObject

ListHierarchyEntityObjects

На входе параметры поиска, сортировки и пагинации (Search) Возможна фильтрация и сортировка по полям data. Для строковых значений префикс data (Например "data.someInfo.info) Для числовых значений префикс dataNumber (Например "dataNumber.someInfo.numberInfo)

{
  "query": "",
  "context": {},
  "sorting": {
    "fieldName": "title",
    "order": "desc"
  },
  "paging": {
    "page": 1,
    "count": 5
  }
}

На выходе список объектов иерархий и их общее количество

{
  "items": [
    {
      "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
      "hierarchyEntityId": "HierarchyEntityId",
      "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
      "data": {
        "title": "objectTitle",
        "objectNumber": 3
      },
      "created": 1664292962695,
      "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
      "modified": 1664292962695,
      "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
      "removed": false,
      "version": 2
    }
  ],
  "total": 1
}

Получение списка объектов иерархий с поиском, сортировкой и пагинацией.

• Input: Search
• Output: Page[HierarchyEntityObject]

ListHierarchy

На входе параметры поиска, сортировки и пагинации (Search), параметр expandTree и опциональный parentId Пагинация влияет только на самый верхний уровень вложенности (parentId = null) Возможна фильтрация и сортировка по полям data. Для строковых значений префикс data (Например "data.someInfo.info) Для числовых значений префикс dataNumber (Например "dataNumber.someInfo.numberInfo)

Если expandTree = false поле children у объектов всегда = null, в остальных случаях это список вложенных объектов

Сценарии работы Фильтрация с expandTree = false, parentId = null На выходе список верхне уровневых объектов, которые хранят попавшие под фильтр сущности на нижних уровнях, или сами попадают под фильтр.

{
  "items": [
    {
      "entityObject": {
        "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "hierarchyEntityId": "HierarchyEntityId",
        "parentId": null,
        "data": {
          "title": "objectTitle",
          "objectNumber": 3
        },
        "created": 1664292962695,
        "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "modified": 1664292962695,
        "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "removed": false,
        "version": 2
      },
      "isMatched": false,
      "childrenCount": 10,
      "children": null
    }
  ],
  "total": 1
}

Фильтрация с expandTree = false, parentId != null На выходе список объектов у которых родитель = parentId, которые хранят попавшие под фильтр сущности на нижних уровнях, или сами попадают под фильтр.

{
  "items": [
    {
      "entityObject": {
        "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "hierarchyEntityId": "HierarchyEntityId",
        "parentId": "72602ae9-66ab-4065-8305-d374ff14a4bf",
        "data": {
          "title": "objectTitle",
          "objectNumber": 3
        },
        "created": 1664292962695,
        "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "modified": 1664292962695,
        "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "removed": false,
        "version": 2
      },
      "isMatched": true,
      "childrenCount": 0,
      "children": null
    }
  ],
  "total": 1
}

Фильтрация с expandTree = true, parentId можно не указывать, так как дерево будет раскрыто полностью На выходе список объектов от верхнего уровня с иерархичной вложенностью до объекта, который попадает под фильтр

{
  "items": [
    {
      "entityObject": {
        "id": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "hierarchyEntityId": "HierarchyEntityId",
        "parentId": null,
        "data": {
          "title": "objectTitle",
          "objectNumber": 3
        },
        "created": 1664292962695,
        "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "modified": 1664292962695,
        "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
        "removed": false,
        "version": 2
      },
      "isMatched": false,
      "childrenCount": 1,
      "children": [
        {
          "entityObject": {
            "id": "72602ae9-66ab-4065-8305-d374ff14a4bf",
            "hierarchyEntityId": "HierarchyEntityId",
            "parentId": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
            "data": {
              "title": "objectTitle",
              "objectNumber": 3
            },
            "created": 1664292962695,
            "createdBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
            "modified": 1664292962695,
            "modifiedBy": "ccdeecc5-ff63-4c98-80d6-bab044cc5f1e",
            "removed": false,
            "version": 2
          },
          "isMatched": true,
          "childrenCount": 0,
          "children": []
        }
      ]
    }
  ],
  "total": 1
}

Получение списка объектов иерархий с поиском, сортировкой и пагинацией.

• Input: Search
• Output: Page[HierarchyEntityObjectExtendedDTO]

Объекты сервиса hierarchy-entities

HierarchyEntity

HierarchyEntityCreateDTO

HierarchyEntityUpdateDTO

HierarchyEntityObject

HierarchyEntityObjectCreateDTO

HierarchyEntityObjectUpdateDTO

HierarchyEntityObjectExtendedDTO

ChildrenAction

Действие с дочерними объектами при удалении объекта. Возможные подтипы:

CascadeDelete

Каскадно удалить всех потомков сущности.

VerifyAbsence

Убедиться в отсутствии детей. При их наличии не удалять сущность и вернуть ошибку.

Ignore

Не делать с детьми ничего.

ReattachToGrandparent

Прикрепить детей сущности к её текущему родителю. Если сущность была корневой (parentId == null), то её дети станут корневыми.

ReattachToAnother

Прикрепить детей сущности к другой указанной сущности. Если newParent == null, дети станут корневыми сущностями.

HierarchyEntityObjectDeleteWithChildrenCheckDTO

HierarchyEntityObjectDeleteBatchWithChildrenCheckDTO

iua-adapter: сервис взаимодействия со СМЭВ

Сервис реализует kafka интерфейс для взаимодействия с ИУА. Два топика, для приема и отправки сообщений, задаются в конфигурации. Также реализована конвертация в/из xml с помощью шаблонов mustache Команды могут приходить как по HTTP, так и через Kafka в топик IUA_ADAPTER_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Информацию по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/iuaadapter_db
• База ИУА по указанному в конфиге адресу
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • IUA_ADAPTER_DB_HOST
  • IUA_ADAPTER_DB_PORT
  • IUA_ADAPTER_DB_NAME
  • IUA_ADAPTER_DB_USER
  • IUA_ADAPTER_DB_PASSWORD
  • IUA_ADAPTER_SMEVDB_HOST
  • IUA_ADAPTER_SMEVDB_PORT
  • IUA_ADAPTER_SMEVDB_NAME
  • IUA_ADAPTER_SMEVDB_USER
  • IUA_ADAPTER_SMEVDB_PASSWORD

Запуск из консоли с помощью SBT

IUA_ADAPTER_DB_HOST=localhost IUA_ADAPTER_DB_PORT=5432 IUA_ADAPTER_DB_NAME=iuaadapter_db IUA_ADAPTER_DB_USER=postgres IUA_ADAPTER_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса iua-adapter

Все доступные переменные окружения для настройки сервиса.