Skip to Content
Last modified by Erik Bakker on 2024/09/05 14:00
From version 7.1
edited by Erik Bakker
on 2022/07/26 09:05
Change comment: There is no comment for this version
To version 13.1
edited by Erik Bakker
on 2022/07/28 09:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -expert-create-your-transformations-xpath-expert
1 +Groovy Script
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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.
2 +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.
3 3  
4 4  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -6,82 +6,75 @@
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"]]
12 12  
13 -
14 14  == 2. Key concepts ==
15 15  
16 -This microlearning focuses on very complex XPath operations.
12 +This microlearning focuses on groovy scripts. A groovy script is a piece of code written in the groovy language that allows you to extend the platform's functionality beyond the mere use of the components supplied via the flow designer.
17 17  
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.
14 +* Groovy scripts should be viewed as an extension that can be used in fringe cases, not as a standard best practice
15 +* When a groovy script becomes so complex that you are programming, you should consider alternatives to the solution
16 +* Groovy scripts can be used in a filter, transformation, and as part of a standard executor
17 +* Groovy scripts should be well documented as they are though to read for most of our community members
18 +* There is no guarantee from eMagiz that Groovy scripts within models keep working in newer versions of the platform
19 19  
20 -Some of the very complex XPath options are:
20 +== 3. Groovy script ==
21 21  
22 -* matches
23 -* replace
24 -* tokenize
22 +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.
25 25  
26 -== 3. XPath Expert ==
24 +=== 3.1 Implementation in Create ===
27 27  
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.
26 +To implement a groovy script in Create, you first need to consider what your Groovy script should do. Then, within the flow designer, there are five components available that can handle a Groovy script.
27 +
28 +* In case you want the Groovy script to filter out messages, you should implement the Groovy script in a "standard filter" component.
29 +* If you want your Groovy script to always transform your message from a certain format into another format, you should consider using a "standard transformer" component.
30 +* The "standard service activator" is your friend if you need an optional output. So, for example, when you want to do some transformation and check whether a message can continue, you can use the "standard service activator" and have an optional output.
31 +* When you want to split your message based on a Groovy script, you should use the "standard splitter."
32 +* If you want to route messages based on a Groovy script, you should use the "standard router."
29 29  
30 -Some of the very complex XPath options are:
34 +{{warning}}Note that in practice, we mainly see use cases for the "standard service activator" and the "standard transformation." {{/warning}}
31 31  
32 -* matches
33 -* replace
34 -* tokenize
36 +[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-available-components.png]]
35 35  
36 -=== 3.1 matches ===
38 +Regardless of the component you choose, you always need to select the "Groovy script" option and reference the Groovy resource available on the flow level you want to use within the component.
37 37  
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.
40 +[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-groovy-configuration.png]]
39 39  
40 -matches(OrderID,'^\d{7}$')
42 +{{info}}As you can see in the help text when selecting the "resource" attribute, you need to make sure that the Groovy script is uploaded within the context of your flow.{{/info}}
41 41  
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.
44 +After you have the component in such a way that the correct Groovy script is called, you are done with the component's configuration and can test the flow using flow testing.
43 43  
44 -=== 3.2 replace ===
46 +=== 3.2 Key considerations ===
45 45  
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.
48 +* To make some groovy scripts work, you need to upload (third-party) Java libraries that are not packaged on default by eMagiz
49 +* To make some groovy scripts work, you need to reference Java libraries via a standard header enricher or as a dummy variable
50 +* The store consists of several groovy scripts that might be of use to you
51 +* Groovy scripts should be viewed as an extension that can be used in fringe cases, not as a standard best practice
52 +* When a groovy script becomes so complex that you are programming, you should consider alternatives to the solution
53 +* Groovy scripts can be used in a filter, transformation, and as part of a standard executor
54 +* Groovy scripts should be well documented as they are though to read for most of our community members
55 +* There is no guarantee from eMagiz that Groovy scripts within models keep working in newer versions of the platform
47 47  
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.
49 -
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 -
64 64  == 4. Assignment ==
65 65  
66 -Check out which of the XPaths we have discussed today can be found within your project.
67 -This assignment can be completed within the (Academy) project you created/used in the previous assignment.
59 +Try to implement a component that references a Groovy script and see whether the flow can be tested.
60 +This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
68 68  
69 69  == 5. Key takeaways ==
70 70  
71 -Some of the very complex XPath options are:
64 +* To make some groovy scripts work, you need to upload (third-party) Java libraries that are not packaged on default by eMagiz
65 +* To make some groovy scripts work, you need to reference Java libraries via a standard header enricher or as a dummy variable
66 +* The store consists of several groovy scripts that might be of use to you
67 +* Groovy scripts should be viewed as an extension that can be used in fringe cases, not as a standard best practice
68 +* When a groovy script becomes so complex that you are programming, you should consider alternatives to the solution
69 +* Groovy scripts can be used in a filter, transformation, and as part of a standard executor
70 +* Groovy scripts should be well documented as they are though to read for most of our community members
71 +* There is no guarantee from eMagiz that Groovy scripts within models keep working in newer versions of the platform
72 72  
73 -* matches
74 -* replace
75 -* tokenize
76 -
77 77  == 6. Suggested Additional Readings ==
78 78  
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:
75 +If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following link:
76 +* https://www.tutorialspoint.com/groovy/index.htm
80 80  
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 -
85 85  == 7. Silent demonstration video ==
86 86  
87 87  As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}