Changes for page Multipart form-data

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Multipart form-data
	1	+expert-data-handling-multipart-form-data

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	+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,43 +9,17 @@
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 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		-Key aspects are:
	14	+* Security
	15	+* Loose coupling
	16	+* Maintainability
	17	+* Clarity
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
	19	+== 3. Communication between models ==
19	19
20		-== 3. Multipart form-data ==
	21	+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.
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.
23		-
24		-Key aspects are:
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
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.
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.
33		-
34		-On top of that we need to define the contentType header as follows.
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	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	50
51	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.
...	...	@@ -77,10 +77,8 @@
77	77
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:
	54	+If you are interested in this topic and want more information, please consult us at [[productmanagement@emagiz.com>>mailto:productmanagement@emagiz.com]]
81	81
82		-* https://www.sobyte.net/post/2021-12/learn-about-http-multipart-form-data/
83		-
84	84	== 7. Silent demonstration video ==
85	85
86	86	As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}