Skip to Content
Last modified by Eva Torken on 2024/02/21 21:34
From version 22.2
edited by Erik Bakker
on 2022/06/10 13:05
Change comment: Update document after refactoring.
To version 39.1
edited by Erik Bakker
on 2022/08/22 15:37
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
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,85 +1,117 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -= Annotations =
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 by hosting 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.
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 +Should you have any questions, please 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 by hosting 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 rights credentials (security) and the right answers (validation) are allowed to enter and perform their actions. In the next microlearning, we will talk about the security part. In this microlearning, we talk about the validation part.
31 31  
32 -Annotations can be used for:
34 +As you have learned from the crash course you can validate an XML message with the help of an XSD. This XSD describes dataTypes, order, associations, and length of attributes. You can use such an XSD for the validation of what your clients send you. eMagiz will automatically define a WSDL based on the XSD that you provide that stores metainformation and stores the XSD for validation purposes. This way you can communicate the WSDL (location) to external parties as a reference document upon which they can build their solution. If you keep the eMagiz defaults you can access the WSDL via "http://host:port/ws/ws-name/ws-name.wsdl". Note that you need to replace all values (except for the ws and .wsdl part) with actual values.
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 +What eMagiz does need from you is the correct XSD for validation. As a starting point you should download the XSD that eMagiz has generated based on the system message(s) you have defined in the Design phase. Once you have that you can structure the XSD correctly. A valid XSD start with a schema segment. In this segment you need to define your SOAP WS namespace:
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 +<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
39 +<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
40 + xmlns="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/"
41 + attributeFormDefault="unqualified" elementFormDefault="unqualified"
42 + targetNamespace="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/">
39 39  
40 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
44 +Once you have that you need to copy all complex and simple types from the XSD that you downloaded and paste them below the lines you have created:
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:
46 +<xs:complexType name="Input">
47 + <xs:sequence>
48 + <xs:element name="String" type="nonEmptyString"/>
49 + <xs:element minOccurs="0" name="Decimal" type="xs:decimal"/>
50 + <xs:element name="Enum" type="Enum"/>
51 + <xs:element name="Integer" type="xs:long"/>
52 + <xs:element name="Boolean" type="xs:boolean"/>
53 + <xs:element minOccurs="0" name="DateTime" type="xs:dateTime"/>
54 + </xs:sequence>
55 + </xs:complexType>
56 + <xs:simpleType name="nonEmptyString">
57 + <xs:restriction base="xs:string">
58 + <xs:minLength value="1"/>
59 + </xs:restriction>
60 + </xs:simpleType>
61 + <xs:simpleType name="Enum">
62 + <xs:restriction base="xs:string">
63 + <xs:enumeration value="URGENT"/>
64 + <xs:enumeration value="HIGH"/>
65 + <xs:enumeration value="MEDIUM"/>
66 + <xs:enumeration value="LOW"/>
67 + <xs:enumeration value="PLANNING"/>
68 + </xs:restriction>
69 + </xs:simpleType>
43 43  
44 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
71 +To wrap things up you need to define your Request and Response element and close the schema:
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:
73 +<xs:element name="SendNptRequest">
74 + <xs:complexType>
75 + <xs:sequence>
76 + <xs:element name="Input" type="Input"/>
77 + </xs:sequence>
78 + </xs:complexType>
79 + </xs:element>
80 + <xs:element name="SendNptResponse">
81 + <xs:complexType/>
82 + </xs:element>
83 + </xs:schema>
47 47  
48 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
85 +Combining this will result in a valid XSD for my example. In your case, you will need to enter other values. When you are done with the creation of the XSD save it with a name such as spwbsrv-connector.xsd and upload it to the flow. After you have uploaded the XSD link it to the connector-xsd support object in your entry.
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.
87 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]]
51 51  
52 -[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
89 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
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.
91 +With this done you have successfully added validation to your SOAP web service.
55 55  
56 -Now you know what annotations are good for and how you can add them within the eMagiz platform.
57 -
58 -
59 -
60 60  == 4. Assignment ==
61 61  
62 -Add annotation on the flow level that describes how (a part of) a flow works.
95 +Add validation to the SOAP Webservice we have been configuring.
63 63  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
64 64  
65 65  == 5. Key takeaways ==
66 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.
100 +* Crucial parts in the configuration are:
101 + ** Operation Name
102 + ** SOAP Webservice Namespace
103 + ** Validation
104 + ** Authentication
105 +* Validation is done with the help of an XSD
106 +* The WSDL is used for external documentation
107 +* Use the XSD generated by eMagiz based on the system message as a starting point
72 72  
73 -
74 -
75 75  == 6. Suggested Additional Readings ==
76 76  
77 -There are no suggested additional readings on this topic
111 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
78 78  
79 79  == 7. Silent demonstration video ==
80 80  
81 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
115 +{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
82 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