Changes for page Endpoint Check

Last modified by Erik Bakker on 2024/02/21 21:35

From 26.1 to 25.1 From 37.1 to 36.2

From version 36.2

edited by Erik Bakker
on 2022/06/12 09:36

Change comment: Update document after refactoring.

To version 26.1

edited by Erik Bakker
on 2022/06/10 13:05

Change comment: Deleted image "novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png"

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- novice-devops-perspectives-annotations--describe-parts-of-flow.png

Details

Page properties

Title

@@ -1,1 +1,1 @@
--novice-soap-webservice-connectivity-soap-headers
++Annotations

Content

@@ -1,120 +1,77 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++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.
--Should you have any questions, please contact academy@emagiz.com.
++Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
--* Last update: June 10th, 2021
--* Required reading time: 7 minutes
++* Last update: May 9th, 2021
++* Required reading time: 5 minutes
  == 1. Prerequisites ==
++
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
--This microlearning centers around configuring your SOAP web service.
--By configuring, we mean: Designing and determining the characteristics of the SOAP web service
++This microlearning centers around using annotations.
++With annotations, we mean: A piece of text to explain something to yourself and others
--Crucial parts in the configuration are:
--* Operation Name
--* SOAP Webservice Namespace
--* Validation
--* Authentication
++Annotations can be used for:
--Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
--
--== 3. Validate Incoming Messages ==
++* Describing a best practice everyone should follow
++* Describing (more complex) parts of the flow
++* Describe (parts of) your message definitions
--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. Annotations ==
--Crucial parts in the configuration are:
--* Operation Name
--* SOAP Webservice Namespace
--* Validation
--* Authentication
++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.
--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.
++Annotations can be used for:
--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 all values (except for the ws and .wsdl part) with actual values.
++* Describing a best practice everyone should follow
++* Describing (more complex) parts of the flow
++* Describe (parts of) your message definitions
--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:
++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:
--<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
--<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
--    xmlns="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/"
--    attributeFormDefault="unqualified" elementFormDefault="unqualified"
--    targetNamespace="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/">
++[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
--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:
++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:
--<xs:complexType name="Input">
--        <xs:sequence>
--            <xs:element name="String" type="nonEmptyString"/>
--            <xs:element minOccurs="0" name="Decimal" type="xs:decimal"/>
--            <xs:element name="Enum" type="Enum"/>
--            <xs:element name="Integer" type="xs:long"/>
--            <xs:element name="Boolean" type="xs:boolean"/>
--            <xs:element minOccurs="0" name="DateTime" type="xs:dateTime"/>
--        </xs:sequence>
--    </xs:complexType>
--    <xs:simpleType name="nonEmptyString">
--        <xs:restriction base="xs:string">
--            <xs:minLength value="1"/>
--        </xs:restriction>
--    </xs:simpleType>
--    <xs:simpleType name="Enum">
--        <xs:restriction base="xs:string">
--            <xs:enumeration value="URGENT"/>
--            <xs:enumeration value="HIGH"/>
--            <xs:enumeration value="MEDIUM"/>
--            <xs:enumeration value="LOW"/>
--            <xs:enumeration value="PLANNING"/>
--        </xs:restriction>
--    </xs:simpleType>
++[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
--To wrap things up you need to define your Request and Response element and close the schema:
++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:
--<xs:element name="SendNptRequest">
--        <xs:complexType>
--            <xs:sequence>
--                <xs:element name="Input" type="Input"/>
--            </xs:sequence>
--        </xs:complexType>
--    </xs:element>
--    <xs:element name="SendNptResponse">
--        <xs:complexType/>
--    </xs:element>
--    </xs:schema>
++[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
--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.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
++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.
--With this done you have successfully added validation to your SOAP web service.
++Now you know what annotations are good for and how you can add them within the eMagiz platform.
  == 4. Assignment ==
--Add validation to the SOAP Webservice we have been configuring.
++Add annotation on the flow level that describes how (a part of) a flow works.
  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* Crucial parts in the configuration are:
--    ** Operation Name
--    ** SOAP Webservice Namespace
--    ** Validation
--    ** Authentication
--* Validation is done with the help of an XSD
--* The WSDL is used for external documentation
--* Use the XSD generated by eMagiz based on the system message as a starting point
++* Annotations can be used for:
++  * Describing a best practice everyone should follow
++  * Describing (more complex) parts of the flow
++  * Describe (parts of) your message definitions
++* You can add annotations by dragging and dropping the annotation icon on the canvas.
  == 6. Suggested Additional Readings ==
--If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
++There are no suggested additional readings on this topic
  == 7. Silent demonstration video ==
--{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
++{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++
  )))((({{toc/}}))){{/container}}{{/container}}

novice-devops-perspectives-annotations--describe-parts-of-flow.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.ebakker

Size

...	...	@@ -1,0 +1,1 @@
	1	+18.9 KB

Content

Changes for page Endpoint Check

Summary

Details

Navigation