Changes for page Communication between models

Last modified by Erik Bakker on 2024/09/05 14:00

From 6.1 to 7.1 From 15.1 to 16.1

From version 7.1

edited by Erik Bakker
on 2022/07/26 09:05

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

Raw
Rendered

Summary

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

Details

Page properties

Title

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

Default language

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

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++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.
  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -6,82 +6,53 @@
  == 1. Prerequisites ==
  * Expert knowledge of the eMagiz platform
--* [[XPath Basic>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]
--* [[XPath Intermediate>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]]
--* [[XPath Advanced>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]]
--
  == 2. Key concepts ==
--This microlearning focuses on very complex XPath operations.
++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:
--With XPath Expert, we mean learning that XPath options are sometimes very complex but could benefit you in specific cases in your daily work.
++* Security
++* Loose coupling
++* Maintainability
++* Clarity
--Some of the very complex XPath options are:
++== 3. Communication between models ==
--* matches
--* replace
--* tokenize
++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.
--== 3. XPath Expert ==
++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.
--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.
++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.
--Some of the very complex XPath options are:
++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.
--* matches
--* replace
--* tokenize
++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.
--=== 3.1 matches ===
++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).
--Sometimes, you want to determine whether a specific value within your payload matches a pattern. In those cases, you can use the XPath function called matches. The function will return true if the supplied string matches a given regular expression. So, for example, if you want to check whether your OrderID contains exactly seven digits and nothing else, the following XPath expression will work for your use case.
++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:
++- 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
++- Using the Event Streaming functionality of eMagiz to write and read from topics.
--matches(OrderID,'^\d{7}$')
++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.
--As a result, you will get a true or false back which you can then use as a filter or within an if-then-else construction.
--
--=== 3.2 replace ===
--
--The replace function has many similarities with the matches function. It builds on the premise of the matches function, but instead of returning a true or false, you can state with what you want to replace the matched string. In other words, this function returns a string produced from the input string by replacing any substrings that match a given regular expression with a supplied replacement string.
--
--When we apply this to our earlier example, we can state that when the OrderID contains any non-digit, we will replace this value with nothing. This will lead to the following XPath expression.
--
--replace(OrderID,'\D','')
--
--With a given input string of 12C34A567, the returned result will be 1234567.
--
--=== 3.3 tokenize ===
--
--The tokenize function can split a string into multiple entries for you. This is particularly useful when you want to match an input string to a list of possible values that are valid for that string. For example, the function returns a sequence of strings constructed by splitting the input wherever a separator is found; the separator is any substring that matches a given regular expression.
--
--So, for example, when the input string for AddressID is "street,housenumber,housenumberaddition" and you want to tokenize this with the help of the separator, you could use, in this example, the comma between the values as the separator. This will lead to the following XPath expression.
--
--tokenize(AddressID,',')
--
--The given input detailed above will result in the following output: street housenumber housenumberaddition.
--
  == 4. Assignment ==
--Check out which of the XPaths we have discussed today can be found within your project.
--This assignment can be completed within the (Academy) project you created/used in the previous assignment.
++Consider what your criteria are when communicate between models and compare them to our criteria.
++This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
  == 5. Key takeaways ==
--Some of the very complex XPath options are:
++* Consider the following when communication between two models
++** Security
++** Loose coupling
++** Maintainability
++** Clarity
--* matches
--* replace
--* tokenize
--
  == 6. Suggested Additional Readings ==
--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 links:
++If you are interested in this topic and want more information, please consult us at [[productmanagement@emagiz.com>>mailto:productmanagement@emagiz.com]]
--* http://www.xsltfunctions.com/xsl/fn_matches.html
--* http://www.xsltfunctions.com/xsl/fn_replace.html
--* http://www.xsltfunctions.com/xsl/fn_tokenize.html
--
  == 7. Silent demonstration video ==
  As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}

Changes for page Communication between models

Summary

Details

Navigation