Changes for page Multipart form-data
Last modified by Erik Bakker on 2024/06/17 11:39
From version 20.1
edited by Erik Bakker
on 2022/08/05 14:50
on 2022/08/05 14:50
Change comment:
There is no comment for this version
To 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
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Multipartform-data1 +Image Transformations - Default language
-
... ... @@ -1,1 +1,0 @@ 1 -en - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - Sometimeswhenyoucall an externalRESTendpoint, theyrequire youtosend metainformationandone or more"attachments"inonecall to theRESTendpoint.To makehispossible,you needtosendtheinformationwith thecontentType calledmultipart/form-data. In this microlearning,we will discuss howyou canconfigurea validmessagewithintheeMagizplatformthatallowsyoutosendout messageswiththis contentTypeand have themacceptedbytheendpoint inquestion.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,72 +9,50 @@ 9 9 10 10 == 2. Key concepts == 11 11 12 -This microlearning focuses on configuring amultipart/form-data message within eMagiz toensureit is sentcorrectly toan endpoint.12 +This microlearning focuses on performing image transformations in eMagiz. 13 13 14 - Keyaspects are:14 +With image transformation, we mean transforming the raw data that represents an image to another image format. 15 15 16 -* Definingtheboundary that separatesthe partsofthemessage17 -* Definingthecontenttypesofeachpartofthemessage18 -* Constructionofthecompletemessageaccording to thespecification16 +* 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. Multipartform-data==20 +== 3. Image Transformation == 21 21 22 - Sometimeswhenyoucall an externalRESTendpoint, theyrequire youtosend metainformationandone or more"attachments"inonecall to theRESTendpoint.To makehispossible,you needtosendtheinformationwith thecontentType calledmultipart/form-data. In this microlearning,we will discuss howyou canconfigurea validmessagewithintheeMagizplatformthatallowsyoutosendout messageswiththis contentTypeand have themacceptedbytheendpoint inquestion.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 - Keyaspectsare:24 +Before we dive into the specifics of how to configure this let us first consider the following: 25 25 26 -* Definingtheboundary that separatesthe partsofthemessage27 -* Definingthecontenttypesofeachpartofthemessage28 -* Constructionofthecompletemessageaccording to thespecification26 +* 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 - ===3.1Prepare the message===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 - To construct themessage, several steps areneeded to makeit work. Luckily, most of the stepsnecessaryhavetodo withconceptswe have already discussedinprevious microlearnings. As you can imagine,basedon what multipart/form-dataentails, we needa waytoboth store themeta informationand thefile(s) we want to send to the externalparty. For example,putthemetadatainone(or multiple)header(s) andusethefile contentas a payload. Thisyou can achievewitha headerenricherandstandard transformer.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 - Oncethe filententis your payload, youmustensurehatthedatais"raw." Sowhenyou havebase64 encodedstring, you should decode itbefore sending ittothe endpoint.34 +[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]] 35 35 36 -On top of that, we need to define the contentType header. 37 - 38 -[[image:Main.Images.Microlearning.WebHome@expert-data-handling-multipart-form-data--content-type-header-config.png]] 39 - 40 -=== 3.2 Construct the message === 41 - 42 -After you have set the stage, you can use a standard transformer component to build your message correctly. To create it correctly, you need to take the following into account: 43 - 44 -* Each part of the message needs to be separated by a boundary 45 -* The message needs to start with a boundary and finish with a boundary 46 -* Line breaks are needed to differentiate between the boundary and the text content 47 -* No line break is needed when the content is not text-based 48 - 49 -Given all this, you can write the following SpEL expression that will yield a desirable output: 50 - 51 -{{code}}'${multi-part-form-data.data-handling.boundary}' + headers.metaInfo + T(com.emagiz.util.Newline).CRLF.characters + '${multi-part-form-data.data-handling.boundary}' + T(com.emagiz.util.Newline).CRLF.characters + 'Content-Disposition: form-data; name="file"; filename="' + headers.filename + '"' + T(com.emagiz.util.Newline).CRLF.characters + 'Content-Type: application/pdf' + T(com.emagiz.util.Newline).CRLF.characters + T(com.emagiz.util.Newline).CRLF.characters + payload + '${multi-part-form-data.data-handling.boundary}'{{/code}} 52 - 53 -Putting this in a standard transformation gives you the following solution in the flow. 54 - 55 -[[image:Main.Images.Microlearning.WebHome@expert-data-handling-multipart-form-data--standard-transformer-config.png]] 56 - 57 -=== 3.3 Calling the endpoint === 58 - 59 -Now that we have constructed our message correctly, the last thing to do is call the endpoint in question. Since we have prepared our message and accurately defined our contentType calling the endpoint does not require any additional configurations compared to what you are already used to when dealing with REST endpoints. 60 - 61 61 == 4. Assignment == 62 62 63 - Try to see whetheryou canconstructtheflowsothatit outputs avalidmultipart/form-datamessage.64 -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. 65 65 66 66 == 5. Key takeaways == 67 67 68 -* Make sure to define the boundary that separates the parts of the message 69 -* Make sure to define the content types of each part of the message 70 -* Make sure to define the content type that matches the specification for multipart/form-data 71 -* Construct the complete message according to the specification 43 +Some of the very complex XPath options are: 72 72 45 +* matches 46 +* replace 47 +* tokenize 48 + 73 73 == 6. Suggested Additional Readings == 74 74 75 -If you are interested in this topic, please read the help text son theplatformand 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: 76 76 77 -* 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 78 78 79 79 == 7. Silent demonstration video == 80 80