Wiki source code of Multi-Model Best Practice

Last modified by Carlijn Kokkeler on 2023/07/07 13:53
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 In this fundamental, the best practices for the eMagiz multi-model environment will be discussed and illustrated.
3
4 Should you have any questions, please get in touch with academy@emagiz.com.
5
6 == 1. Prerequisites ==
7
8 * Some context on the eMagiz multi-model environment and integration patterns will be useful:
9 * Fundamental [[eMagiz Multi-model>>doc:Main.eMagiz Academy.Fundamentals.eMagiz Multi-model.WebHome||target="blank"]]
10 * Fundamental [[eMagiz Event Streaming>>doc:Main.eMagiz Academy.Fundamentals.fundamental-event-streaming-introduction||target="blank"]]
11 * Fundamental [[eMagiz API Gateway>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction||target="blank"]]
12 * Fundamental [[eMagiz Messaging>>doc:Main.eMagiz Academy.Fundamentals.fundamental-messaging-introduction||target="blank"]]
13
14 == 2. Key Concepts ==
15
16 * Model - the integration model of a client that runs on a specific cloud slot of eMagiz
17 * Multi-model - several integration models of a single client
18
19
20 == 3. Main Multi-Model Integration Patterns ==
21
22 At the moment, there are two most frequently used ways to provide communication between systems in a multi-model environment. These concern event streaming and webservices. The processes of sharing data across systems in a multi-model environment using these concepts will be discussed in this microlearning, including best practices.
23 In the figure below, both processes are illustrated. The process at the top illustrates event streaming, the process at the bottom webservices. Model A and model B are two different models, where a system in model B should have access to the same data as the system in model A. I.e., the systems in both models should be the same.
24
25 [[image:Main.Images.Fundamental.WebHome@fundamental-multi-model-best-practice--event-streaming-and-webservices.png]]
26
27 === 3.1 Event Streaming ===
28
29 To understand the following section, it is necessary to have some background information about event streaming, which can be found [[here>>doc:Main.eMagiz Academy.Fundamentals.fundamental-event-streaming-introduction||target="blank"]].
30 The first option is to decide the alignment of the data models between both models. Whenever data from the first model is transferred to the second model, and the topic is considered input for other systems and integrations in that other model, the data needs to be transformed to the common data model of that second model. THis way, the topic can be exposed to any system and any pattern in the second model. The picture below denotes this situation. These are the specific considerations when implementing this approach:
31 * Leverage the credentials of the first eMagiz model in the second model
32 * Create clear systems with clear names and ensure to align the message type names
33
34 To allow communication between systems in different models using event streaming, it is needed to transform topics. The reason for this, is that it is not possible to retrieve data from a topic existent in one model through a different model. So, the topic present in model A cannot be immediately accessed by systems present in model B. To ensure that systems in model B can use the data on the topic in model A, the topic needs to be transformed. By transforming the topic, all systems in model B can access the transformed topic.
35
36 To ensure that the topic from model A can be transformed, model B needs credentials from model A. So, to allow for this pattern, credentials have to be shared between models.
37
38 An advantage of this pattern is that there is no dependency across models. If the system in model A breaks down, the system in model B can still work. A disadvantage of this pattern is that there may be struggles with the setup, since no direct accessibility can be achieved. Moreover, as mentioned above, credentials have to be shared, which may be a threat to the security.
39
40 === 3.2 Webservices ===
41
42 Communication between systems in different models can also be achieved using web services. This means that model A has a webservice in place, and model B has a webservice in place, between which data can be exchanged.
43 An advantage of this pattern is that it is easy to keep an overview, there are not many unclarities in setting it up. A disadvantage of this pattern is that there is much dependency across models. If the webservice in model A crashes, the system in model B cannot receive data anymore.
44
45 === 3.3 Naming Conventions ===
46
47 For clarity purposes, it is advised to give the systems that are the same across models the same name, as well as the name of the other model in which the system is present. So, as illustrated in the figure, the system names in model A and B are partly the same (‘SYS’), and indicate which model also holds the system (model B in model A, model A in model B). This way, it remains clear in which models the same systems are present, and systems can be found more easily.
48
49 == 4. Key Takeaways ==
50
51 * Event streaming and webervices are mainly used to communicate between systems across models.
52 * To allow communication between systems in different models using event streaming, it is needed to transform topics.
53 * Communication between systems in different models can also directly be achieved using web services.
54 * For clarity purposes, it is advised to give the systems that are the same across models the same name, as well as the name of the other model in which the system is present.
55 * Both patterns have their advantages and disadvantages.
56
57 == 5. Suggested Additional Readings ==
58
59 * [[Messaging>>doc:Main.eMagiz Academy.Fundamentals.fundamental-messaging-introduction||target="blank"]]
60 * [[API Gateway>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction||target="blank"]]
61 * [[Event Streaming>>doc:Main.eMagiz Academy.Fundamentals.fundamental-event-streaming-introduction||target="blank"]]
62 * [[Data Models >>doc:Main.eMagiz Academy.Fundamentals.fundamental-data-models||target="blank"]]
63 * [[Understanding Design Architecture - Basic>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-understanding-design-architecture-basic||target="blank"]]
64
65 )))((({{toc/}}))){{/container}}{{/container}}