Skip to Content

Changes for page Data Exchange

Last modified by Waria on 2026/07/23 10:11
From version 9.1
edited by Erik Bakker
on 2022/07/26 12:56
Change comment: There is no comment for this version
To version 21.1
edited by Waria
on 2026/07/23 10:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Image Transformation
1 +Data Exchange
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.waria
Content
... ... @@ -1,5 +1,7 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
2 -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).
1 +{{container}}
2 +{{container layoutStyle="columns"}}
3 +(((
4 +In this section, we’ll examine how eMagiz manages data exchange between applications and integrations, focusing on security considerations for each method. eMagiz supports three main integration patterns: Messaging, API Gateway, and Event Streaming. We'll explore the security measures associated with each pattern, including options like OpenID Connect, OAuth2.0, and access control lists. By understanding these patterns and their specific security configurations, you'll be better equipped to protect data and ensure secure interactions across your integrations.
3 3  
4 4  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,55 +9,77 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning focuses on performing image transformations in eMagiz.
14 +This microlearning focuses on security considerations when exchanging data via the platform.
13 13  
14 -By image transformation, we mean transforming the raw data that represents an image into another image format.
16 +* Each pattern comes with generic and specific checks and balances to ensure security is taken care of when exchanging data.
15 15  
16 -* Read the help text 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
18 +== 3. Data Exchange ==
19 19  
20 -== 3. Image Transformation ==
20 +Because eMagiz provides the integration between two or more applications via the eMagiz platform, the point at which the data is interchanged between application and integration is a critical part of the integration in terms of security.
21 +Within eMagiz, there are three main integration patterns a user can configure to support their business case most optimally. First, this section will look at all three integration types and specify the security measures.
21 21  
22 -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).
23 +=== 3.1 Messaging ===
23 23  
24 -Before we dive into the specifics of how to configure this, let us first consider the following:
25 +Messaging is the most flexible option of the three; therefore, a wide range of options is available within eMagiz to secure the connections.
26 +eMagiz offers users the tools to set up integrations and end-points securely. eMagiz supports well-known market standards, including:
25 25  
26 -* Read the help text 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
28 +* OpenID Connect
29 +* WS-Security
30 +* API Keys in combination with HTTPS/SSL
31 +* SOAP Authentication
32 +* OAuth2.0
33 +* Basic Authentication
29 29  
30 -{{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}}
35 +This way, each connection between the application and the integration (end-point) can be adequately secured and gives the flexibility to confer with the external application which method best suits their needs.
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 necessary component. For example, in the left panel, you can search for "Image." This will yield the following result.
37 +=== 3.2 API Gateway ===
33 33  
34 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]]
39 +The front-end of your API Gateway can be secured using a structure with users and permissions. The security of the backend of the API Gateway can be customized just as for messaging. Confer with your external party how the backend needs to be secured.
35 35  
36 -After dragging the component onto the canvas, you must define the channels first.
41 +eMagiz offers multiple authentication methods for API Gateway users: OAuth 2.0, Basic Auth and API Key. These can be configured per user. This means that you can choose the strongest authentication method supported by the consuming application.
42 +
43 +For OAuth 2.0 eMagiz hosts an authorization server per customer environment which functions as the IDP (identity provider). By communicating with this IDP via the OAuth2.0 protocol, a check is done every time a client calls a specific operation to see whether that client can access the API Gateway and has sufficient rights to access the operation.
44 +
45 +Although users can authenticate using OAuth 2.0, Basic Auth, or an API Key, eMagiz validates all requests through the same authorization infrastructure. Basic Auth and API Key credentials are translated internally to OAuth-based authorization, ensuring that user permissions are evaluated consistently regardless of the chosen authentication method. This centralizes authorization logic and reduces the risk of differences in security behavior between authentication mechanisms.
46 +
47 +To learn more about configuring API security and user permissions check out the [[API Gateway Crash Course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]].
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-help.png]]
49 +=== 3.3 Event Streaming ===
39 39  
40 -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.
51 +Within the Event Streaming solution, eMagiz provides Event Streaming users, and topics can be created.
52 +Access to a topic within a cluster is governed by an Access Control List (ACL). This ACL links users to a topic and defines what the user can do on a topic (consume, produce, both).
41 41  
42 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-image-options.png]]
54 +Only users with sufficient rights in the Deploy phase of eMagiz can add users, and topics and change the ACL entries specific to the Event Streaming cluster.
43 43  
44 -Once you have done this, the component configuration is finished, and you can transform your input image to a desired output image format.
56 +Apart from producing or consuming data on specific topics based on the ACL, users also need a valid Keystore (containing the key and cert generated automatically) and a valid truststore (containing the CA certificate of the event streaming cluster) to produce or consume data.
45 45  
46 -== 4. Assignment ==
58 +These are all security measures to prevent third parties from unauthorized access to the data stored on the topics.
47 47  
48 -Check whether the solution we discussed today can be found within your project.
49 -This assignment can be completed within the (Academy) project you created/used in the previous assignment.
60 +For more information on how this precisely can be configured via the eMagiz platform, please check the following [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-user-management||target="blank"]].
50 50  
51 -== 5. Key takeaways ==
62 +=== 3.4 General ===
52 52  
53 -* Read the help text of the component to understand which formats are supported
54 -* Ensure the input image is supplied in the correct format
55 -* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
64 +Regardless of the selected pattern for your solution, it would be best if you always considered that you only exchange relevant information with the external party. This means you should consider both headers as the payload you need to exchange with the external party. This is particularly interesting for any communication via HTTP gateways as they hold functionality to send all message headers as HTTP headers and vice versa.
56 56  
57 -== 6. Suggested Additional Readings ==
66 +== 4. Key takeaways ==
58 58  
59 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
68 +* Each pattern comes with generic and specific checks and balances to ensure security is taken care of when exchanging data.
69 +* When you are not careful, you might share too much information with external parties.
60 60  
61 -== 7. Silent demonstration video ==
71 +== 5. Suggested Additional Readings ==
62 62  
63 -As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}
73 +* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
74 +** [[eMagiz Security Guide (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-security-guide||target="blank"]]
75 +* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
76 +** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
77 +*** [[API User Management (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-user-management||target="blank"]]
78 +** [[Crash Course Event Streaming (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.WebHome||target="blank"]]
79 +*** [[User Management - Event Streaming (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-user-management||target="blank"]]
80 +* [[Data exchange (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=data+exchange||target="blank"]]
81 +)))
82 +
83 +(((
84 +{{toc/}}
85 +)))
86 +{{/container}}
87 +{{/container}}