|
| 1 | +# Пример управления бизнес-сущностями |
| 2 | + |
| 3 | +**Цель примера:** Показать возможности по управлению бизнес-сущностями |
| 4 | +в инструменте управления архитектурой [DocHub](https://dochub.info). |
| 5 | + |
| 6 | +Помимо заявленной цели пример содержит еще несколько интересных реализаций. Например, отчет показывающий список систем/сервисов с реализацией передачи параметра в другой отчет для установки значения фильтра. |
| 7 | + |
| 8 | +# Суть примера |
| 9 | +Стояла реальная бизнес-задача показать в каких системах используются те или иные бизнес-сущности. |
| 10 | + |
| 11 | +Вторая задача определилась по ходу реализации. Оказалось что в компании нет процесса управления бизнес-сущностями на логическом уровне, что приводит к тому, что в разных сервисах одну и туже бизнес-сущность логически и физически реализуют по разному. Начиная с того что реквизиты называются по разному, могут иметь разный физический смысл и заканчивая тем, что часть сущностей с одинаковым названием физически означают разные вещи. Все это вызывает большие проблемы с интеграцией между сервисами. |
| 12 | + |
| 13 | +Поэтому было решено на базе DocHub реализовать управление логическим уровнем бизнес-сущностей и создать эталонный список бизнес-сущностей, который команды смогут использовать в качестве шаблона для создания физической реализации у себя в проектах. |
| 14 | + |
| 15 | +## Логическое описание реализации и файловая структура примера |
| 16 | +Для реализации был выбран вариант создания нового entity, который называется "business_entities". Физически business_entities было реализовано через 2 файла: |
| 17 | +* business_entities/business_entities_model.yaml - в этом файле была описана сама модель, реализован вывод в меню и несколько вариантов визуализации в виде отчетов. Все запросы переиспользуемые, так как они были добавлены в datasets/datasets.yaml |
| 18 | +* business_entities/business_entities.yaml - в этом файле хранятся значения "business_entities" |
| 19 | + |
| 20 | +Для реализации привязки бизнес-сущностей в системах/сервисах необходимо добавлять массив используемых бизнес-сущностей в раздел "business_entities": |
| 21 | +```yaml |
| 22 | +# Описываем L1 Context в нотации C4 Model |
| 23 | +components: |
| 24 | + swamp.frog.spoll: |
| 25 | + title: S.POLL # Название компоненты |
| 26 | + entity: system # Сущность компонента из PlantUML (https://plantuml.com/ru/deployment-diagram) |
| 27 | + short_description: Сервис формирования опросов |
| 28 | + description: Сервис формирования опросов |
| 29 | + business_owners: |
| 30 | + - Пиявки |
| 31 | + application_owner: Лунтик |
| 32 | + critical_level: business_operational #administrative/business_operational/business_critical/mission_critical |
| 33 | + system_category: business_app #channel_app/business_app/ext_business_app/it_app/ext_it_app |
| 34 | + aspects: # Аспекты, которе реализует компонент |
| 35 | + - hr |
| 36 | + business_entities: |
| 37 | + - bank |
| 38 | + - currency |
| 39 | + - region |
| 40 | + - chekingaccount |
| 41 | + - contractoraccount |
| 42 | + - contract |
| 43 | + links: |
| 44 | + # Интеграции между системами разных БЮ |
| 45 | + - id: swamp.frog.1cbit_finance |
| 46 | + direction: <-- |
| 47 | + - id: swamp.crocodile.crm |
| 48 | + direction: <-- |
| 49 | + - id: swamp.crocodile.spact |
| 50 | + direction: <-- |
| 51 | + |
| 52 | +``` |
| 53 | + |
| 54 | +Также было разработано несколько отчетов: |
| 55 | +* business_entities/business_entity_card.md - это карточка бизнес-сущности. Если добавить реквизиты к сущности, то в карточке они тоже будут выводиться. Для примера можно сформировать карточу бизнес-сущности "bank". |
| 56 | +* business_entities/business_entities_list.md - это список всех бизнес-сущностей с возможностью перехода в карточку конкретной бизнес-сущности. |
| 57 | +* business_entities/business_entities_in_systems.md - это список показывающий список бизнес-сущностей используемых в каждой системе. В этом отчете реализован пример установки фильтра по конкретной системе. Также реализована возможность сортировки практически по всем полям. |
| 58 | +* systems_table.md - этот отчет выводит список систем, но также к нему была добавлена ссылка для возможности выводить отфильтрованный по системе список бизнес-сущностей. |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +## Использование |
| 64 | +В меню плагина DocHub выберите пункт Документы/Моё болото. В меню вы увидите ссылки на 3 отчета. |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | +1. Выберите пункт "1. Бизнес-сущности": |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | + Нажмите на ссылку "Банки" и перейдите в карточку бизнес-сущности: |
| 73 | + |
| 74 | +  |
| 75 | + |
| 76 | +2. Выберите пункт "2. Список бизнес-сущностей в системах": |
| 77 | + |
| 78 | +  |
| 79 | + |
| 80 | + Так как в системе CRM указан ошибочный идентификатор, то в колонке "Бизнес-сущность" для этого идентификатора указана ошибка "Ошибка в идентификаторе бизнес-сущности". |
| 81 | + |
| 82 | + При нажатии на заголовок таблицы "Бизнес-сущность" вы можете отсортировать список по имени бизнес-сущности и посмотреть в каких системах используется та или иная бизнес-сущность. |
| 83 | + |
| 84 | + Нажав ссылку "Отбор по системе" можно отфильтровать список по конкретной системе: |
| 85 | + |
| 86 | +  |
| 87 | + |
| 88 | +3. Выберите пункт "3. Список систем": |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | +В колонке "Бизнес-сущности" нажмите "Ссылка". В результате выведется список бизнес-сущностей отфильтрованный по выбранной системе, аналогично пункту 2 этого раздела. |
| 93 | + |
| 94 | +## Задания для практики |
| 95 | +* Разберитесь со структурой примера, особе внимание обратите на алгоритмы формирования запросов. Если что-то не понятно, то можно почитать [документацию по JSONata](http://docs.jsonata.org/overview.html); |
| 96 | +* Попробуйте реализовать какой-нибудь свой вариант отчета переиспользовав один из запросов описанных datasets/datasets.yaml. |
0 commit comments