Changes for page Validate Incoming Messages

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Validate Incoming Messages
	1	+novice-soap-webservice-connectivity-calling-a-soap-webservice

Author

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

Default language

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

Content

...	...	@@ -1,8 +1,11 @@
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 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.
	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 learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service.
3	3
4	4	Should you have any questions, please contact academy@emagiz.com.
5	5
	6	+* Last update: June 10th, 2021
	7	+* Required reading time: 7 minutes
	8	+
6	6	== 1. Prerequisites ==
7	7	* Basic knowledge of the eMagiz platform
8	8
...	...	@@ -17,12 +17,12 @@
17	17	* Validation
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.
	23	+Of these four points, the last two will be discussed in separate microlearnings.
	24	+
	25	+== 3. Configure your SOAP Webservice ==
21	21
22		-== 3. Validate Incoming Messages ==
	27	+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 learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service.
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.
25		-
26	26	Crucial parts in the configuration are:
27	27	* Operation Name
28	28	* SOAP Webservice Namespace
...	...	@@ -29,86 +29,68 @@
29	29	* Validation
30	30	* Authentication
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.
	35	+Of these four points, the last two will be discussed in separate microlearnings. In this microlearning, we will focus on the first two aspects of the configuration. As you might have noticed I did not mention the fact whether the integration is synchronous or asynchronous as a crucial part of the configuration. The reason being that when configuring a (SOAP) web service you always need to send an acknowledgment back to the client calling the web service to let them know what the status of the message is. In case you want to set up the rest of your integration asynchronously you can send an empty message back as acknowledgment. In case you want to set up the rest of your integration synchronously you need to send the response you have received from the backend operation back to the client. More on the choice between asynchronous and synchronous in a later stage.
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:~//localhost: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.
	37	+=== 3.1 Operation Name ===
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:
	39	+Let us first zoom in on the parts of the configuration before we learn how you can implement it in eMagiz. Starting with the operation name. When you have dealt with the API Gateway offering of eMagiz in the past or have some knowledge of how APIs work the notion of an operation name should not be unfamiliar. In essence, it is a unique name that defines a certain operation. In eMagiz the best practice for naming the operation is as follows:
37	37
38		-{{code language="xml"}}
39		-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
40		-<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
41		- xmlns="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/"
42		- attributeFormDefault="unqualified" elementFormDefault="unqualified"
43		- targetNamespace="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/">
44		-{{/code}}
	41	+* Send{technicalnameoftheoperation}
45	45
46		-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:
	43	+When you are in Create you will notice that eMagiz uses the default suffix of Request and Response is added to the operation name. Therefore the full operation name a client needs to call to get the desired result if you adhere to the best practice is:
47	47
48		-{{code language="xml"}}
49		-<xs:complexType name="Input">
50		- <xs:sequence>
51		- <xs:element name="String" type="nonEmptyString"/>
52		- <xs:element minOccurs="0" name="Decimal" type="xs:decimal"/>
53		- <xs:element name="Enum" type="Enum"/>
54		- <xs:element name="Integer" type="xs:long"/>
55		- <xs:element name="Boolean" type="xs:boolean"/>
56		- <xs:element minOccurs="0" name="DateTime" type="xs:dateTime"/>
57		- </xs:sequence>
58		- </xs:complexType>
59		- <xs:simpleType name="nonEmptyString">
60		- <xs:restriction base="xs:string">
61		- <xs:minLength value="1"/>
62		- </xs:restriction>
63		- </xs:simpleType>
64		- <xs:simpleType name="Enum">
65		- <xs:restriction base="xs:string">
66		- <xs:enumeration value="URGENT"/>
67		- <xs:enumeration value="HIGH"/>
68		- <xs:enumeration value="MEDIUM"/>
69		- <xs:enumeration value="LOW"/>
70		- <xs:enumeration value="PLANNING"/>
71		- </xs:restriction>
72		- </xs:simpleType>
73		-{{/code}}
	45	+* Send{technicalnameoftheoperation}Request
74	74
75		-To wrap things up you need to define your Request and Response element and close the schema:
	47	+=== 3.2 SOAP Webservice Namespace ===
76	76
77		-{{code language="xml"}}
78		-<xs:element name="SendNptRequest">
79		- <xs:complexType>
80		- <xs:sequence>
81		- <xs:element name="Input" type="Input"/>
82		- </xs:sequence>
83		- </xs:complexType>
84		- </xs:element>
85		- <xs:element name="SendNptResponse">
86		- <xs:complexType/>
87		- </xs:element>
88		- </xs:schema>
89		-{{/code}}
	49	+The second part of the configuration is the SOAP Webservice Namespace. When hosting a SOAP Webservice via the standard eMagiz tooling you need to define a namespace. To smoothen this process eMagiz automatically generates a namespace based on the configuration settings you choose in the Design phase of eMagiz.
90	90
91		-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.
	51	+=== 3.3 Configuration in eMagiz ===
92	92
93		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]]
	53	+Now that we know what configurations are required, we can see how we can implement this in eMagiz. In the Capture phase, nothing changes. You simply draw a system on the canvas including at least one line that goes from the system towards eMagiz. When you are done you move to the Design phase in eMagiz. In this phase, you need to correctly set up the operation name(s) and the SOAP Webservice Namespace.
94	94
95		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
	55	+The configuration in Design starts at the system level. At the system level, you need to define the technical name (or let eMagiz automatically fill it in for you) and select the checkbox called Combined Entry Connector. By selecting this checkbox you tell eMagiz that you want to host an endpoint for others to call.
96	96
97		-With this done you have successfully added validation to your SOAP web service.
	57	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]
98	98
99		-== 4. Key takeaways ==
	59	+As you can see, selecting this option opens up a new choice to make. In this case between SOAP Webservice and Custom.
100	100
	61	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]]
	62	+
	63	+In this case, we opt for the SOAP web service. After you have done so eMagiz will automatically define the SOAP Webservice Name and SOAP Webservice Namespace.
	64	+
	65	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]]
	66	+
	67	+With this, you are done with your configuration on the system level. Don't forget to update the status of your task. Now that we have configured the system it is time to configure the integration that is drawn from the system to eMagiz. We can do so by double-clicking on it (or by accessing the context menu and selecting the edit option). When you open the Edit page on the integration level you will notice that a new segment is added (compared to other integrations). This segment defines the settings on the system level we have just specified and defines the operation name.
	68	+
	69	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
	70	+
	71	+As you can see eMagiz has already prefilled the operation name for you based on the best practice at eMagiz. If you want to change you have the option to do so. Do note that for the sake of consistency it would be smart to use the same naming convention within a single project to avoid confusion.
	72	+
	73	+=== 3.4 Add integration to Create ===
	74	+
	75	+Now that we have finished the configuration in Design the last step of this microlearning is to add the integration to Create. You can simply do so by navigating to Create -> Add integrations and selecting the integration to move it to Create. After you have selected it press Save to add the integration to Create.
	76	+
	77	+== 4. Assignment ==
	78	+
	79	+Configure a SOAP web service that consists of at least one operation and add it to Create.
	80	+This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
	81	+
	82	+== 5. Key takeaways ==
	83	+
101	101	* Crucial parts in the configuration are:
102	102	** Operation Name
103	103	** SOAP Webservice Namespace
104	104	** Validation
105	105	** Authentication
106		-* Validation is done with the help of an XSD
107		-* The WSDL is used for external documentation
108		-* Use the XSD generated by eMagiz based on the system message as a starting point
	89	+* For ease, you can use the default naming convention of eMagiz
109	109
110		-== 5. Suggested Additional Readings ==
	91	+== 6. Suggested Additional Readings ==
111	111
112	112	If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
113	113
	95	+== 7. Silent demonstration video ==
	96	+
	97	+{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
	98	+
114	114	)))((({{toc/}}))){{/container}}{{/container}}