Changes for page Groovy Script

Last modified by Erik Bakker on 2024/09/05 13:53

From 9.2 to 10.1 From 12.1 to 13.1

From version 10.1

edited by Erik Bakker
on 2022/07/26 13:17

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

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--expert-securing-data-traffic-api-gw-security-external-idp
++Groovy Script

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++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.
  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -9,54 +9,71 @@
  == 2. Key concepts ==
--This microlearning focuses on performing image transformations in eMagiz.
++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.
--By image transformation, we mean transforming the raw data that represents an image into another image format.
++* Groovy scripts should be viewed as an extension that can be used in fringe cases, not as a standard best practice
++* When a groovy script becomes so complex that you are programming, you should consider alternatives to the solution
++* Groovy scripts can be used in a filter, transformation, and as part of a standard executor
++* Groovy scripts should be well documented as they are though to read for most of our community members
++* There is no guarantee from eMagiz that Groovy scripts within models keep working in newer versions of the platform
--* Read the help text of the component to understand which formats are supported
--* Ensure the input image is supplied in the correct format
--* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
++== 3. Groovy script ==
--== 3. Image Transformation ==
++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.
--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).
++=== 3.1 Implementation in Create ===
--Before we dive into the specifics of how to configure this, let us first consider the following:
++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.
++
++* In case you want the Groovy script to filter out messages you should implement the Groovy script in a "standard filter" component.
++* 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.
++* 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.
++* When you want to split your message based on a Groovy script you should use the "standard splitter"
++* If you want to route messsages based on a Groovy script you should use the "standard router"
--* Read the help text of the component to understand which formats are supported
--* Ensure the input image is supplied in the correct format
--* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
++{{warning}}Note, that in practice we mainly see use cases for the "standard service activator" and the "standard transformation".{{/warning}}
--{{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}}
++[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-available-components.png]]
--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.
++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.
--[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]]
++[[image:Main.Images.Microlearning.WebHome@expert-data-handling-groovy-script-groovy-configuration.png]]
--After dragging the component onto the canvas, you must define the channels first.
++{{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}}
--[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-help.png]]
++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.
--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.
++=== 3.2 Key considerations ===
--[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-image-options.png]]
++* To make some groovy scripts work you need to upload (third-party) Java libraries that are not packaged on default by eMagiz
++* To make some groovy scripts work you need to reference Java libraries via a standard header enricher or as a dummy variable
++* The store consists of several groovy scripts that might be of use to you
++* Groovy scripts should be viewed as an extension that can be used in fringe cases, not as a standard best practice
++* When a groovy script becomes so complex that you are programming, you should consider alternatives to the solution
++* Groovy scripts can be used in a filter, transformation, and as part of a standard executor
++* Groovy scripts should be well documented as they are though to read for most of our community members
++* There is no guarantee from eMagiz that Groovy scripts within models keep working in newer versions of the platform
--Once you have done this, the component configuration is finished, and you can transform your input image to a desired output image format.
--
  == 4. Assignment ==
--Check whether the solution we discussed today can be found within your project.
--This assignment can be completed within the (Academy) project you created/used in the previous assignment.
++Try to implement a component that references a Groovy script and see whether the flow can be tested.
++This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* Read the help text of the component to understand which formats are supported
--* Ensure the input image is supplied in the correct format
--* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
++* To make some groovy scripts work you need to upload (third-party) Java libraries that are not packaged on default by eMagiz
++* To make some groovy scripts work you need to reference Java libraries via a standard header enricher or as a dummy variable
++* The store consists of several groovy scripts that might be of use to you
++* Groovy scripts should be viewed as an extension that can be used in fringe cases, not as a standard best practice
++* When a groovy script becomes so complex that you are programming, you should consider alternatives to the solution
++* Groovy scripts can be used in a filter, transformation, and as part of a standard executor
++* Groovy scripts should be well documented as they are though to read for most of our community members
++* There is no guarantee from eMagiz that Groovy scripts within models keep working in newer versions of the platform
  == 6. Suggested Additional Readings ==
--If you are interested in this topic and want more information, please read the help text provided by eMagiz.
++If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following link:
++* https://www.tutorialspoint.com/groovy/index.htm
  == 7. Silent demonstration video ==

Changes for page Groovy Script

Summary

Details

Navigation