Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:39
From version 48.1
edited by Eva Torken
on 2023/06/27 11:02
Change comment: There is no comment for this version
To version 27.2
edited by Erik Bakker
on 2022/06/10 13:08
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Validate Incoming Messages
1 +novice-file-based-connectivity-header-line
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.etorken
1 +XWiki.ebakker
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,75 +1,77 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -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.
2 +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.
3 3  
4 -If you have any questions, don't hesitate to contact academy@emagiz.com.
4 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 +* Last update: May 9th, 2021
7 +* Required reading time: 5 minutes
8 +
6 6  == 1. Prerequisites ==
10 +
7 7  * Basic knowledge of the eMagiz platform
8 8  
9 9  == 2. Key concepts ==
10 -This microlearning centers around configuring your SOAP web service.
11 11  
12 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service.
15 +This microlearning centers around using annotations.
16 +With annotations, we mean: A piece of text to explain something to yourself and others
13 13  
14 -Crucial parts in the configuration are:
15 -* Operation Name
16 -* SOAP Webservice Namespace
17 -* Validation
18 -* Authentication
18 +Annotations can be used for:
19 19  
20 -Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
20 +* Describing a best practice everyone should follow
21 +* Describing (more complex) parts of the flow
22 +* Describe (parts of) your message definitions
21 21  
22 -== 3. Validate Incoming Messages ==
24 +== 3. Annotations ==
23 23  
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.
26 +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.
25 25  
26 -Crucial parts in the configuration are:
27 -* Operation Name
28 -* SOAP Webservice Namespace
29 -* Validation
30 -* Authentication
28 +Annotations can be used for:
31 31  
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.
30 +* Describing a best practice everyone should follow
31 +* Describing (more complex) parts of the flow
32 +* Describe (parts of) your message definitions
33 33  
34 -=== 3.1 Configuration on system message level in Design ===
34 +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:
35 35  
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.
36 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--root-entity-for-wsdl.png]]
38 +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:
39 39  
40 -=== 3.2 Effect in Create ===
40 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
41 41  
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.
42 +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:
43 43  
44 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
45 45  
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}}
46 +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.
47 47  
48 -With this done, you have successfully added validation to your SOAP web service.
48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
49 49  
50 +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.
51 +
52 +Now you know what annotations are good for and how you can add them within the eMagiz platform.
53 +
50 50  == 4. Assignment ==
51 51  
52 -Add validation to the SOAP Webservice we have been configuring.
53 -This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
56 +Add annotation on the flow level that describes how (a part of) a flow works.
57 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
54 54  
55 55  == 5. Key takeaways ==
56 56  
57 -* Crucial parts in the configuration are:
58 - ** Operation Name
59 - ** SOAP Webservice Namespace
60 - ** Validation
61 - ** Authentication
62 -* Validation is done with the help of an XSD
63 -* The WSDL is used for external documentation
64 -* eMagiz will automatically generate the WSDL for you based on your system messages
65 -** Do not forget to add the correct root entity to your system message to make the WSDL work
61 +* Annotations can be used for:
62 + * Describing a best practice everyone should follow
63 + * Describing (more complex) parts of the flow
64 + * Describe (parts of) your message definitions
65 +* You can add annotations by dragging and dropping the annotation icon on the canvas.
66 66  
67 67  == 6. Suggested Additional Readings ==
68 68  
69 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
69 +There are no suggested additional readings on this topic
70 70  
71 71  == 7. Silent demonstration video ==
72 72  
73 -{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages-gen3.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
73 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
74 74  
75 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
76 +
75 75  )))((({{toc/}}))){{/container}}{{/container}}