Changes for page Communication between models

Last modified by Erik Bakker on 2026/01/02 10:29

From 9.2 to 9.1

From version 26.1

edited by Erik Bakker
on 2026/01/02 10:29

Change comment: There is no comment for this version

To version 9.2

edited by Erik Bakker
on 2022/07/26 13:04

Change comment: Update document after refactoring.

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Communication between models
++expert-securing-data-traffic-api-gw-security-external-idp

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++In most cases, you will transform XML messages to other XML messages, or you will transform JSON or EDI messages in another of these formats. However, sometimes you want to perform an image transformation. With this image transformation, you can convert images in specific formats to another format (i.e., png). This can come in handy when you want to standardize the image format before using it further downstream in your business application(s).
  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -6,83 +6,58 @@
  == 1. Prerequisites ==
  * Expert knowledge of the eMagiz platform
--* Fundamental [[eMagiz Multi-model>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-multi-model-explained.WebHome||target="blank"]]
--* Fundamental [[eMagiz Event Streaming>>doc:Main.eMagiz Academy.Fundamentals.fundamental-event-streaming-introduction||target="blank"]]
--* Fundamental [[eMagiz API Gateway>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction||target="blank"]]
--* Fundamental [[eMagiz Messaging>>doc:Main.eMagiz Academy.Fundamentals.fundamental-messaging-introduction||target="blank"]]
  == 2. Key concepts ==
--* Model - the integration model of a client that runs on a specific cloud slot of eMagiz
--* Multi-model - several integration models of a single client
++This microlearning focuses on performing image transformations in eMagiz.
--When selecting a method to communicate between models always consider the following concepts:
--* Security
--* Loose coupling
--* Maintainability
--* Clarity
++By image transformation, we mean transforming the raw data that represents an image into another image format.
--== 3. Main Multi-Model Integration Patterns ==
++* Read the help text of the component to understand which formats are supported
++* Ensure the input image is supplied in the correct format
++* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
--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.
++== 3. Image Transformation ==
--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.
++In most cases, you will transform XML messages to other XML messages, or you will transform JSON or EDI messages in another of these formats. However, sometimes you want to perform an image transformation. With this image transformation, you can convert images in specific formats to another format (i.e., png). This can come in handy when you want to standardize the image format before using it further downstream in your business application(s).
--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.
++Before we dive into the specifics of how to configure this, let us first consider the following:
--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.
++* Read the help text of the component to understand which formats are supported
++* Ensure the input image is supplied in the correct format
++* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
--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).
++{{warning}} This microlearning focuses on the image transformer component. Ensuring that the input is valid and the output fits the remainder of the process is highly dependent on the use case and will therefore not be discussed in this microlearning{{/warning}}
--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.
--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.
++When turning to the Create phase of eMagiz, we need to open the flow and enter "Start Editing" mode to add the necessary component. For example, in the left panel, you can search for "Image." This will yield the following result.
--[[image:Main.Images.Fundamental.WebHome@fundamental-multi-model-best-practice--event-streaming-and-webservices.png]]
++[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]]
--=== 3.1 Event Streaming ===
++After dragging the component onto the canvas, you must define the channels first.
--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"]].
--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:
++[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-help.png]]
--* Leverage the credentials of the first eMagiz model in the second model
--* Create transparent systems with clear names and ensure to align the message type names
++Secondly, we must select the desired image format we want to transform. Finally, the field indicates all valid values you can choose. Please note that 'PNG' is the default selection.
--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.
++[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-image-options.png]]
--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.
++Once you have done this, the component configuration is finished, and you can transform your input image to a desired output image format.
--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.
++== 4. Assignment ==
--=== 3.2 Webservices ===
++Check whether the solution we discussed today can be found within your project.
++This assignment can be completed within the (Academy) project you created/used in the previous assignment.
--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.
--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.
++== 5. Key takeaways ==
--=== 3.3 Naming Conventions ===
++* Read the help text of the component to understand which formats are supported
++* Ensure the input image is supplied in the correct format
++* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
--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.
++== 6. Suggested Additional Readings ==
--== 4. Key takeaways ==
++If you are interested in this topic and want more information, please read the help text provided by eMagiz.
--* Event streaming and webervices are mainly used to communicate between systems across models.
--* To allow communication between systems in different models using event streaming, it is needed to transform topics.
--* Communication between systems in different models can also directly be achieved using web services.
--* 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.
--* Both patterns have their advantages and disadvantages.
++== 7. Silent demonstration video ==
--* Consider the following when communication between two models
--** Security
--** Loose coupling
--** Maintainability
--** Clarity
--
--== 5. Suggested Additional Readings ==
--
--* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
--** [[eMagiz Security Guide (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-security-guide||target="blank"]]
--** [[Multi-Model Explained (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-multi-model-explained.WebHome||target="blank"]]
--* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
--** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]]
--*** [[Checklist for Splitting Models (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.Checklist for Splitting Models.WebHome||target="blank"]]
--* [[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"]]
--)))((({{toc/}}))){{/container}}{{/container}}
++As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}