Changes for page Groovy Script

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-expert-data-handling-groovy-script
	1	+Groovy Script

Content

...	...	@@ -1,5 +1,5 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-In the crash course on the API Gateway we discussed the various options available to [[secure>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-security.WebHome||target="blank"]] your API Gateway properly. In this microlearning, we will expand our knowledge on that topic by looking at a special case of securing your API Gateway. That case is special as you use an external identity provider (IDP) to govern the roles and users that have rights on your API Gateway.
	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
...	...	@@ -9,50 +9,71 @@
9	9
10	10	== 2. Key concepts ==
11	11
12		-This microlearning focuses on using an external IDP to validate whether a user is authorized to execute a certain action on your API Gateway and what configuration is needed in eMagiz to make this work.
	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.
13	13
14		-* The Token and Issuer URL of the external IDP need to be known
15		-* Users and Roles under User Management need to be manually configured and maintained to keep them in sync with the external IDP
	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
16	16
17		-== 3. External IDP ==
	20	+== 3. Groovy script ==
18	18
19		-In the crash course on the API Gateway we discussed the various options available to [[secure>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-security.WebHome||target="blank"]] your API Gateway properly. In this microlearning, we will expand our knowledge on that topic by looking at a special case of securing your API Gateway. That case is special as you use an external identity provider (IDP) to govern the roles and users that have rights on your API Gateway.
	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.
20	20
21		-When selecting the option OAuth2.0 (or OpenID Connect) you have the option to use the IDP provided by eMagiz which makes the configuration easy or you could use an external IDP which you have control over and want to use for this purposes.
	24	+=== 3.1 Implementation in Create ===
22	22
23		-In this microlearning we will highlight what you need to configure in Design and Deploy to make this work within the tooling of eMagiz.
	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"
24	24
25		-=== 3.1 Design ===
	34	+{{warning}}Note, that in practice we mainly see use cases for the "standard service activator" and the "standard transformation".{{/warning}}
26	26
27		-On the security level of the API Gateway in Design you need to select the desired option, for example OAuth2.0. Instead of not filling in the token and issuer URL, indicating that you want to use the eMagiz IDP, you need to fill these in to reference the IDP of your choice. Below you see an example of how this could be configured.
	36	+[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-available-components.png]]
28	28
29		-[[image:Main.Images.Microlearning.WebHome@expert-securing-data-traffic-api-gw-security-external-idp-security-config-design.png]]
	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.
30	30
31		-Note that the environmentID in this example should be replaced with an actual environmentID that references your environment.
	40	+[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-groovy-configuration.png]]
32	32
33		-=== 3.2 Deploy ===
	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}}
34	34
35		-Normally, eMagiz will automatically update the User Management information based on the configuration in Design. However, because the identity check is not done by eMagiz but by an external party you need to manually enter the roles and users and configure the scope correctly on role level.
	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.
36	36
37		-To do so navigate to User Management in Deploy and add the users you want manually by pressing the New button and providing them with a name. Do subsequently the same for the roles. On role level do not forget to correctly enter the scope to make the call work. Note that the help text on the scope level gently reminds you what you need to do to make this work.
	46	+=== 3.2 Key considerations ===
38	38
39		-[[image:Main.Images.Microlearning.WebHome@expert-securing-data-traffic-api-gw-security-external-idp-scope-configuration.png]]
	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
40	40
41		-{{warning}}When implementing this you would be the first to do so with this setup. This means there might be some unexpected behavior when configuring this.{{/warning}}
42		-
43	43	== 4. Assignment ==
44	44
45		-No 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.
46	46
47	47	== 5. Key takeaways ==
48	48
49		-* The Token and Issuer URL of the external IDP need to be known
50		-* Users and Roles under User Management need to be manually configured and maintained to keep them in sync with the external IDP
51		-* When implementing this you would be the first to do so with this setup.
	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
52	52
53	53	== 6. Suggested Additional Readings ==
54	54
55		-If you are interested in this topic and want more information, please read the help text provided by eMagiz.
	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
56	56
57	57	== 7. Silent demonstration video ==
58	58