Changes for page Multipart form-data

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Multipart form-data
	1	+Image Transformations

Default language

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

Content

...	...	@@ -1,5 +1,5 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-Sometimes when you call an external REST endpoint, they require you to send meta information and one or more "attachments" in one call to the REST endpoint. To make this possible, you need to send the information with the contentType called multipart/form-data. In this microlearning, we will discuss how you can configure a valid message within the eMagiz platform that allows you to send out messages with this contentType and have them accepted by the endpoint in question.
	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 transform images in certain 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).
3	3
4	4	Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
...	...	@@ -9,77 +9,50 @@
9	9
10	10	== 2. Key concepts ==
11	11
12		-This microlearning focuses on configuring a multipart/form-data message within eMagiz to ensure it is sent correctly to an endpoint.
	12	+This microlearning focuses on performing image transformations in eMagiz.
13	13
14		-Key aspects are:
	14	+With image transformation, we mean transforming the raw data that represents an image to another image format.
15	15
16		-* Defining the boundary that separates the parts of the message
17		-* Defining the content types of each part of the message
18		-* Construction of the complete message according to the specification
	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	19
20		-== 3. Multipart form-data ==
	20	+== 3. Image Transformation ==
21	21
22		-Sometimes when you call an external REST endpoint, they require you to send meta information and one or more "attachments" in one call to the REST endpoint. To make this possible, you need to send the information with the contentType called multipart/form-data. In this microlearning, we will discuss how you can configure a valid message within the eMagiz platform that allows you to send out messages with this contentType and have them accepted by the endpoint in question.
	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 transform images in certain 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	23
24		-Key aspects are:
	24	+Before we dive into the specifics of how to configure this let us first consider the following:
25	25
26		-* Defining the boundary that separates the parts of the message
27		-* Defining the content types of each part of the message
28		-* Construction of the complete message according to the specification
	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
29	29
30		-To actually construct the message there a several steps needed to make it work. Luckily, most of the steps needed have to do with concepts we have already discussed in previous microlearnings. As you can imagine based on what mulipart/form-data entails we need a way to both store the meta information and the file(s) we want to send to the external party. To do so it is advisable to put the metadata in one (or multiple) header(s) and use the file content as payload. This you can achieve with a header enricher and standard transformer.
	30	+{{warning}}The focus of this microlearning lies on the image transformer component. Ensuring that the input is useful and the output fits the remainder of the process is highly depending on the use case and will therefore not be discussed in this microlearning{{/warning}}
31	31
32		-Once the file content is your payload you need to make sure that the data is "raw" in nature. So when you have a base64 encoded string you should decode the string before sending it to the endpoint.
	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.
33	33
34		-On top of that we need to define the contentType header as follows.
	34	+[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]]
35	35
36		-[[image:Main.Images.Microlearning.WebHome@expert-data-handling-multipart-form-data--content-type-header-config.png]]
37		-
38		-After you have set the stage you can use a standard transformer component to build your message in the correct manner. To build it correctly you need to take the following into account:
39		-
40		-* Each part of the message needs to be seperated by a boundary
41		-* The message needs to start with a boundary and finish with a boundary
42		-* Line breaks are needed to differentiate between the boundary and the text content
43		-* No line break is needed when the content is not text based
44		-
45		-Given all this you can write the following SpEL expression that will yield a desirable output:
46		-
47		-{{code}}test{{/code}}
48		-
49		-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.
50		-
51		-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.
52		-
53		-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.
54		-
55		-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.
56		-
57		-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).
58		-
59		-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:
60		-- 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
61		-- Using the Event Streaming functionality of eMagiz to write and read from topics.
62		-
63		-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.
64		-
65	65	== 4. Assignment ==
66	66
67		-Consider what your criteria are when communicating between models and compare them to our criteria.
68		-This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
	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.
69	69
70	70	== 5. Key takeaways ==
71	71
72		-* Consider the following when communication between two models
73		-** Security
74		-** Loose coupling
75		-** Maintainability
76		-** Clarity
	43	+Some of the very complex XPath options are:
77	77
	45	+* matches
	46	+* replace
	47	+* tokenize
	48	+
78	78	== 6. Suggested Additional Readings ==
79	79
80		-If you are interested in this topic please read the helptexts in the platform and read the following link:
	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:
81	81
82		-* https://www.sobyte.net/post/2021-12/learn-about-http-multipart-form-data/
	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
83	83
84	84	== 7. Silent demonstration video ==
85	85