Changes for page Communication between models

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Communication between models
	1	+expert-create-your-transformations-xpath-expert

Default language

...	...	@@ -1,1 +1,0 @@
1		-en

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	+Within the crash course, we already explained XPath conceptually. In that same microlearning, we looked at some more uncomplicated cases of using XPath within your transformation. If you need to brush up on that knowledge, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]. In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]] if you need a refresher on that. In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]] that followed, we built upon that knowledge and looked at some concrete, practical examples that could be useful in your project. In this microlearning, we will wrap the concept of XPath by looking at three complex XPath alternatives that are sometimes needed when dealing with messages in 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,47 +6,86 @@
6	6	== 1. Prerequisites ==
7	7
8	8	* Expert knowledge of the eMagiz platform
	9	+* [[XPath Basic>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]
	10	+* [[XPath Intermediate>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]]
	11	+* [[XPath Advanced>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]]
9	9
	13	+
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:
	16	+This microlearning focuses on more complex XPath operations.
13	13
14		-* Security
15		-* Loose coupling
16		-* Maintainability
17		-* Clarity
	18	+With XPath Advanced, we mean learning that XPath options are complex but could benefit you in your daily work.
18	18
19		-== 3. Communication between models ==
	20	+Some of the more complex XPath options are:
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.
	22	+* dateTime calculation
	23	+* Filter list
	24	+* XPath on JSON
	25	+* SpEL notation for XPath
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.
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.
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.
	29	+== 3. XPath Advanced ==
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).
	31	+Within the crash course, we already explained XPath conceptually. In that same microlearning, we also looked at some more uncomplicated cases of using XPath within your transformation. If you need to brush up on that knowledge, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]. In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]] if you need a refresher on that. In this microlearning, we will build upon that knowledge and look at some concrete, practical examples that could be useful in your project.
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
33		-- Using the Event Streaming functionality of eMagiz to write and read from topics.
	33	+Some of the more complex XPath options are:
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.
	35	+* dateTime calculation
	36	+* Filter list
	37	+* XPath on JSON
	38	+* SpEL notation for XPath
36	36
37		-== 4. Key takeaways ==
	40	+=== 3.1 dateTime calculation ===
38	38
39		-* Consider the following when communication between two models
40		-** Security
41		-** Loose coupling
42		-** Maintainability
43		-** Clarity
	42	+Sometimes we see that a dateTime calculation is needed within a transformation to determine a specific action. As these calculations are not natively supported within the eMagiz platform, you need to use XPath's functionality to calculate the new valid date (or dateTime).
44	44
45		-== 5. Suggested Additional Readings ==
	44	+The XPath standard offers several functions to calculate with dateTime values. The two most used options are dayTimeDuration and yearMonthDuration. With the help of the dayTimeDuration, you can add, subtract, multiple, or divide seconds, minutes, hours, and days regarding the original value. The yearMonthDuration works similarly but then for months and years. An example of such an XPath is: <xsl:value-of xmlns:xs="http://www.w3.org/2001/XMLSchema" select="CDM:StartDate + xs:dayTimeDuration('P1D') * xs:yearMonthDuration('P1M')"/>. In this example, XPath adds one day and subtracts one month from the input date. Note that making this work requires the additional namespace to be defined. Therefore you need a custom snippet within your transformation or a custom transformation to make this work. Furthermore, note that the P1D and P1M could also be filled with the help of parameters to make them dynamic in nature.
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		-* [[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"]]
52		-)))((({{toc/}}))){{/container}}{{/container}}
	46	+Some examples that we saw during the years:
	47	+
	48	+* https://my.emagiz.com/p/question/172825635700358186
	49	+* https://my.emagiz.com/p/question/172825635700352588
	50	+
	51	+=== 3.2 Filter list ===
	52	+
	53	+Sometimes you have a large message which contains a certain list within it. However, logic dictates that you can only send the message if at least one entry in the list for which attribute A is filled and attribute B equals type C. To make that happen in XPath, we first need to navigate to the list within the message. As we previously learned, there are two options to do so. One is to use // to navigate to the entity somewhere in the tree directly. The other is to start at the root and walk the tree from there. In this example, we use the latter. That results in the following XPath example: /root/list[attributeB = 'type C']/attributeA !=''. With this XPath, you filter the list on the specified check and subsequently check whether one of those entries that remains has an attributeA which is filled in.
	54	+
	55	+=== 3.3 XPath on JSON ===
	56	+
	57	+With the release of build number .50, we expanded our offering on JSON messages to resemble much of the functionality we previously offered for XML messages. As a result, you can use XPath expressions on JSON messages within the following components (related to XPath):
	58	+
	59	+* XPath header enricher
	60	+* XPath transformer
	61	+* XPath router
	62	+
	63	+To activate the functionality, simply link the JSON source factory support object to one of these components to achieve the desired result. For more information, check out: https://emagiz.github.io/docs/release-notes/build50.
	64	+
	65	+=== 3.4 SpEL notation for XPath ===
	66	+
	67	+Sometimes you want to perform an XPath operation but store the header via a standard message header enricher component. As a result, you need a valid SpEL expression to help you in this cause. To do so, you need to know the correct notation for an XPath expression when using the SpEL language. An example of the correct notation is: #xpath(payload,'/root/entity/attribute')
	68	+
	69	+== 4. Assignment ==
	70	+
	71	+Check out which of the XPaths we have discussed today can be found within your project.
	72	+This assignment can be completed within the (Academy) project you created/used in the previous assignment.
	73	+
	74	+== 5. Key takeaways ==
	75	+
	76	+Some of the more complex XPath options are:
	77	+
	78	+* dateTime calculation
	79	+* Filter list
	80	+* XPath on JSON
	81	+* SpEL notation for XPath
	82	+
	83	+== 6. Suggested Additional Readings ==
	84	+
	85	+If you are interested in this topic and want more information on it, please read the help text provided by eMagiz and read more information on the following link:
	86	+
	87	+* https://www.w3schools.com/xml/xpath_intro.asp
	88	+
	89	+== 7. Silent demonstration video ==
	90	+
	91	+As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}