Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:39
From version 22.2
edited by Erik Bakker
on 2022/06/10 13:05
Change comment: Update document after refactoring.
To version 52.1
edited by Carlijn Kokkeler
on 2024/08/23 14:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-devops-perspectives-annotations
1 +Validate Incoming Messages
Parent
... ... @@ -1,1 +1,1 @@
1 -WebHome
1 +Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.CarlijnKokkeler
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,85 +1,77 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -= Annotations =
2 +In this microlearning, we'll dive into configuring validation for your SOAP web service. We'll focus on how to ensure that incoming XML messages meet your specified criteria using XSD for validation. Proper validation helps guarantee that the messages your service handles are both accurate and well-formed. By the end of this session, you'll understand how to set up and manage validation effectively within your SOAP web service configuration.
3 3  
4 -In this microlearning, we will focus on using annotations to clarify your thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing), describe how the (more complex) parts of the flow work or describe (parts of) of your message definitions (i.e. CDM, API Gateway Data model, system message, etc.). This will help yourself and others every time changes are needed.
4 +If you have any questions, don't hesitate to contact academy@emagiz.com.
5 5  
6 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 -
8 -* Last update: May 9th, 2021
9 -* Required reading time: 5 minutes
10 -
11 11  == 1. Prerequisites ==
12 -
13 13  * Basic knowledge of the eMagiz platform
14 14  
15 15  == 2. Key concepts ==
10 +This microlearning centers around configuring your SOAP web service.
16 16  
17 -This microlearning centers around using annotations.
18 -With annotations, we mean: A piece of text to explain something to yourself and others
12 +By configuring, we mean: Designing and determining the characteristics of the SOAP web service.
19 19  
20 -Annotations can be used for:
14 +Crucial parts in the configuration are:
15 +* Operation Name
16 +* SOAP Webservice Namespace
17 +* Validation
18 +* Authentication
21 21  
22 -* Describing a best practice everyone should follow
23 -* Describing (more complex) parts of the flow
24 -* Describe (parts of) your message definitions
20 +Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
25 25  
22 +== 3. Validate Incoming Messages ==
26 26  
24 +When setting up a point at which your customers can talk to you, eMagiz offers various methods of creating such a point. One of those options is to host a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. In this microlearning, we will zoom in on the part that validation of the messages plays when offering such a SOAP web service.
27 27  
28 -== 3. Annotations ==
26 +Crucial parts in the configuration are:
27 +* Operation Name
28 +* SOAP Webservice Namespace
29 +* Validation
30 +* Authentication
29 29  
30 -In this microlearning, we will focus on using annotations on the flow level to clarify our thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing) or describe how the (more complex) parts of the flow work. This will help yourself and others every time changes are needed within the flow.
32 +Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning. The SOAP Webservice serves as a point of entry where people with the proper credentials (security) and the correct answers (validation) can enter and perform their actions. In the previous microlearning, we talked about the validation part. In this microlearning, we talk about the security part.
31 31  
32 -Annotations can be used for:
34 +=== 3.1 Configuration on system message level in Design ===
33 33  
34 -* Describing a best practice everyone should follow
35 -* Describing (more complex) parts of the flow
36 -* Describe (parts of) your message definitions
36 +As you have learned from the crash course, you can validate an XML message with the help of an XSD. This XSD describes data types, order, associations, and length of attributes. You can use such an XSD to validate what your clients send you. eMagiz will automatically define a WSDL based on the combination of system messages you provide for each operation you want to host. To ensure that the WSDL is created correctly, don't forget to add an entity called "Send{givenname}Request" to the (request) system message and an entity called "Send{givenname}Response" in case you have a response system message. An example of how this needs to be configured in Design is shown below.
37 37  
38 -To clarify the use cases let us take a look at how annotations can be added within the eMagiz platform. In our first example, we will take a look at asynchronous routing. In many eMagiz projects, a best practice is followed on how to add something to the asynchronous routing (or change something within the asynchronous routing). Because the best practice contains multiple steps it makes sense to use the annotation functionality of eMagiz to define all these steps and register them at the place you need them (i.e. the asynchronous routing). Having done so will result in something like this:
38 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--root-entity-for-wsdl.png]]
39 39  
40 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
40 +=== 3.2 Effect in Create ===
41 41  
42 -The second example is about using annotations on the flow level to describe parts of the flow. In this example, we will use the annotation to describe that we use a filter to determine which messages are picked up from a local directory and how we filter. That way anyway opening the flow has to merely read the annotation to get the context. Having done so will result in something like this:
42 +In the infra flow, eMagiz automatically adds a support object of the "Dynamic WSDL" type. In this support object, the link is made between the system message definitions and the WSDL that will be created based on this.
43 43  
44 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
44 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
45 45  
46 -The third example does not take place on the flow level but the message definition level. Therefore instead of going to Create, we go to Design. In Design when you navigate to the CDM, API Gateway Data model, Event Streaming Data model, message definitions, etc. you have the option to add annotations to the canvas. In this example, we want to make clear to all that make changes that a certain part of our CDM is used by a lot of integrations within eMagiz and therefore everyone should be careful and think twice before adjusting anything related to that part. Having done so will result in something like this:
46 +{{warning}}Note that when you make changes to the system message after the integration is already in Create, or when you add a new integration to Create, you need to create a new version of your infra flow to be able to deploy the changes to your WSDL.{{/warning}}
47 47  
48 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
48 +With this done, you have successfully added validation to your SOAP web service.
49 49  
50 -Now that we saw some examples let us turn our attention to the how. How can I add an annotation and how can I link it. Adding the annotation is simple. You drag the annotation icon from the left context menu onto the canvas. As a result, an empty annotation will be shown on the canvas. By double-clicking on it you can type whatever you want. Note that you need to be in "Start Editing" mode to change anything, including annotations.
50 +== 4. Key takeaways ==
51 51  
52 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
52 +* Crucial parts in the configuration are:
53 + ** Operation Name
54 + ** SOAP Webservice Namespace
55 + ** Validation
56 + ** Authentication
57 +* Validation is done with the help of an XSD
58 +* The WSDL is used for external documentation
59 +* eMagiz will automatically generate the WSDL for you based on your system messages
60 +** Do not forget to add the correct root entity to your system message to make the WSDL work
53 53  
54 -When you are satisfied with what you have written down you can press the Save button. After you have done so you can rescale the annotation to ensure that the complete text is visible. To link the annotation to a component (on flow level) or an entity (on message definition level) you hover over the annotation until your mouse indicator changes to a + icon, execute a right-click and drag from the annotation to the component in question.
62 +== 5. Suggested Additional Readings ==
55 55  
56 -Now you know what annotations are good for and how you can add them within the eMagiz platform.
64 +* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
65 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
66 +*** [[Configure your SOAP web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3.WebHome||target="blank"]]
67 +*** [[Securing your SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-securing-your-soap-webservice||target="blank"]]
68 +*** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]]
69 +*** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]]
70 +*** [[Calling a SOAP Web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-calling-a-soap-webservice||target="blank"]]
71 +*** [[Authorization - Calling a SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-authorization-calling-a-soap-webservice||target="blank"]]
72 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
73 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
74 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
75 +** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
57 57  
58 -
59 -
60 -== 4. Assignment ==
61 -
62 -Add annotation on the flow level that describes how (a part of) a flow works.
63 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
64 -
65 -== 5. Key takeaways ==
66 -
67 -* Annotations can be used for:
68 - * Describing a best practice everyone should follow
69 - * Describing (more complex) parts of the flow
70 - * Describe (parts of) your message definitions
71 -* You can add annotations by dragging and dropping the annotation icon on the canvas.
72 -
73 -
74 -
75 -== 6. Suggested Additional Readings ==
76 -
77 -There are no suggested additional readings on this topic
78 -
79 -== 7. Silent demonstration video ==
80 -
81 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
82 -
83 -{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
84 -
85 85  )))((({{toc/}}))){{/container}}{{/container}}
novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -25.7 KB
Content
novice-devops-perspectives-annotations--annotation-icon-context-menu.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -774 bytes
Content
novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -15.5 KB
Content
novice-devops-perspectives-annotations--describe-parts-of-flow.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -18.9 KB
Content