Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:39
From version 44.1
edited by Erik Bakker
on 2022/12/30 12:09
Change comment: There is no comment for this version
To version 35.2
edited by Erik Bakker
on 2022/06/12 09:35
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Validate Incoming Messages
1 +novice-soap-webservice-connectivity-validate-incoming-messages
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
1 +WebHome
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,79 +1,107 @@
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 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.
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 -If you have any questions, don't hesitate to contact academy@emagiz.com.
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 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.
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 proper credentials (security) and the correct answers (validation) can enter and perform their actions. In the previous microlearning, we talked 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 -=== 3.1 Configuration on system message level in Design ===
46 +=== 3.1 URL ===
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 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.
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 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--root-entity-for-wsdl.png]]
50 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]]
39 39  
40 -=== 3.2 Effect in Create ===
52 +=== 3.2 Retry Advice ===
41 41  
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.
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.
43 43  
44 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
56 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.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}}
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
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".
60 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]
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}}
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)
51 51  
52 -With this done, you have successfully added validation to your SOAP web service.
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
53 53  
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]]
71 +
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 +
54 54  == 4. Assignment ==
55 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 you created/used in the previous assignment.
86 +Build a flow within your project in which you do a call to an external party that hosts a SOAP web service.
87 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
58 58  
59 59  == 5. Key takeaways ==
60 60  
61 -* Crucial parts in the configuration are:
62 - ** Operation Name
63 - ** SOAP Webservice Namespace
64 - ** validationvalidation
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
65 65   ** Authentication
66 -* Validation is done with the help of an XSD
67 -* The WSDL is used for external documentation
68 -* eMagiz will automatically generate the WSDL for you based on your system messages
69 -** Do not forget to add the correct root entity to your system message to make the WSDL work
70 70  
71 71  == 6. Suggested Additional Readings ==
72 72  
73 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
101 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
74 74  
75 75  == 7. Silent demonstration video ==
76 76  
77 -{{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"/}}
78 78  
79 79  )))((({{toc/}}))){{/container}}{{/container}}