Changes for page Communication between models

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,5 +1,5 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-In this microlearning explains about sharing data across systems in a multi-model environment using event streaming and web services. It discusses the processes, best practices, and considerations for implementing these concepts. Take a look to gain a deeper understanding of how communication between systems in different models can be achieved effectively.
	2	+In this microlearning, we'll explore the best practices for communication between two eMagiz models. Effective communication is crucial, and it's important to prioritize security, loose coupling, maintainability, and clarity. We'll discuss why using queues for inter-model communication is generally discouraged and why alternatives like web services and Event Streaming are preferred. By focusing on these key considerations, you'll be better equipped to design robust and maintainable integration solutions within eMagiz.
3	3
4	4	Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
...	...	@@ -6,23 +6,17 @@
6	6	== 1. Prerequisites ==
7	7
8	8	* Expert knowledge of the eMagiz platform
9		-* Fundamental [[eMagiz Multi-model>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-multi-model-explained.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	13
14	14	== 2. Key concepts ==
15	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
	12	+This microlearning focuses on communication between two eMagiz models. When communicating to any external party (from the view of a specific model), you should always consider the following:
18	18
19		-When selecting a method to communicate between models always consider the following concepts:
20	20	* Security
21	21	* Loose coupling
22	22	* Maintainability
23	23	* Clarity
24	24
25		-== 3. Main Multi-Model Integration Patterns ==
	19	+== 3. Communication between models ==
26	26
27	27	Most users would think that communication via queues to connect two separate eMagiz models is a bright idea. However, this is something that we do not encourage. We discourage this for several practical and technical reasons alike.
28	28
...	...	@@ -34,42 +34,14 @@
34	34
35	35	From the technical point of view, the consequence of this construction is that both models need to know each other certificates and credentials, which are not considered secure. On top of that, because you, theoretically, can exchange data from any queue to any queue, you could create a situation in which updates in one model trigger changes in the other model (i.e., when using the same data model) that are unexpected (and frankly unwanted).
36	36
37		-At the moment, the two most frequently used ways to provide communication between systems in a multi-model environment are event streaming and web services. This microlearning will discuss the processes of sharing data across systems in a multi-model environment using these concepts, including best practices.
38		-In the figure below, both processes are illustrated. The process at the top illustrates event streaming, and the process at the bottom illustrates web services. 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. For example, the systems in both models should be the same.
	31	+We advise using functionality that makes it explicit that both models function independently of each other. From eMagiz, we consider two valid alternatives for this:
	32	+- Using a web service as a communication layer between the two models. This web service can be REST or SOAP and has been implemented before
	33	+- Using the Event Streaming functionality of eMagiz to write and read from topics.
39	39
40		-[[image:Main.Images.Fundamental.WebHome@fundamental-multi-model-best-practice--event-streaming-and-webservices.png]]
	35	+Both alternatives have the benefit that the security can be tight and explicit (i.e., only model A can write/post data to model B). Furthermore, managing the solution becomes much easier as it uses the standard functionality within the platform. Therefore, we have no plans to support this approach in the product.
41	41
42		-=== 3.1 Event Streaming ===
43		-
44		-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"]].
45		-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 pattern in the second model. The picture below denotes this situation. These are the specific considerations when implementing this approach:
46		-
47		-* Leverage the credentials of the first eMagiz model in the second model
48		-* Create transparent systems with clear names and ensure to align the message type names
49		-
50		-It is necessary to transform topics to allow communication between systems in different models using event streaming. This is because it is impossible to retrieve data from a topic that exists in one model through a different model. So, systems in model B cannot immediately access the topic present in model A. The topic needs to be transformed to ensure that systems in model B can use the data on the topic in model A. By changing the topic, all systems in model B can access the transformed topic.
51		-
52		-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 must be shared between models.
53		-
54		-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 threaten security.
55		-
56		-=== 3.2 Webservices ===
57		-
58		-Web services can also be used to communicate between systems in different models. This means that model A has a web service in place, and model B has a web service in place, between which data can be exchanged.
59		-An advantage of this pattern is that it is easy to keep an overview. Setting it up does not involve many unclarities. A disadvantage is that there is much dependency across models. If the web service in model A crashes, the system in model B cannot receive data anymore.
60		-
61		-=== 3.3 Naming Conventions ===
62		-
63		-For clarity purposes, it is advised to give the systems that are the same across models the same name and 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 which models have the same systems, and systems can be found more easily.
64		-
65	65	== 4. Key takeaways ==
66	66
67		-* Event streaming and webervices are mainly used to communicate between systems across models.
68		-* To allow communication between systems in different models using event streaming, it is needed to transform topics.
69		-* Communication between systems in different models can also directly be achieved using web services.
70		-* 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.
71		-* Both patterns have their advantages and disadvantages.
72		-
73	73	* Consider the following when communication between two models
74	74	** Security
75	75	** Loose coupling
...	...	@@ -81,6 +81,7 @@
81	81	* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
82	82	** [[eMagiz Security Guide (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-security-guide||target="blank"]]
83	83	** [[Multi-Model Explained (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-multi-model-explained.WebHome||target="blank"]]
	50	+** [[Multi-Model Best Practice (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-multi-model-best-practice.WebHome||target="blank"]]
84	84	* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
85	85	** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]]
86	86	*** [[Checklist for Splitting Models (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.Checklist for Splitting Models.WebHome||target="blank"]]