Skip to Content
Last modified by Erik Bakker on 2024/09/05 14:00
From version 24.1
edited by Erik Bakker
on 2024/09/05 13:57
Change comment: There is no comment for this version
To version 15.1
edited by Erik Bakker
on 2022/07/28 10:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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.
2 +When your integration landscape grows through time, you might decide to split functional business processes into multiple eMagiz models. In those cases, the question of connecting these models easily, stable, and securely could arise. This microlearning will focus on that question and provide an answer based on our vision and best practices when dealing with the platform.
3 3  
4 4  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,7 +9,7 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
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:
12 +This microlearning focuses on communication between two eMagiz models. When communicating to any external party (from the view of a certain model) you should always consider the following:
13 13  
14 14  * Security
15 15  * Loose coupling
... ... @@ -18,24 +18,31 @@
18 18  
19 19  == 3. Communication between models ==
20 20  
21 -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.
21 +In a low-code platform like eMagiz, you want to prevent using custom scripting as much as possible. However, sometimes in practice, you encounter situations that cannot be realized with the standard toolbox provided within the platform. As a result, we offer the option to use a Groovy script in these situations to achieve the desired solution. In this microlearning, we will look at where you can use a Groovy script and discuss the key considerations when implementing a Groovy script within your model.
22 22  
23 -When looking at the practical side of things getting it configured correctly is time-consuming and an error-prone action (as is evident by the question). Furthermore, it can lead to unexpected situations where you make a typo to listen to a queue on which no messages are provided. This queue will, however, be registered on the JMS level (when you activate the flow in question with the custom configuration), which can lead to confusing queue statistics and even more troublesome false-positive alerting based on missing queue metrics or missing consumers.
23 +Most users would think that communication via queues to connect two separate eMagiz models is a smart idea. However, this is something that we do not encourage. We discourage this for several practical and technical reasons alike.
24 24  
25 -On top of that, when you allow one model to write and read from queues registered in another model, maintaining both models will become very complex. This holds for the ones working on the project at the moment but also for those working on it at a later stage and does that need to provide (incidental) support on the environments.
25 +When looking at the practical side of things getting it configured correctly is time-consuming and an error-prone action (as is evident by the question). Furthermore, it can lead to unexpected situations in which you make a typo to listen to a queue on which no messages are provided. This queue will however be registered on the JMS level (when you activate the flow in question with the custom configuration) which can lead to confusing queue statistics and even more troublesome false-positive alerting based on missing queue metrics or missing consumers.
26 26  
27 -Another practical reason for not wanting this is that we do not actively support this use case from eMagiz. This means that when we update our technical infrastructure, we will not consider this scenario. This could lead to additional work in the future and reduced stability of your solution.
27 +On top of that because you basically allow one model to write and read from queues registered in another model maintaining both models will become very confusing for the ones working on the project at the moment but also for those working on it at a later stage and does that need to provide (incidental) support on the environments.
28 28  
29 -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).
29 +Another practical reason for not wanting this is that we do not actively support this use case from eMagiz. This means that when we do updates to our technical infrastructure we will not take this scenario into account. This could lead to additional work on your part in the future and reduced stability of your solution.
30 30  
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
31 +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).
32 +
33 +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:
34 +- Using a web service as a layer of communication between the two models. This web service can be REST or SOAP and has been implemented before
33 33  - Using the Event Streaming functionality of eMagiz to write and read from topics.
34 34  
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.
37 +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 a lot easier as it makes use of the standard functionality within the platform. We have no plans to support this approach in the product.
36 36  
37 -== 4. Key takeaways ==
39 +== 4. Assignment ==
38 38  
41 +Consider what your criteria are when communicate between models and compare them to our criteria.
42 +This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
43 +
44 +== 5. Key takeaways ==
45 +
39 39  * Consider the following when communication between two models
40 40  ** Security
41 41  ** Loose coupling
... ... @@ -42,14 +42,10 @@
42 42  ** Maintainability
43 43  ** Clarity
44 44  
45 -== 5. Suggested Additional Readings ==
52 +== 6. Suggested Additional Readings ==
46 46  
47 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
48 -** [[eMagiz Security Guide (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-security-guide||target="blank"]]
49 -** [[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"]]
51 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
52 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]]
53 -*** [[Checklist for Splitting Models (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.Checklist for Splitting Models.WebHome||target="blank"]]
54 -* [[Communication between models (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=communication+between+models||target="blank"]]
55 -)))((({{toc/}}))){{/container}}{{/container}}
54 +If you are interested in this topic and want more information, please consult us at [[productmanagement@emagiz.com>>mailto:productmanagement@emagiz.com]]
55 +
56 +== 7. Silent demonstration video ==
57 +
58 +As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}