Skip to Content

Changes for page Groovy Script

Last modified by Erik Bakker on 2024/09/05 13:53
From version 9.2
edited by Erik Bakker
on 2022/07/26 13:04
Change comment: Update document after refactoring.
To version 7.1
edited by Erik Bakker
on 2022/07/26 09:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -expert-securing-data-traffic-api-gw-security-external-idp
1 +expert-create-your-transformations-xpath-expert
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,5 +1,5 @@
1 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).
2 +Within the crash course, we already explained XPath conceptually. In that same microlearning, we looked at some more uncomplicated cases of using XPath within your transformation. If you need to brush up on that knowledge, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]. In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]] if you need a refresher on that. In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]] that followed, we built upon that knowledge and looked at some concrete, practical examples that could be useful in your project. In this microlearning, we will wrap the concept of XPath by looking at three complex XPath alternatives that are sometimes needed when dealing with messages in eMagiz.
3 3  
4 4  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -6,58 +6,82 @@
6 6  == 1. Prerequisites ==
7 7  
8 8  * Expert knowledge of the eMagiz platform
9 +* [[XPath Basic>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]
10 +* [[XPath Intermediate>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]]
11 +* [[XPath Advanced>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]]
9 9  
13 +
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning focuses on performing image transformations in eMagiz.
16 +This microlearning focuses on very complex XPath operations.
13 13  
14 -By image transformation, we mean transforming the raw data that represents an image into another image format.
18 +With XPath Expert, we mean learning that XPath options are sometimes very complex but could benefit you in specific cases in your daily work.
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
20 +Some of the very complex XPath options are:
19 19  
20 -== 3. Image Transformation ==
22 +* matches
23 +* replace
24 +* tokenize
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).
26 +== 3. XPath Expert ==
23 23  
24 -Before we dive into the specifics of how to configure this, let us first consider the following:
28 +Within the crash course, we already explained XPath conceptually. In that same microlearning, we looked at some more uncomplicated cases of using XPath within your transformation. If you need to brush up on that knowledge, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]. In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]] if you need a refresher on that. In the [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Create your transformations.advanced-create-your-transformations-xpath-advanced.WebHome||target="blank"]] that followed, we built upon that knowledge and looked at some concrete, practical examples that could be useful in your project. In this microlearning, we will wrap the concept of XPath by looking at three complex XPath alternatives that are sometimes needed when dealing with messages in eMagiz.
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
30 +Some of the very complex XPath options are:
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}}
32 +* matches
33 +* replace
34 +* tokenize
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.
36 +=== 3.1 matches ===
33 33  
34 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]]
38 +Sometimes, you want to determine whether a specific value within your payload matches a pattern. In those cases, you can use the XPath function called matches. The function will return true if the supplied string matches a given regular expression. So, for example, if you want to check whether your OrderID contains exactly seven digits and nothing else, the following XPath expression will work for your use case.
35 35  
36 -After dragging the component onto the canvas, you must define the channels first.
40 +matches(OrderID,'^\d{7}$')
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-help.png]]
42 +As a result, you will get a true or false back which you can then use as a filter or within an if-then-else construction.
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.
44 +=== 3.2 replace ===
41 41  
42 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-image-options.png]]
46 +The replace function has many similarities with the matches function. It builds on the premise of the matches function, but instead of returning a true or false, you can state with what you want to replace the matched string. In other words, this function returns a string produced from the input string by replacing any substrings that match a given regular expression with a supplied replacement string.
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.
48 +When we apply this to our earlier example, we can state that when the OrderID contains any non-digit, we will replace this value with nothing. This will lead to the following XPath expression.
45 45  
50 +replace(OrderID,'\D','')
51 +
52 +With a given input string of 12C34A567, the returned result will be 1234567.
53 +
54 +=== 3.3 tokenize ===
55 +
56 +The tokenize function can split a string into multiple entries for you. This is particularly useful when you want to match an input string to a list of possible values that are valid for that string. For example, the function returns a sequence of strings constructed by splitting the input wherever a separator is found; the separator is any substring that matches a given regular expression.
57 +
58 +So, for example, when the input string for AddressID is "street,housenumber,housenumberaddition" and you want to tokenize this with the help of the separator, you could use, in this example, the comma between the values as the separator. This will lead to the following XPath expression.
59 +
60 +tokenize(AddressID,',')
61 +
62 +The given input detailed above will result in the following output: street housenumber housenumberaddition.
63 +
46 46  == 4. Assignment ==
47 47  
48 -Check whether the solution we discussed today can be found within your project.
66 +Check out which of the XPaths we have discussed today can be found within your project.
49 49  This assignment can be completed within the (Academy) project you created/used in the previous assignment.
50 50  
51 51  == 5. Key takeaways ==
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
71 +Some of the very complex XPath options are:
56 56  
73 +* matches
74 +* replace
75 +* tokenize
76 +
57 57  == 6. Suggested Additional Readings ==
58 58  
59 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
79 +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:
60 60  
81 +* http://www.xsltfunctions.com/xsl/fn_matches.html
82 +* http://www.xsltfunctions.com/xsl/fn_replace.html
83 +* http://www.xsltfunctions.com/xsl/fn_tokenize.html
84 +
61 61  == 7. Silent demonstration video ==
62 62  
63 63  As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}