Changes for page Communication between models
Last modified by Erik Bakker on 2024/09/05 14:00
From version 8.1
edited by Erik Bakker
on 2022/07/26 12:49
on 2022/07/26 12:49
Change comment:
There is no comment for this version
To version 19.1
edited by Eva Torken
on 2023/12/07 15:01
on 2023/12/07 15:01
Change comment:
There is no comment for this version
Summary
-
Page properties (4 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Image Transformations1 +Communication between models - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.e bakker1 +XWiki.etorken - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - Inmost cases,youwilltransformXML messagestootherXMLmessages,oryouwilltransformJSONorEDI messagesinanotheroftheseformats.However,sometimesyou wantto performan imagetransformation.Withthisimage transformationyoucanransformimagesin certainformatsoanotherformat(i.e.png).This can comehandywhenyouwanttostandardizetheimageformatbeforeusingitfurtherdownstreaminyour businessapplication(s).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,51 +9,41 @@ 9 9 10 10 == 2. Key concepts == 11 11 12 -This microlearning focuses on performingimagetransformationsineMagiz.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: 13 13 14 -With image transformation, we mean transforming the raw data that represents an image to another image format. 14 +* Security 15 +* Loose coupling 16 +* Maintainability 17 +* Clarity 15 15 16 -* Read the helptext of the component to understand which formats are supported 17 -* Ensure the input image is supplied in the correct format 18 -* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream 19 +== 3. Communication between models == 19 19 20 - ==3.ImageTransformation==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 21 22 - Inmost cases,youwilltransformXML messagestootherXML messages,orouwilltransformJSONorEDImessages inanotherofthese formats.However,sometimes youwant toperforman imagetransformation.Withthis imagetransformation you cantransformimages incertainformatsto anotherformat(i.e. png).Thiscancomein handywhenyouwanttostandardize theimage format beforeusingit furtherdownstreaminyourbusinessapplication(s).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 23 24 - Before we dive into thespecifics ofhowtoconfigure thislet us firstconsider thefollowing: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 25 26 -* Read the helptext of the component to understand which formats are supported 27 -* Ensure the input image is supplied in the correct format 28 -* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream 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 29 30 - {{warning}}Thefocus of thismicrolearningliesontheimage transformer component.Ensuringthattheinputisusefulandthe outputfitsthe remainderoftheprocessishighlydependingontheuse caseandwillthereforenotbediscussedin this microlearning{{/warning}}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 31 32 -When turning to the Create phase of eMagiz, we need to open the flow and enter "Start Editing" mode to add the component we need. For example, in the left panel, you can search for "Image". This will yield the following result. 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 33 34 - [[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.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. 35 35 36 -== 4. Assignment ==37 +== 4. Key takeaways == 37 37 38 -Check out which of the XPaths we have discussed today can be found within your project. 39 -This assignment can be completed within the (Academy) project you created/used in the previous assignment. 39 +* Consider the following when communication between two models 40 +** Security 41 +** Loose coupling 42 +** Maintainability 43 +** Clarity 40 40 41 -== 5. Keytakeaways ==45 +== 5. Suggested Additional Readings == 42 42 43 - SomeoftheverycomplexXPathoptions are:47 +If you are interested in this topic and want more information, please consult us at [[productmanagement@emagiz.com>>mailto:productmanagement@emagiz.com]] 44 44 45 -* matches 46 -* replace 47 -* tokenize 48 - 49 -== 6. Suggested Additional Readings == 50 - 51 -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: 52 - 53 -* http://www.xsltfunctions.com/xsl/fn_matches.html 54 -* http://www.xsltfunctions.com/xsl/fn_replace.html 55 -* http://www.xsltfunctions.com/xsl/fn_tokenize.html 56 - 57 -== 7. Silent demonstration video == 58 - 59 -As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}} 49 +)))((({{toc/}}))){{/container}}{{/container}}