@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc-test.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (298) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +27 -0
  3. package/documentation/arch/aspects.yaml +81 -0
  4. package/documentation/arch/components/browser.yaml +51 -0
  5. package/documentation/arch/components/examples/context.yaml +37 -0
  6. package/documentation/arch/components/examples/order.yaml +92 -0
  7. package/documentation/arch/components/examples/payment.yaml +92 -0
  8. package/documentation/arch/components/examples/root.yaml +42 -0
  9. package/documentation/arch/components/front.yaml +309 -0
  10. package/documentation/arch/components/gitlab.yaml +81 -0
  11. package/documentation/arch/components/plantuml.yaml +57 -0
  12. package/documentation/arch/components/root.yaml +36 -0
  13. package/documentation/arch/components/user.yaml +41 -0
  14. package/documentation/arch/components/web.yaml +39 -0
  15. package/documentation/arch/contexts.yaml +99 -0
  16. package/documentation/arch/forms.yaml +36 -0
  17. package/documentation/arch/namespaces.yaml +43 -0
  18. package/documentation/arch/root.yaml +43 -0
  19. package/documentation/arch/rules.yaml +91 -0
  20. package/documentation/arch/technologies.yaml +84 -0
  21. package/documentation/dochub.yaml +32 -0
  22. package/documentation/docs/conception/archdistrib.puml +38 -0
  23. package/documentation/docs/conception/archeco.puml +11 -0
  24. package/documentation/docs/conception/archeco_proc.puml +29 -0
  25. package/documentation/docs/conception/archver.puml +24 -0
  26. package/documentation/docs/conception/facade.puml +20 -0
  27. package/documentation/docs/conception/introduction.md +144 -0
  28. package/documentation/docs/conception/mindmap.puml +55 -0
  29. package/documentation/docs/conception/root.yaml +66 -0
  30. package/documentation/docs/manual/aspects.md +37 -0
  31. package/documentation/docs/manual/backend/api.yaml +664 -0
  32. package/documentation/docs/manual/backend/search-implementation.md +190 -0
  33. package/documentation/docs/manual/backend/search.yaml +495 -0
  34. package/documentation/docs/manual/clickstream-setup.md +50 -0
  35. package/documentation/docs/manual/components.md +45 -0
  36. package/documentation/docs/manual/config/deployment.md +337 -0
  37. package/documentation/docs/manual/context_source.puml +17 -0
  38. package/documentation/docs/manual/contexts.md +200 -0
  39. package/documentation/docs/manual/datasets.md +120 -0
  40. package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
  41. package/documentation/docs/manual/docs/asyncapi.md +63 -0
  42. package/documentation/docs/manual/docs/bpmn.md +122 -0
  43. package/documentation/docs/manual/docs/charts.md +371 -0
  44. package/documentation/docs/manual/docs/docs.md +76 -0
  45. package/documentation/docs/manual/docs/drawio_intro.md +397 -0
  46. package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
  47. package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
  48. package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
  49. package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
  50. package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
  51. package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
  52. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
  53. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
  54. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
  55. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
  56. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
  57. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
  58. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
  59. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
  60. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
  61. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
  62. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
  63. package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
  64. package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
  65. package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
  66. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
  67. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
  68. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
  69. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
  70. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
  71. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
  72. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
  73. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
  74. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
  75. package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
  76. package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
  77. package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
  78. package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
  79. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
  80. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
  81. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
  82. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
  83. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
  84. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
  85. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
  86. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
  87. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
  88. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
  89. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
  90. package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
  91. package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
  92. package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
  93. package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
  94. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
  95. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
  96. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
  97. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
  98. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
  99. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
  100. package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
  101. package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
  102. package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
  103. package/documentation/docs/manual/docs/editable_table/template.md +24 -0
  104. package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
  105. package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
  106. package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
  107. package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
  108. package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
  109. package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
  110. package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
  111. package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
  112. package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
  113. package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
  114. package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
  115. package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
  116. package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
  117. package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
  118. package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
  119. package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
  120. package/documentation/docs/manual/docs/examples/example.html +2 -0
  121. package/documentation/docs/manual/docs/examples/example.puml +17 -0
  122. package/documentation/docs/manual/docs/examples/example.yaml +53 -0
  123. package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
  124. package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
  125. package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
  126. package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
  127. package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
  128. package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
  129. package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
  130. package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
  131. package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
  132. package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
  133. package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
  134. package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
  135. package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
  136. package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
  137. package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
  138. package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
  139. package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
  140. package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
  141. package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
  142. package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
  143. package/documentation/docs/manual/docs/examples/table.yaml +341 -0
  144. package/documentation/docs/manual/docs/examples/template.puml +6 -0
  145. package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
  146. package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
  147. package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
  148. package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
  149. package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
  150. package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
  151. package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
  152. package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
  153. package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
  154. package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
  155. package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
  156. package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
  157. package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
  158. package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
  159. package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
  160. package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
  161. package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
  162. package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
  163. package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
  164. package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
  165. package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
  166. package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
  167. package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
  168. package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
  169. package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
  170. package/documentation/docs/manual/docs/gigachat/template.md +38 -0
  171. package/documentation/docs/manual/docs/images/cloud.png +0 -0
  172. package/documentation/docs/manual/docs/images/component.png +0 -0
  173. package/documentation/docs/manual/docs/images/system.png +0 -0
  174. package/documentation/docs/manual/docs/images/user.png +0 -0
  175. package/documentation/docs/manual/docs/markaper.md +278 -0
  176. package/documentation/docs/manual/docs/markdown.md +148 -0
  177. package/documentation/docs/manual/docs/mermaid.md +43 -0
  178. package/documentation/docs/manual/docs/network.md +117 -0
  179. package/documentation/docs/manual/docs/plantuml.md +28 -0
  180. package/documentation/docs/manual/docs/root.yaml +736 -0
  181. package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
  182. package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
  183. package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
  184. package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
  185. package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
  186. package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
  187. package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
  188. package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
  189. package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
  190. package/documentation/docs/manual/docs/smartants.md +583 -0
  191. package/documentation/docs/manual/docs/svg_inline.md +66 -0
  192. package/documentation/docs/manual/docs/swagger.md +52 -0
  193. package/documentation/docs/manual/docs/tables.md +264 -0
  194. package/documentation/docs/manual/docs/templates/example.drawio +43 -0
  195. package/documentation/docs/manual/docs/templates/test.svg +79 -0
  196. package/documentation/docs/manual/docs/templates.md +361 -0
  197. package/documentation/docs/manual/docs/toc.md +137 -0
  198. package/documentation/docs/manual/entities/bstages.md +43 -0
  199. package/documentation/docs/manual/entities/bundle.md +105 -0
  200. package/documentation/docs/manual/entities/entities.md +727 -0
  201. package/documentation/docs/manual/entities/images/id_errors.png +0 -0
  202. package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
  203. package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
  204. package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
  205. package/documentation/docs/manual/entities/images/object_select.png +0 -0
  206. package/documentation/docs/manual/entities/images/problems.png +0 -0
  207. package/documentation/docs/manual/entities/images/select_inter.png +0 -0
  208. package/documentation/docs/manual/entities/images/stages.jpg +0 -0
  209. package/documentation/docs/manual/entities/images/suggests.png +0 -0
  210. package/documentation/docs/manual/entities/intro.md +73 -0
  211. package/documentation/docs/manual/entities/rules.md +35 -0
  212. package/documentation/docs/manual/functions/example.yaml +50 -0
  213. package/documentation/docs/manual/functions/functions.md +51 -0
  214. package/documentation/docs/manual/functions/root.yaml +39 -0
  215. package/documentation/docs/manual/images/jbps1.1.png +0 -0
  216. package/documentation/docs/manual/images/jbps1.png +0 -0
  217. package/documentation/docs/manual/images/jbps2.png +0 -0
  218. package/documentation/docs/manual/images/vsc1.png +0 -0
  219. package/documentation/docs/manual/imports.md +59 -0
  220. package/documentation/docs/manual/introduction.md +38 -0
  221. package/documentation/docs/manual/jsonata.md +268 -0
  222. package/documentation/docs/manual/plugin-settings.md +134 -0
  223. package/documentation/docs/manual/plugins/interface.md +226 -0
  224. package/documentation/docs/manual/plugins/introduction.md +256 -0
  225. package/documentation/docs/manual/plugins/root.yaml +51 -0
  226. package/documentation/docs/manual/role-model.md +80 -0
  227. package/documentation/docs/manual/root-cluster-import.md +82 -0
  228. package/documentation/docs/manual/root.yaml +199 -0
  229. package/documentation/docs/manual/rules/exceptions.md +20 -0
  230. package/documentation/docs/manual/rules/exreason.md +3 -0
  231. package/documentation/docs/manual/rules/root.yaml +58 -0
  232. package/documentation/docs/manual/rules/rules.md +8 -0
  233. package/documentation/docs/manual/rules/standard.md +3 -0
  234. package/documentation/docs/manual/rules/validators.md +109 -0
  235. package/documentation/docs/manual/technologies.md +49 -0
  236. package/documentation/docs/root.yaml +32 -0
  237. package/documentation/docs/sequence.puml +48 -0
  238. package/documentation/docs/welcome.md +3 -0
  239. package/documentation/entities/extentions/entity.yaml +136 -0
  240. package/documentation/entities/extentions/templates/people.md +4 -0
  241. package/documentation/entities/interactions/entity.yaml +412 -0
  242. package/documentation/entities/interactions/templates/blank.puml +18 -0
  243. package/documentation/entities/interactions/templates/bpmn.xml +59 -0
  244. package/documentation/entities/interactions/templates/tree.puml +11 -0
  245. package/documentation/entities/root.yaml +33 -0
  246. package/documentation/root.yaml +37 -0
  247. package/metamodel/dochub/entities/aspects/base.yaml +73 -0
  248. package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
  249. package/metamodel/dochub/entities/aspects/components.yaml +52 -0
  250. package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
  251. package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
  252. package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
  253. package/metamodel/dochub/entities/aspects/root.yaml +9 -0
  254. package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
  255. package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
  256. package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
  257. package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
  258. package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
  259. package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
  260. package/metamodel/dochub/entities/components/base.yaml +97 -0
  261. package/metamodel/dochub/entities/components/blank.yaml +64 -0
  262. package/metamodel/dochub/entities/components/contexts.yaml +55 -0
  263. package/metamodel/dochub/entities/components/docs.yaml +50 -0
  264. package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
  265. package/metamodel/dochub/entities/components/index.yaml +17 -0
  266. package/metamodel/dochub/entities/components/root.yaml +8 -0
  267. package/metamodel/dochub/entities/components/summary.yaml +58 -0
  268. package/metamodel/dochub/entities/components/symbol.yaml +113 -0
  269. package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
  270. package/metamodel/dochub/entities/components/templates/summary.md +8 -0
  271. package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
  272. package/metamodel/dochub/entities/components/tree.yaml +38 -0
  273. package/metamodel/dochub/entities/contexts/base.yaml +197 -0
  274. package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
  275. package/metamodel/dochub/entities/contexts/root.yaml +5 -0
  276. package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
  277. package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
  278. package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
  279. package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
  280. package/metamodel/dochub/entities/documents/base.yaml +73 -0
  281. package/metamodel/dochub/entities/documents/blank.yaml +28 -0
  282. package/metamodel/dochub/entities/documents/root.yaml +3 -0
  283. package/metamodel/dochub/entities/root.yaml +5 -0
  284. package/metamodel/dochub/functions/root.yaml +2 -0
  285. package/metamodel/dochub/functions/tools.yaml +46 -0
  286. package/metamodel/dochub/root.yaml +24 -0
  287. package/metamodel/dochub/rules/root.yaml +2 -0
  288. package/metamodel/dochub/rules/validators.yaml +144 -0
  289. package/metamodel/dochub/samples/01_components.yaml +23 -0
  290. package/metamodel/dochub/samples/02_contexts.yaml +23 -0
  291. package/metamodel/dochub/samples/03_documents.yaml +10 -0
  292. package/metamodel/dochub/samples/root.yaml +4 -0
  293. package/metamodel/dochub/samples/test.puml +17 -0
  294. package/metamodel/dochub.yaml +5 -0
  295. package/metamodel/docs/welcome.md +39 -0
  296. package/metamodel/root.yaml +8 -0
  297. package/package.json +29 -0
  298. package/plugin.html +1961 -0
@@ -0,0 +1,727 @@
1
+ # Сущности(entities)
2
+
3
+ Метамодель SEAF.ArchTool можно расширять. Это позволяют делать кастомные сущности.
4
+
5
+ Предположим, что мы хотим описывать сценарии взаимодействия архитектурных компонентов.
6
+ Для этого декларируем новую сущность - "interactions".
7
+
8
+ ## Декларирование новой сущности
9
+
10
+ ```yaml
11
+ entities: # Здесь описываются кастомные сущности
12
+ interactions: # Идентификатор новой сущности. Обязательно.
13
+ # Название сущности. Обязательно.
14
+ title: Взаимодействия
15
+ # Описание сущности текст или ссылка на документ. Необязательно.
16
+ description: >
17
+ Взаимодействия между компонентами
18
+ ```
19
+
20
+ Данная запись сообщила SEAF.ArchTool, что в метамодели появилась новая сущность "interactions".
21
+
22
+ Теперь, можно описать объект данной сущности.
23
+
24
+ ```yaml
25
+ # Идентификатор сущности
26
+ interactions:
27
+ # Идентификатор объекта
28
+ archtool.user:
29
+ title: Взаимодействия с пользователем
30
+ triggers:
31
+ - Просмотр архитектуры
32
+ steps:
33
+ - from: User
34
+ to: SEAF.ArchTool
35
+ value: Вход на портал
36
+ - from: SEAF.ArchTool
37
+ to: User
38
+ value: Представление архитектурных артефактов
39
+ results:
40
+ - Информация о существующей архитектуре
41
+ ```
42
+
43
+ В секции "interactions" находится произвольная структура. Ее образ и смысл полностью определяется задумкой автора.
44
+ SEAF.ArchTool, на этом этапе, ничего о ней не знает и делать с ней не умеет.
45
+
46
+
47
+ ## Схема объектов сущности
48
+
49
+ Для того, чтобы SEAF.ArchTool мог контролировать структуру и наполнение объектов сущности "interactions", необходимо
50
+ описать схему данных в специальном разделе "schema" с использованием [JSONSchema](https://json-schema.org/):
51
+
52
+ ```yaml
53
+ entities:
54
+ interactions:
55
+ title: Взаимодействия
56
+ description: >
57
+ Взаимодействия между компонентами
58
+ schema:
59
+ # Секция "interactions" будет представлять из себя объект в понятии JSONSchema
60
+ type: object
61
+ # Идентификаторы его полей должны соответствовать паттерну структурированного идентификатора
62
+ # состоящего из доменов разделенных точкой. Например: archtool.user
63
+ # Фактически, объект будет реализовывать массив ключ-значение, где идентификатор поля это ключ,
64
+ # а его значение - объект сущности.
65
+ patternProperties:
66
+ "[a-zA-Z0-9_]*(\\.[a-zA-Z0-9_]*)*$": # Шаблон
67
+ type: object # Взаимодействие будет объект
68
+ properties: # со следующей структурой
69
+ icon: # Идентификатор иконки
70
+ title: Иконка # Описание поля, которое помогает понять его смысл и выдается в подсказках
71
+ type: string # Идентификатор может быть любой строкой
72
+ minLength: 2 # Но ее длина не должна быть меньше двух символов
73
+ title: # Наименование сценария
74
+ title: Наименование
75
+ type: string
76
+ minLength: 5
77
+ triggers: # Перечень причин вызывающий данный сценарий
78
+ title: События запускающие взаимодействие
79
+ type: array
80
+ minItems: 1
81
+ items:
82
+ type: string
83
+ minLength: 5
84
+ steps: # Шаги сценария
85
+ title: Описание взаимодействия
86
+ type: array
87
+ minItems: 1 # Минимум один шаг
88
+ items:
89
+ type: object
90
+ properties:
91
+ from: # Откуда делается шаг
92
+ title: От кого
93
+ type: string
94
+ minLength: 1
95
+ to: # Куда
96
+ title: Кому
97
+ type: string
98
+ minLength: 1
99
+ value: # Что в нем происходит
100
+ title: Что
101
+ type: string
102
+ minLength: 1
103
+ # Сообщаем, что перечисленные поля обязательны
104
+ required:
105
+ - from
106
+ - to
107
+ - value
108
+ results: # Результаты данного взаимодействия
109
+ title: Результаты взаимодействия
110
+ type: array
111
+ minItems: 1
112
+ items:
113
+ type: string
114
+ minLength: 5
115
+ # Сообщаем, что перечисленные поля обязательны
116
+ required:
117
+ - title
118
+ ```
119
+
120
+ Теперь SEAF.ArchTool знает как должна быть описана структура в секции "interactions" и может подсказывать при вводе кода
121
+ в [плагине IDE](https://gitverse.ru/seafteam/seaf-archtool-core/releases):
122
+
123
+ ![Подсказки](images/suggests.png)
124
+
125
+ А также сообщать об ошибках:
126
+
127
+ ![Ошибки](images/problems.png)
128
+
129
+ Когда объекты описаны, можно получить от них пользу. Для этого понадобятся презентации.
130
+
131
+ ## Презентация объектов
132
+
133
+ Презентации позволяют генерировать представления объектов. Это могут быть диаграммы, svg картинки, terraform код и т.п.
134
+
135
+ Для генерации используются [документы](/docs/archtool.docs). Вы можете использовать любой
136
+ тип документа доступный в SEAF.ArchTool.
137
+
138
+ Для начала создадим карточку объекта. В ней будет отражаться диаграмма взаимодействия с использованием
139
+ [PlantUML](/docs/archtool.plantuml).
140
+
141
+ ```yaml
142
+ entities:
143
+ interactions:
144
+ presentations: # Представления объектов сущности. Обязательно.
145
+ blank: # Карточка объекта
146
+ # Название представления
147
+ title: Диаграмма взаимодействия
148
+ # Параметры, которые требуются представлению в формате JSONSchema
149
+ params:
150
+ type: object
151
+ properties:
152
+ id:
153
+ type: string
154
+ required:
155
+ - id
156
+ # Тип документа, который будет использоваться для представления
157
+ type: plantuml
158
+ # Шаблон, который будет использоваться для рендеринга документа
159
+ template: templates/blank.puml
160
+ # Источник данных для представления
161
+ source: > # Источник данных для рендера шаблона. Возвращает объект "interactions" по идентификатору переданному в параметрах.
162
+ (
163
+ $lookup(interactions, $params.id) ~> | steps | {"from": $lookup($$.components, from).title, "to": $lookup($$.components, to).title}|
164
+ )
165
+
166
+ ```
167
+ Этот код описывает презентацию "blank" - карточку объекта. Поле "title" содержит название презентации,
168
+ которое будет выводиться пользователю.
169
+
170
+ Поле "params" декларирует требований к передаваемым параметрам для генерации презентации в формате [JSONSchema](https://json-schema.org/).
171
+ Если параметры не будут удовлетворять схеме, будет выведена ошибка.
172
+
173
+ "type" определяет, какой тип документа будет использоваться для данного представления. Документ может
174
+ накладывать требования к матаданным. В данном случае, от типа документа зависят поля "template" и "source".
175
+
176
+ "template" содержит относительный путь к шаблону на языке [mustache](https://mustache.github.io/).
177
+ Подробнее о шаблонах можно узнать [здесь](/docs/archtool.templates).
178
+
179
+ Файл шаблона (templates/blank.puml) содержит код:
180
+ ```mustache
181
+ @startuml
182
+ {{#.}}
183
+ title {{title}}
184
+ {{#triggers}}
185
+ group {{#triggers}}{{.}}, {{/triggers}}
186
+ {{/triggers}}
187
+ {{#steps}}
188
+ "{{from}}" --> "{{to}}": {{value}}
189
+ {{/steps}}
190
+ {{#results}}
191
+ note across: {{#results}}{{.}}, {{/results}}
192
+ {{/results}}
193
+ {{#triggers}}
194
+ end
195
+ {{/triggers}}
196
+ {{/.}}
197
+ @enduml
198
+ ```
199
+
200
+ Данные для него готовятся [JSONata](https://jsonata.org/) запросом содержащимся в поле "source".
201
+ В запросе, в переменной $params, будут доступны параметры, которе передаются презентации. Например,
202
+ если в параметре "id" будет передано значение "archtool.user", то запрос вернут следующую структуру:
203
+
204
+ ```json
205
+ {
206
+ "title": "Взаимодействия с пользователем",
207
+ "triggers": [
208
+ "Просмотр архитектуры"
209
+ ],
210
+ "steps": [
211
+ {
212
+ "from": "User",
213
+ "to": "SEAF.ArchTool",
214
+ "value": "Вход на портал"
215
+ },
216
+ {
217
+ "from": "SEAF.ArchTool",
218
+ "to": "User",
219
+ "value": "Представление архитектурных артефактов"
220
+ }
221
+ ],
222
+ "results": [
223
+ "Информация о существующей архитектуре"
224
+ ]
225
+ }
226
+ ```
227
+ Это описание объекта, которое мы создали ранее. Эти данные будут переданы в шаблон для синтезирования результата.
228
+
229
+ Теперь есть возможность увидеть представление в работе. Для этого в markdown документ необходимо встроить представление
230
+ нашего объекта.
231
+
232
+ ```
233
+ ![](@entity/interactions/blank?id=archtool.user)
234
+ ```
235
+
236
+ Результатом станет диаграмма:
237
+
238
+ ![](@entity/interactions/blank?id=archtool.user)
239
+
240
+ Аналогичным образом создается презентация "tree" для визуализации иерархии сценариев взаимодействия в виде дерева.
241
+ В отличии от презентации "blank", параметры ей не требуются.
242
+
243
+ Встраиваем ее в markdown документ:
244
+
245
+ ```
246
+ ![](@entity/interactions/tree)
247
+ ```
248
+
249
+ Результат:
250
+ ![](@entity/interactions/tree)
251
+
252
+ Полный исходный код можно посмотреть [здесь](/documentation/entities/interactions/entity.yaml).
253
+
254
+ ## Встраивание в меню
255
+
256
+ Чтобы пользователи могли найти описанные объекты, сущность имеет возможность расширять пользовательское меню.
257
+ Для реализации этой возможности в поле "menu" необходимо определить какие пункты и куда нужно встроить.
258
+ В самом простом случае можно явно определить их размещение и ссылку на объект.
259
+
260
+ Например, код
261
+
262
+ ```yaml
263
+ entities:
264
+ interactions:
265
+ ...
266
+ menu: >
267
+ (
268
+ {
269
+ "location": "Взаимодействия/Пример",
270
+ "link": "/entities/interactions/blank?id=archtool.user"
271
+ }
272
+ )
273
+ ...
274
+ ```
275
+
276
+ сообщит SEAF.ArchTool, что необходимо в меню добавить пункт "Взаимодействия"->"Пример", который ведет на объект
277
+ с идентификатором "archtool.user". Для адресации объекта указывается ссылка специального формата
278
+ "/entities/interactions/blank?id=archtool.user". Где:
279
+
280
+ * **/entities/** - сообщает SEAF.ArchTool, что обращение идет к сущности;
281
+ * **interactions** - идентификатор сущности;
282
+ * **blank** - идентификатор презентации;
283
+ * **?id=archtool.user** - передаваемые параметры в формате URL;
284
+
285
+ Результат:
286
+
287
+ ![Ссылка на объект в меню](./images/menu-single.jpeg)
288
+
289
+ Обратите внимание, что в "menu" содержится запрос JSONata. Т.е. вы можете генерировать пункты меню произвольно.
290
+ Например, можно построить его в соответствии с иерархией объектов сущности "interactions".
291
+
292
+ ```yaml
293
+ entities:
294
+ interactions:
295
+ ...
296
+ menu: >
297
+ (
298
+ $interactions := $.interactions;
299
+ $makeLocation := function($id) {(
300
+ $arrleft := function($arr ,$count) {
301
+ $map($arr, function($v, $i) {
302
+ $i <= $count ? $v
303
+ })
304
+ };
305
+ $domains := $split($id, ".");
306
+ "Взаимодействия/" & $join($map($domains, function($domain, $index) {(
307
+ $lookup($interactions, $join($arrleft($domains, $index), ".")).title
308
+ )}), "/");
309
+ )};
310
+ $append([{
311
+ "icon": *.icon, /* Получаем иконку */
312
+ "link": "/entities/interactions/tree", /* Ссылка на форму представления tree (дерево дерево объектов "interactions") */
313
+ "location": "Взаимодействия" /* Расположение в меню */
314
+ }
315
+ ],
316
+ [$.interactions.$spread().{
317
+ "icon": *.icon, /* Получаем иконку */
318
+ "link": "/entities/interactions/blank?id=" & $keys()[0], /* Формируем ссылку на бланк документ */
319
+ "location": $makeLocation($keys()[0]) /* Формируем расположение в меню */
320
+ }][location]
321
+ );
322
+ )
323
+ ...
324
+ ```
325
+
326
+ Результатом работы этого запроса будет древовидное меню доступа к объектам сущности "interactions".
327
+
328
+ ![Меню взаимодействий](./images/menu-tree.jpeg)
329
+
330
+ Живой пример работы доступен вам из [меню](/entities/interactions/tree).
331
+
332
+ Поля структуры пункта меню:
333
+
334
+ * **icon** - (необязательно) иконка;
335
+ * **link** - (обязательно) URL ссылка относительная или прямая;
336
+ * **location** - (обязательно) путь размещения пункта меню в дереве меню;
337
+ * **order** - (необязательно) число, определяющее порядок вывода пункта меню (по умолчанию 10000).
338
+ Пункты меню дополнительно сортируются по алфавиту.
339
+
340
+
341
+ ## Специальный тип презентаций - upload
342
+
343
+ Данный тип презентаций служит для подготовки контента из данных архитектуры для последующего экспорта в виде файла.
344
+
345
+ Самым простым вариантом использования является выгрузка данных в формате JSON.
346
+ Пример экспорта объекта сущности "interactions":
347
+
348
+ ```yaml
349
+ entities:
350
+ interactions:
351
+ presentations:
352
+ ...
353
+ data: # Экспорт данных сценария взаимодействия в формате JSON.
354
+ type: upload # Специальный тип документа.
355
+ title: Выгрузка данных JSON
356
+ params: # JSONSchema контроля параметров
357
+ type: object
358
+ properties:
359
+ id:
360
+ type: string
361
+ required:
362
+ - id
363
+ source: > # JSONata запрос возвращающие данные для выгрузки
364
+ (
365
+ $lookup(interactions, $params.id)
366
+ )
367
+ ...
368
+ ```
369
+
370
+ Презентация станет доступна в выпадающем меню. Кликните правой кнопкой мышки на диаграмме
371
+ и выберите пункт "Выгрузка данных JSON".
372
+
373
+ ![](@entity/interactions/blank?id=archtool.user)
374
+
375
+
376
+ Более сложный пример для выгрузки BPMN диаграммы:
377
+
378
+ ```yaml
379
+ entities:
380
+ interactions:
381
+ presentations:
382
+ ...
383
+ export: # Экспорт взаимодействия в BPMN диаграмму
384
+ type: upload
385
+ # Тип выгружаемого контента. По умолчанию application/json.
386
+ # Подробнее https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
387
+ mimetype: "application/xml"
388
+ # Генерация будет происходить на основании XML шаблона
389
+ template: templates/bpmn.xml
390
+ title: Экспорт в BPMN
391
+ params:
392
+ type: object
393
+ properties:
394
+ id:
395
+ type: string
396
+ required:
397
+ - id
398
+ # Готовим данные для шаблона - преобразуем сценарий взаимодействия в BPMN диаграмму
399
+ source: >
400
+ (
401
+ $mul := 120;
402
+ $lookup(interactions, $params.id).(
403
+ $this := $;
404
+ $body := {
405
+ "id": $params.id,
406
+ "start": {
407
+ "name": $this.triggers[0],
408
+ "stepid": "step0",
409
+ "outgoing": "flow0",
410
+ "shapey": $mul,
411
+ "labely": $mul - 30
412
+ },
413
+ "steps": $this.steps ~> $map(function($v, $i) {
414
+ {
415
+ "name": $v.value,
416
+ "stepid": "step" & ($i+1),
417
+ "flowid": "flow" & ($i),
418
+ "incoming": "flow" & ($i),
419
+ "outgoing": "flow" & ($i+1),
420
+ "sourceRef": "step" & ($i),
421
+ "targetRef": "step" & ($i+1),
422
+ "shapey": ($i * $mul) + ($mul * 2),
423
+ "flowy": ($i * $mul) + ($mul * 2) - ($i = 0 ? 84 : 40),
424
+ "flowdy": ($i * $mul) + ($mul * 2)
425
+ }
426
+ })
427
+ };
428
+ $step_count := $count($body.steps);
429
+ $merge([$body, {
430
+ "end": {
431
+ "name": $this.results[0],
432
+ "stepid": "step" & ($step_count + 1),
433
+ "flowid": "flow" & ($step_count),
434
+ "incoming": "flow" & ($step_count),
435
+ "sourceRef": "step" & ($step_count),
436
+ "targetRef": "step" & ($step_count+1),
437
+ "shapey": $step_count * $mul + ($mul * 2) + 50,
438
+ "labely": $step_count * $mul - 30 + ($mul * 2) + 50,
439
+ "flowy": ($step_count * $mul) + ($mul * 2 - 40),
440
+ "flowdy": ($step_count * $mul) + ($mul * 2) + 54
441
+
442
+ }
443
+ }])
444
+ )
445
+ )
446
+ ...
447
+ ```
448
+
449
+ Содержимое шаблона "templates/bpmn.xml":
450
+
451
+ ```xml
452
+ <?xml version="1.0" encoding="UTF-8"?>
453
+ <definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="sid-38422fae-e03e-43a3-bef4-bd33b32041b2" targetNamespace="http://bpmn.io/bpmn" exporter="bpmn-js (https://demo.bpmn.io)" exporterVersion="11.1.0">
454
+ <process id="{{id}}" isExecutable="false">
455
+ <startEvent id="{{start.stepid}}" name="{{start.name}}">
456
+ <outgoing>{{start.outgoing}}</outgoing>
457
+ </startEvent>
458
+
459
+ {{#steps}}
460
+ <task id="{{stepid}}" name="{{name}}">
461
+ <incoming>{{incoming}}</incoming>
462
+ <outgoing>{{outgoing}}</outgoing>
463
+ </task>
464
+ <sequenceFlow id="{{flowid}}" sourceRef="{{sourceRef}}" targetRef="{{targetRef}}" />
465
+ {{/steps}}
466
+
467
+ <exclusiveGateway id="{{end.stepid}}" name="{{end.name}}">
468
+ <incoming>{{end.incoming}}</incoming>
469
+ </exclusiveGateway>
470
+ <sequenceFlow id="{{end.flowid}}" sourceRef="{{end.sourceRef}}" targetRef="{{end.targetRef}}" />
471
+ </process>
472
+ <bpmndi:BPMNDiagram id="BpmnDiagram_1">
473
+ <bpmndi:BPMNPlane id="BpmnPlane_1" bpmnElement="{{id}}">
474
+
475
+ <bpmndi:BPMNShape id="step0_di" bpmnElement="step0">
476
+ <omgdc:Bounds x="192" y="{{start.shapey}}" width="36" height="36" />
477
+ <bpmndi:BPMNLabel>
478
+ <omgdc:Bounds x="173" y="{{start.labely}}" width="73" height="14" />
479
+ </bpmndi:BPMNLabel>
480
+ </bpmndi:BPMNShape>
481
+
482
+ {{#steps}}
483
+ <bpmndi:BPMNShape id="{{stepid}}_di" bpmnElement="{{stepid}}">
484
+ <omgdc:Bounds x="160" y="{{shapey}}" width="100" height="80" />
485
+ </bpmndi:BPMNShape>
486
+ {{/steps}}
487
+
488
+ <bpmndi:BPMNShape id="end_di" bpmnElement="{{end.stepid}}" isMarkerVisible="true">
489
+ <omgdc:Bounds x="185" y="{{end.shapey}}" width="50" height="50" />
490
+ <bpmndi:BPMNLabel>
491
+ <omgdc:Bounds x="178" y="{{end.labely}}" width="66" height="14" />
492
+ </bpmndi:BPMNLabel>
493
+ </bpmndi:BPMNShape>
494
+
495
+
496
+ {{#steps}}
497
+ <bpmndi:BPMNEdge id="{{flowid}}_di" bpmnElement="{{flowid}}">
498
+ <omgdi:waypoint x="210" y="{{flowy}}" />
499
+ <omgdi:waypoint x="210" y="{{flowdy}}" />
500
+ </bpmndi:BPMNEdge>
501
+ {{/steps}}
502
+
503
+ <bpmndi:BPMNEdge id="{{end.flowid}}_di" bpmnElement="{{end.flowid}}">
504
+ <omgdi:waypoint x="210" y="{{end.flowy}}" />
505
+ <omgdi:waypoint x="210" y="{{end.flowdy}}" />
506
+ </bpmndi:BPMNEdge>
507
+
508
+ </bpmndi:BPMNPlane>
509
+ </bpmndi:BPMNDiagram>
510
+ </definitions>
511
+ ```
512
+
513
+ Теперь презентация станет доступна в выпадающем меню. Кликните правой кнопкой мышки на диаграмме
514
+ и выберите пункт "Экспорт в BPMN".
515
+
516
+ ![](@entity/interactions/blank?id=archtool.user)
517
+
518
+ В результате будет сгенерирован файл, который вы сможете сохранить и открыть в
519
+ [BPMN редакторе](https://demo.bpmn.io/).
520
+
521
+
522
+ ## Ссылки на объекты сущностей
523
+
524
+ ***Фича в развитии***
525
+
526
+ Ранее для полей "from" и "to" был определен тип "string":
527
+
528
+ ```yaml
529
+ ...
530
+ properties:
531
+ from:
532
+ title: От кого
533
+ type: string # <<<<<<<<<<<<<<<<<<<
534
+ minLength: 1
535
+ to:
536
+ title: Кому
537
+ type: string # <<<<<<<<<<<<<<<<<<<
538
+ minLength: 1
539
+ ...
540
+ ```
541
+ Такое описание схемы позволяет указать любое строковое значение в них.
542
+ Но в некоторых случаях необходимо, чтобы значения полей соответствовали идентификаторам уже описанных объектов.
543
+ Т.е. ссылались на ранее описанные объекты.
544
+
545
+ В этом случае необходимо использовать системную схему ссылки на объекты необходимой сущности.
546
+
547
+ Формат подключения схемы:
548
+
549
+ ```
550
+ #/$rels/<Идентификатор сущности>.<Тип поставляемого объекта>
551
+ ```
552
+
553
+ Допустим, необходимо, чтобы поля "from" и "to" заполнялись идентификаторами компонентов.
554
+ Тогда схема должна быть следующей:
555
+
556
+ ```yaml
557
+ ...
558
+ properties:
559
+ from:
560
+ title: От кого
561
+ $ref: "#/$rels/components.component"
562
+ to:
563
+ title: Кому
564
+ $ref: "#/$rels/components.component"
565
+ ...
566
+ ```
567
+
568
+ Теперь, при описании объекта сущности "interactions" в IDE (в настоящий момент доступно только в IDEA)
569
+ появится возможность выбрать идентификатор компонента из выпадающего списка.
570
+
571
+ ![Выбор объекта](images/object_select.png)
572
+
573
+ Также, появляется возможность контролировать корректность указанных идентификаторов.
574
+ IDE будет подсвечивать неверные.
575
+
576
+ ![Неверные идентификаторы](images/id_errors.png)
577
+
578
+ Здесь значения "SEAF.ArchTool" и "User" подсвечиваются желтым цветом как неверные.
579
+
580
+ ## Декларирование объектов сущности
581
+
582
+ Для того, чтобы на объекты сущности можно было ссылаться, необходимо их декларировать.
583
+ Например, необходимо предоставить возможность ссылаться на сценарии взаимодействия.
584
+ Для этого в описание сущности необходимо добавить секцию "objects":
585
+
586
+ ```yaml
587
+ ...
588
+ objects: # Декларирование объектов сущности
589
+ interaction: # Объектом сущности является взаимодействие - "interaction"
590
+ route: "/" # Путь к массиву объектов в Data Lake относительно пути /interactions
591
+ # Если route не указан, то по умолчанию он равен "/"
592
+ title: Взаимодействие # Название объекта
593
+ # JSONata генератор символа в svg для представления в диаграммах.
594
+ # $object - передается объект рендеринга. Может быть не определен. В этом случае, необходимо вернуть неспецифичный (общий) символ объекта.
595
+ # $ - Data Lake архитектуры. Может быть не определен, если Data Lake недоступен.
596
+ #
597
+ # Если символ не определен, будет использован символ по умолчанию.
598
+ symbol: >
599
+ (
600
+ '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" width="64px" height="64px">'
601
+ & '<path d="M 16 3 C 14.148438 3 12.59375 4.285156 12.144531 6 L 6 6 L 6 12 L 3 12 L 3 20 L 6 20 L 6 26 L 12.144531 26 '
602
+ & 'C 12.59375 27.714844 14.148438 29 16 29 C 17.851563 29 19.40625 27.714844 19.855469 26 L 26 26 L 26 20 L 29 20 L 29 '
603
+ & '12 L 26 12 L 26 6 L 19.855469 6 C 19.40625 4.285156 17.851563 3 16 3 Z M 16 5 C 17.117188 5 18 5.882813 18 7 C 18 '
604
+ & '8.117188 17.117188 9 16 9 C 14.882813 9 14 8.117188 14 7 C 14 5.882813 14.882813 5 16 5 Z M 8 8 L 12.144531 8 C 12.59375 '
605
+ & '9.714844 14.148438 11 16 11 C 17.851563 11 19.40625 9.714844 19.855469 8 L 24 8 L 24 12 L 21 12 L 21 20 L 24 20 L 24 24 '
606
+ & 'L 19.855469 24 C 19.40625 22.285156 17.851563 21 16 21 C 14.148438 21 12.59375 22.285156 12.144531 24 L 8 24 L 8 20 L 11 '
607
+ & '20 L 11 12 L 8 12 Z M 5 14 L 9 14 L 9 18 L 5 18 Z M 23 14 L 27 14 L 27 18 L 23 18 Z M 16 23 C 17.117188 23 18 23.882813 '
608
+ & '18 25 C 18 26.117188 17.117188 27 16 27 C 14.882813 27 14 26.117188 14 25 C 14 23.882813 14.882813 23 16 23 Z"/>'
609
+ & '</svg>'
610
+ )
611
+ ...
612
+ ```
613
+
614
+ Для демонстрации работы, модифицируем схему, добавив возможность на каждом шаге взаимодействия ссылаться
615
+ на вложенное взаимодействие.
616
+
617
+ ```yaml
618
+ ...
619
+ steps:
620
+ title: Описание взаимодействия
621
+ type: array
622
+ minItems: 1
623
+ items:
624
+ type: object
625
+ properties:
626
+ from:
627
+ title: От кого
628
+ type: string
629
+ minLength: 1
630
+ to:
631
+ title: Кому
632
+ type: string
633
+ minLength: 1
634
+ value:
635
+ title: Что
636
+ type: string
637
+ minLength: 1
638
+ sub-interactions: # Добавляем поле, в котором можно указать ссылку на вложенное взаимодействие
639
+ title: Вложенное взаимодействие
640
+ $ref: "#/$rels/interactions.interaction"
641
+ required:
642
+ - from
643
+ - to
644
+ - value
645
+ ...
646
+ ```
647
+
648
+ Теперь опишем два взаимодействия, где второе будет ссылаться на первое. Для примера будет рассмотрен
649
+ сценарий привлечения потенциального клиента SEAF.ArchTool через статьи на [Хабр](https://habr.com/ru/users/rpiontik/).
650
+
651
+ Предполагаемый сценарий перехода потенциального клиента в репозиторий проекта с Хабр:
652
+ ```yaml
653
+ interactions:
654
+ ...
655
+ archtool.customer.promotion.article:
656
+ title: Статья на Хабре
657
+ triggers:
658
+ - Выдача в поиске
659
+ results:
660
+ - Переход в репозиторий
661
+ steps:
662
+ - from: habr
663
+ to: archtool.customer
664
+ value: Анализ новых статей
665
+ - from: archtool.customer
666
+ to: habr
667
+ value: Чтение статьи о SEAF.ArchTool
668
+ - from: archtool.customer
669
+ to: archtool.gitlab.repository
670
+ value: Переход в репозиторий
671
+ ...
672
+ ```
673
+
674
+ Сценарий привлечения потенциального клиента, где в первом шаге есть ссылка на сценарий выше:
675
+
676
+ ```yaml
677
+ interactions:
678
+ ...
679
+ archtool.customer.deployment:
680
+ title: Разворачивание SEAF.ArchTool
681
+ triggers:
682
+ - Первое знакомство с SEAF.ArchTool
683
+ results:
684
+ - Потенциальный клиент (лид)
685
+ steps:
686
+ - from: archtool.customer
687
+ to: habr.articles
688
+ value: Получение информации о SEAF.ArchTool
689
+ sub-interactions: archtool.customer.promotion.article # Здесь ссылка на взаимодействие пользователя со статьями
690
+ - from: archtool.customer
691
+ to: archtool.gitlab.repository
692
+ value: Изучение инструкции
693
+ - from: archtool.customer
694
+ to: archtool.gitlab.repository
695
+ value: Развертывание
696
+ - from: archtool.customer
697
+ to: archtool
698
+ value: Первый опыт
699
+ ...
700
+ ```
701
+
702
+ При редактировании поля "sub-interactions" IDE предложит варианты:
703
+
704
+ ![Выбор взаимодействия](images/select_inter.png)
705
+
706
+ Теперь, для наглядности связности сценариев добавим возможность "проваливаться" во вложенные сценарии.
707
+ Для этого модифицируем шаблон презентации "blank":
708
+
709
+ ```mus
710
+ @startuml
711
+ ...
712
+ {{/triggers}}
713
+ ...
714
+ "{{from}}" --> "{{to}}": {{#sub-interactions}}[[/entities/interactions/blank?id={{sub-interactions}} {{value}}]]{{/sub-interactions}}{{^sub-interactions}}
715
+ ...
716
+ {{#triggers}}
717
+ ...
718
+ @enduml
719
+ ```
720
+
721
+ Результат:
722
+
723
+ ![](@entity/interactions/blank?id=archtool.customer.deployment)
724
+
725
+
726
+
727
+