Changes for page Validate Incoming Messages
Last modified by Erik Bakker on 2024/08/26 12:39
From version 20.1
edited by eMagiz
on 2022/05/22 21:30
on 2022/05/22 21:30
Change comment:
There is no comment for this version
To version 49.1
edited by Eva Torken
on 2023/06/27 11:16
on 2023/06/27 11:16
Change comment:
There is no comment for this version
Summary
-
Page properties (5 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 4 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Validate Incoming Messages - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. marijn1 +XWiki.etorken - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,97 +1,66 @@ 1 -{{html wiki="true"}} 2 -<div class="ez-academy"> 3 - <div class="ez-academy_body"> 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. 4 4 5 - <divclass="doc">4 +If you have any questions, don't hesitate to contact academy@emagiz.com. 6 6 7 - 8 - 9 -= Annotations = 10 - 11 -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. 12 - 13 -Should you have any questions, please contact academy@emagiz.com. 14 - 15 -* Last update: May 9th, 2021 16 -* Required reading time: 5 minutes 17 - 18 18 == 1. Prerequisites == 19 - 20 20 * Basic knowledge of the eMagiz platform 21 21 22 22 == 2. Key concepts == 10 +This microlearning centers around configuring your SOAP web service. 23 23 24 -This microlearning centers around using annotations. 25 -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. 26 26 27 -Annotations can be used for: 14 +Crucial parts in the configuration are: 15 +* Operation Name 16 +* SOAP Webservice Namespace 17 +* Validation 18 +* Authentication 28 28 29 -* Describing a best practice everyone should follow 30 -* Describing (more complex) parts of the flow 31 -* 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. 32 32 22 +== 3. Validate Incoming Messages == 33 33 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. 34 34 35 -== 3. Annotations == 26 +Crucial parts in the configuration are: 27 +* Operation Name 28 +* SOAP Webservice Namespace 29 +* Validation 30 +* Authentication 36 36 37 - Inthismicrolearning, we willfocusonusingannotationsontheflow levelclarifyourthoughtprocess.In theannotation,you eitherdescribea bestpracticeeveryoneshouldfollowwhentheychange that flow(i.e. within theasynchronousouting)or describehowthe(more complex) partsoftheflowwork.Thiswill help yourselfandotherseverytime 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. 38 38 39 - Annotationscanbeusedfor:34 +=== 3.1 Configuration on system message level in Design === 40 40 41 -* Describing a best practice everyone should follow 42 -* Describing (more complex) parts of the flow 43 -* 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. 44 44 45 - To clarify the use cases let us take a look at how annotations can be added within the eMagiz platform.n our first example, we will takea look at asynchronous routing.In many eMagiz projects, a best practice is followed on how toadd something to the asynchronous routing(or changesomething within theasynchronous routing). Becausethebest practicetains multiplestepsit makes sense to use the annotation functionality ofeMagiz todefineall thesestepsand registerhem at the place youneedthem (i.e.the asynchronousrouting). Having done sowill result insomethinglike this:38 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--root-entity-for-wsdl.png]] 46 46 47 - <p align="center">[[image:novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png||]]</p>40 +=== 3.2 Effect in Create === 48 48 49 - Thesecond exampleisaboutusing annotations on the flowleveltodescribepartsof theflow. In thisexample,we will usetheannotationtodescribehatweusea filterto determinewhichmessagesare pickedupfrom a local directoryand how wefilter.That way anyway opening the flowhas to merelyreadthe annotation to get the context. Havingdonesowill result insomething 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. 50 50 51 - <p align="center">[[image:novice-devops-perspectives-annotations--describe-parts-of-flow.png||]]</p>44 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]] 52 52 53 - The third exampledoesnottakeplace ontheflow level butthe messagedefinition level.Thereforeinstead ofgoing to Create, we go to Design.In Designwhen you navigateto the CDM, API GatewayData model, EventStreaming Data model,messagedefinitions,etc.youhave the option to add annotationstothecanvas. Inthisexample,wewanttomakeclearto all that makechangesthat a certainpartof ourCDMis used by a lot of integrationswithineMagiz andthereforeeveryone shouldbecarefuland think twicebeforeadjusting anything related to thatpart. Havingdoneso willresult insomethinglike 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}} 54 54 55 - <p align="center">[[image:novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png||]]</p>48 +With this done, you have successfully added validation to your SOAP web service. 56 56 57 - Nowthat 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 theannotation is simple. You drag the annotation icon from the left context menu onto the canvas. As a result, an emptyannotation will be shown on the canvas. By double-clicking on it you can typewhatever youwant. Note thatyou need to be in "Start Editing" mode to change anything, including annotations.50 +== 4. Key takeaways == 58 58 59 -<p align="center">[[image:novice-devops-perspectives-annotations--annotation-icon-context-menu.png||]]</p> 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 60 60 61 - Whenyouareatisfiedwith what you have written down you can press the Save button.After you havedone so you can rescale the annotationto ensure that the complete textis visible. Tolink theannotation to a component (on flowlevel) oran entity (on messagedefinition level) you hover over the annotation until your mouse indicator changesto a + icon, execute a right-click and drag from the annotation to the component in question.62 +== 5. Suggested Additional Readings == 62 62 63 - Nowyouknow whatannotationsare goodforandhowyoucan addthemwithinthe eMagizplatform.64 +If you are interested in this topic and want more information, please read the help text provided by eMagiz. 64 64 65 -===== Practice ===== 66 - 67 -== 4. Assignment == 68 - 69 -Add annotation on the flow level that describes how (a part of) a flow works. 70 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 71 - 72 -== 5. Key takeaways == 73 - 74 -* Annotations can be used for: 75 - * Describing a best practice everyone should follow 76 - * Describing (more complex) parts of the flow 77 - * Describe (parts of) your message definitions 78 -* You can add annotations by dragging and dropping the annotation icon on the canvas. 79 - 80 - 81 - 82 -== 6. Suggested Additional Readings == 83 - 84 -There are no suggested additional readings on this topic 85 - 86 -== 7. Silent demonstration video == 87 - 88 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 89 - 90 -<iframe width="1280" height="720" src="../../vid/microlearning/novice-devops-perspectives-annotations.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> 91 - 92 -</div> 93 - 94 -</div> 95 -</div> 96 - 97 -{{/html}} 66 +)))((({{toc/}}))){{/container}}{{/container}}
- novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.marijn - 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.marijn - 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.marijn - 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.marijn - Size
-
... ... @@ -1,1 +1,0 @@ 1 -18.9 KB - Content