Skip to Content
Last modified by Erik Bakker on 2024/09/05 14:00
From version 4.1
edited by Erik Bakker
on 2022/06/13 09:38
Change comment: There is no comment for this version
To version 12.1
edited by Erik Bakker
on 2022/07/28 09:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 - XPath Advanced
1 +Groovy Script
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,99 +1,80 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -Within the crash course, we already explained XPath conceptually. In that same microlearning, we also 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](crashcourse-platform-create-transformation-xpath-basic.md). In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [microlearning](intermediate-create-your-transformations-xpath-intermediate.md) if you need a refresher on that. In this microlearning, we will build upon that knowledge and look at some concrete, practical examples that could be useful in your project.
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 -* Last update: October 25th, 2021
7 -* Required reading time: 6 minutes
8 -
9 9  == 1. Prerequisites ==
10 10  
11 -* Advanced knowledge of the eMagiz platform
12 -* [[XPath Basic>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-transformation-xpath-basic.WebHome||target="blank"]]
13 -* [[XPath Intermediate>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Create your transformations.intermediate-create-your-transformations-xpath-intermediate.WebHome||target="blank"]][XPath Intermediate](intermediate-create-your-transformations-xpath-intermediate.md)
8 +* Expert knowledge of the eMagiz platform
14 14  
15 -crashcourse-platform-create-transformation-xpath-basic
16 -crashcourse-platform-create-transformation-XPath-basic
17 -
18 18  == 2. Key concepts ==
19 19  
20 -This microlearning focuses on more 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.
21 21  
22 -With XPath Advanced, we mean learning that XPath options are complex but could benefit you 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
23 23  
24 -Some of the more complex XPath options are:
20 +== 3. Groovy script ==
25 25  
26 -* dateTime calculation
27 -* Filter list
28 -* XPath on JSON
29 -* SpEL notation for XPath
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.
30 30  
24 +=== 3.1 Implementation in Create ===
31 31  
26 +To implement a groovy script in Create you first need to consider what your Groovy script should do. 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 +* In case you need an optional output the "standard service activator" is your friend. So for example, when you want to do some transformation and do a 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 messsages based on a Groovy script you should use the "standard router"
32 32  
33 -== 3. XPath Advanced ==
34 +{{warning}}Note, that in practice we mainly see use cases for the "standard service activator" and the "standard transformation".{{/warning}}
34 34  
35 -Within the crash course, we already explained XPath conceptually. In that same microlearning, we also 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](crashcourse-platform-create-transformation-xpath-basic.md). In the intermediate microlearning on this subject, we built upon that knowledge. Please check out this [microlearning](intermediate-create-your-transformations-xpath-intermediate.md) if you need a refresher on that. In this microlearning, we will build upon that knowledge and look at some concrete, practical examples that could be useful in your project.
36 +[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-available-components.png]]
36 36  
37 -Some of the more complex XPath options are:
38 +Regardless of the component you choose you always need to select the option called "Groovy script" and reference the Groovy resource available on flow level that you want to use within the component.
38 38  
39 -* dateTime calculation
40 -* Filter list
41 -* XPath on JSON
42 -* SpEL notation for XPath
40 +[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-groovy-configuration.png]]
43 43  
44 -=== 3.1 dateTime calculation ===
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}}
45 45  
46 -Sometimes we see that a dateTime calculation is needed within a transformation to determine a specific action. As these calculations are not natively supported within the eMagiz platform, you need to use XPath's functionality to calculate the new valid date (or dateTime).
44 +After you have the component in such a way that the correct Groovy script is called you are done with the configuration of the component and can test the flow using flow testing.
47 47  
48 -The XPath standard offers several functions to calculate with dateTime values. The two most used options are dayTimeDuration and yearMonthDuration. With the help of the dayTimeDuration, you can add, subtract, multiple, or divide seconds, minutes, hours, and days regarding the original value. The yearMonthDuration works similarly but then for months and years. An example of such an XPath is: <xsl:value-of xmlns:xs="http://www.w3.org/2001/XMLSchema" select="CDM:StartDate + xs:dayTimeDuration('P1D') * xs:yearMonthDuration('P1M')"/>. In this example, XPath adds one day and subtracts one month from the input date. Note that making this work requires the additional namespace to be defined. Therefore you need a custom snippet within your transformation or a custom transformation to make this work. Furthermore, note that the P1D and P1M could also be filled with the help of parameters to make them dynamic in nature.
46 +=== 3.2 Key considerations ===
49 49  
50 -Some examples that we saw during the years:
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
51 51  
52 -* https://my.emagiz.com/p/question/172825635700358186
53 -* https://my.emagiz.com/p/question/172825635700352588
54 -
55 -=== 3.2 Filter list ===
56 -
57 -Sometimes you have a large message which contains a certain list within it. However, logic dictates that you can only send the message if at least one entry in the list for which attribute A is filled and attribute B equals type C. To make that happen in XPath, we first need to navigate to the list within the message. As we previously learned, there are two options to do so. One is to use // to navigate to the entity somewhere in the tree directly. The other is to start at the root and walk the tree from there. In this example, we use the latter. That results in the following XPath example: /root/list[attributeB = 'type C']/attributeA !=''. With this XPath, you filter the list on the specified check and subsequently check whether one of those entries that remains has an attributeA which is filled in.
58 -
59 -=== 3.3 XPath on JSON ===
60 -
61 -With the release of build number .50, we expanded our offering on JSON messages to resemble much of the functionality we previously offered for XML messages. As a result, you can use XPath expressions on JSON messages within the following components (related to XPath):
62 -
63 -* XPath header enricher
64 -* XPath transformer
65 -* XPath router
66 -
67 -To activate the functionality, simply link the JSON source factory support object to one of these components to achieve the desired result. For more information, check out: https://emagiz.github.io/docs/release-notes/build50.
68 -
69 -=== 3.4 SpEL notation for XPath ===
70 -
71 -Sometimes you want to perform an XPath operation but store the header via a standard message header enricher component. As a result, you need a valid SpEL expression to help you in this cause. To do so, you need to know the correct notation for an XPath expression when using the SpEL language. An example of the correct notation is: #xpath(payload,'/root/entity/attribute')
72 -
73 -
74 -
75 75  == 4. Assignment ==
76 76  
77 -Check out which of the XPaths we have discussed today can be found within your project.
78 -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 that you have created/used in the previous assignment.
79 79  
80 80  == 5. Key takeaways ==
81 81  
82 -Some of the more 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
83 83  
84 -* dateTime calculation
85 -* Filter list
86 -* XPath on JSON
87 -* SpEL notation for XPath
88 -
89 -
90 -
91 91  == 6. Suggested Additional Readings ==
92 92  
93 -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 link:
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
94 94  
95 -* https://www.w3schools.com/xml/xpath_intro.asp
96 -
97 97  == 7. Silent demonstration video ==
98 98  
99 99  As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}