Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:39
From version 43.1
edited by Erik Bakker
on 2022/12/30 12:06
Change comment: There is no comment for this version
To version 50.1
edited by Carlijn Kokkeler
on 2024/08/21 16:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.CarlijnKokkeler
Content
... ... @@ -1,7 +1,7 @@
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 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.
3 3  
4 -Should you have any questions, please contact academy@emagiz.com.
4 +If you have any questions, don't hesitate to contact academy@emagiz.com.
5 5  
6 6  == 1. Prerequisites ==
7 7  * Basic knowledge of the eMagiz platform
... ... @@ -9,7 +9,7 @@
9 9  == 2. Key concepts ==
10 10  This microlearning centers around configuring your SOAP web service.
11 11  
12 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service
12 +By configuring, we mean: Designing and determining the characteristics of the SOAP web service.
13 13  
14 14  Crucial parts in the configuration are:
15 15  * Operation Name
... ... @@ -21,7 +21,7 @@
21 21  
22 22  == 3. Validate Incoming Messages ==
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.
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.
25 25  
26 26  Crucial parts in the configuration are:
27 27  * Operation Name
... ... @@ -29,35 +29,26 @@
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 previous microlearning, we talked about the security part. In this microlearning, we talk about the validation part.
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.
33 33  
34 34  === 3.1 Configuration on system message level in Design ===
35 35  
36 -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 combination of system message that 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.
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.
37 37  
38 38  [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--root-entity-for-wsdl.png]]
39 39  
40 40  === 3.2 Effect in Create ===
41 41  
42 -In the infra flow eMagiz automatically adds a support object of the type "Dynamic WSDL". In this support object the link is made between the system message definitions and the WSDL that will be created on the basis of 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.
43 43  
44 44  [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
45 45  
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}}
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}}
47 47  
48 -In this same support object you also see the default location of the hosted SOAP endpoint, which is http://localhost:${entry.connector.ws.port}/ws/{soap WS name}/. Based on this you can find the WSDL by adding {soap WS name}.wsdl to the URI. In this example, when hosting the SOAP web service on-premise, a valid URI would be "http://localhost:8099/ws/soapgn3-connector/soapgn3-connector.wsdl".
48 +With this done, you have successfully added validation to your SOAP web service.
49 49  
50 -{{info}}Note that when running your web service in the eMagiz cloud the first part (the host part) will change depending on your configuration in Deploy Architecture and the cloud slot on which you are running. An example URI in that case would be "https://soap-test-cloud0000.emagizcloud.com/ws/soapgn3-connector/soapgn3-connector.wsdl"{{/info}}
50 +== 4. Key takeaways ==
51 51  
52 -With this done you have successfully added validation to your SOAP web service.
53 -
54 -== 4. Assignment ==
55 -
56 -Add validation to the SOAP Webservice we have been configuring.
57 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
58 -
59 -== 5. Key takeaways ==
60 -
61 61  * Crucial parts in the configuration are:
62 62   ** Operation Name
63 63   ** SOAP Webservice Namespace
... ... @@ -68,12 +68,19 @@
68 68  * eMagiz will automatically generate the WSDL for you based on your system messages
69 69  ** Do not forget to add the correct root entity to your system message to make the WSDL work
70 70  
71 -== 6. Suggested Additional Readings ==
62 +== 5. Suggested Additional Readings ==
72 72  
73 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
64 +* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
65 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
66 +*** [[Configure your SOAP web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-configure-your-soap-webservice-gen3.WebHome||target="blank"]]
67 +*** [[Securing your SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-securing-your-soap-webservice.WebHome||target="blank"]]
68 +*** [[Endpoint Check (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-endpoint-check-gen3.WebHome||target="blank"]]
69 +*** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]]
70 +*** [[Calling a SOAP Web service (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-calling-a-soap-webservice||target="blank"]]
71 +*** [[Authorization - Calling a SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-authorization-calling-a-soap-webservice||target="blank"]]
72 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
73 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
74 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
75 +** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
74 74  
75 -== 7. Silent demonstration video ==
76 -
77 -{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
78 -
79 79  )))((({{toc/}}))){{/container}}{{/container}}