Changes for page Validate Incoming Messages

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Validate Incoming Messages
	1	+novice-soap-webservice-connectivity-validate-incoming-messages

Default language

...	...	@@ -1,1 +1,0 @@
1		-en

Content

...	...	@@ -1,110 +1,100 @@
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 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.
	1	+{{container}}{{container layoutStyle="columns"}}(((
	2	+When talking to external parties via a SOAP web service you need to define in eMagiz that you want to call a SOAP web service so eMagiz will form a correct SOAP message. On top of the call there is a support object in eMagiz that will help you with the analysis of your problems when calling the SOAP web service. In this microlearning, we will learn how to call a SOAP web service from eMagiz.
3	3
4	4	Should you have any questions, please contact academy@emagiz.com.
5	5
	6	+* Last update: April 1st, 2022
	7	+* Required reading time: 5 minutes
	8	+
6	6	== 1. Prerequisites ==
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.
	13	+This microlearning centers around calling a SOAP Webservice.
11	11
12		-By configuring, we mean: Designing and determining the characteristics of the SOAP web service
	15	+With SOAP, we mean: A messaging protocol specification for exchanging structured information in the implementation of web services in computer networks.
13	13
14		-Crucial parts in the configuration are:
15		-* Operation Name
16		-* SOAP Webservice Namespace
17		-* Validation
	17	+* To call a REST Webservice you need either:
	18	+ ** A Web Service Outbound Gateway
	19	+* Critical information when configuring this component:
	20	+ ** URL
	21	+ ** Retry Advice
	22	+ ** Error Handling
	23	+ ** Authentication
	24	+
	25	+== 3. Calling a SOAP Webservice ==
	26	+
	27	+When talking to external parties via a SOAP web service you need to define in eMagiz that you want to call a SOAP web service so eMagiz will form a correct SOAP message. On top of the call there is a support object in eMagiz that will help you with the analysis of your problems when calling the SOAP web service. In this microlearning, we will learn how to call a SOAP web service from eMagiz.
	28	+
	29	+Calling a SOAP Webservice within eMagiz can be done with the help of a Web Service Outbound Gateway. To correctly configure this component you need to consider the following elements:
	30	+
	31	+* URL
	32	+* Retry Advice
	33	+* Error Handling
18	18	* Authentication
19	19
20		-Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
	36	+We will discuss the first three items in this list in this microlearning. In the microlearnings that will follow this microlearning, we will delve deeper into various authentication possibilities.
21	21
22		-== 3. Validate Incoming Messages ==
	38	+Before we delve into the configuration of the component let us first move to Create and open an exit flow in which we want to call the SOAP Webservice. When you open the exit flow it will look similar to this:
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 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.
	40	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]]
25	25
26		-Crucial parts in the configuration are:
27		-* Operation Name
28		-* SOAP Webservice Namespace
29		-* Validation
30		-* Authentication
	42	+Now that we have opened the flow and are in "Start Editing" mode we need to add the web service outbound gateway to start with.
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 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.
	44	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]]
33	33
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 all values (except for the ws and .wsdl part) with actual values.
	46	+=== 3.1 URL ===
35	35
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:
	48	+Now that we have added the correct component to the canvas it has become time to configure the component correctly. The first thing to configure when calling a SOAP Webservice is determining and registering the endpoint (URL) eMagiz should call to deliver the message too. As always in scenarios where an information element can change between environments, you should use a property reference and determine the correct value on a per-environment basis.
37	37
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/">
	50	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]]
43	43
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:
	52	+=== 3.2 Retry Advice ===
45	45
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>
	54	+The second setting we need to configure is the retry advice. With retry advice, you can guard your solution against temporary connection losses between eMagiz and the external party. As this can happen from time to time the best practice is to configure such a Retry Advice on every Web Service Outbound component. To add the Retry Advice move to the Advanced tab and move down to the Request handler advice chain segment. Within this segment, you will see a button called Retry Advice.
70	70
71		-To wrap things up you need to define your Request and Response element and close the schema:
	56	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]]
72	72
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>
	58	+When you click on the Retry Advice button you will be prompted with a pop-up. In here you need to configure the exact settings
84	84
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.
	60	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]
86	86
87		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]]
	62	+The best practice for this configuration is as follows for asynchronous solutions:
	63	+* Select the option called Simple Retry Policy
	64	+* Set the max attempts at 6
	65	+* Select the Fixed back off policy
	66	+* Set the backoff period at 5000 (ms)
88	88
89		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
	68	+When you have done so the configuration should look as follows. The only thing left is to press Save to save your Retry Advice configuration
90	90
91		-With this done you have successfully added validation to your SOAP web service.
	70	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-filled-in.png]]
92	92
	72	+=== 3.3 Error Handling ===
	73	+
	74	+When calling a SOAP Web service with the configuration we have defined up till here you could suffer from cryptic error response you get back when the SOAP web service call fails. To improve the error handling to make your life easier when analyzing the problem you need to add a support object to the canvas and link it to the web service outbound gateway. This support object is named "Detailed SOAP Fault Message Resolver".
	75	+
	76	+To link the support object to your web service outbound gateway you open the web service outbound gateway, navigate to the Advanced tab, and select the Fault message resolver. Afterward press Save to save the link between the components.
	77	+
	78	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-fault-message-resolver.png]]
	79	+
	80	+Now that we have configured the HTTP Outbound component to our liking we can press Save on the component level to store our changes. As a result the flow will look as follows:
	81	+
	82	+[[image:Main.Images.Microlearning.WebHome@microlearning/novice-soap-webservice-connectivity-calling-a-soap-webservice--flow-result.png]]
	83	+
93	93	== 4. Assignment ==
94	94
95		-Add validation to the SOAP Webservice we have been configuring.
	86	+Build a flow within your project in which you do a call to an external party that hosts a SOAP web service.
96	96	This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
97	97
98	98	== 5. Key takeaways ==
99	99
100		-* Crucial parts in the configuration are:
101		- ** Operation Name
102		- ** SOAP Webservice Namespace
103		- ** Validation
	91	+* eMagiz will create a valid SOAP message when using this component
	92	+* eMagiz provides a support object for better error handling of SOAP faults
	93	+* There are four key configuration elements:
	94	+ ** URL
	95	+ ** Retry Advice
	96	+ ** Error Handling
104	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
108	108
109	109	== 6. Suggested Additional Readings ==
110	110
...	...	@@ -112,6 +112,6 @@
112	112
113	113	== 7. Silent demonstration video ==
114	114
115		-{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
	105	+{{video attachment="novice-soap-webservice-connectivity-calling-a-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
116	116
117	117	)))((({{toc/}}))){{/container}}{{/container}}