Skip to Content

Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26
From version 49.1
edited by Eva Torken
on 2023/06/27 11:57
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 -Endpoint Check
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.etorken
1 +XWiki.ebakker
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,69 +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 by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. One last check to perform before you can communicate with the external parties that the endpoint is available to receive messages and up and running. In this microlearning, we will learn how you can perform such a check.
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 the endpoint check.
13 +This microlearning centers around calling a SOAP Webservice.
11 11  
12 -By endpoint check, we mean: determine whether the WSDL is accessible on the correct endpoint so we can forward the URL to the WSDL + the URL to call to our external parties
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 -* The endpoint consists of the following elements:
15 - ** Starts with https:// or http://
16 - ** Second part is the host (i.e. where is the endpoint running)
17 - ** Third part is the port on which the incoming traffic is accepted
18 - ** These three things combined make up the first part of our endpoint that will vary per environment
19 - ** Following that we have a static remainder of the endpoint that is build up as follows: /{soap WS name}/{Id}/
20 - ** If you want to get to the WSDL simply add the name of the WSDL (which is defined by the Id given to the "Dynamic WSDL" support object) and the .wsdl extension to the endpoint when viewing it in the browser
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 ==
21 21  
22 -== 3. Endpoint Check ==
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.
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. One last check to perform before you can communicate with the external parties that the endpoint is available to receive messages and up and running. In this microlearning, we will learn how you can perform such a check.
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:
25 25  
26 -* The endpoint consists of the following elements:
27 - ** Starts with https:// or http://
28 - ** Second part is the host (i.e. where is the endpoint running)
29 - ** Third part is the port on which the incoming traffic is accepted
30 - ** These three things combined make up the first part of our endpoint that will vary per environment
31 - ** Following that we have a static remainder of the endpoint that is build up as follows: /{soap WS name}/{Id}/
32 - ** If you want to get to the WSDL simply add the name of the WSDL (which is defined by the Id given to the "Dynamic WSDL" support object) and the .wsdl extension to the endpoint when viewing it in the browser
31 +* URL
32 +* Retry Advice
33 +* Error Handling
34 +* Authentication
33 33  
34 -As you can see the endpoint can be divided into two parts. One part is dynamic across environments and one part is static across environments. Let us first determine how we can find out the first part of our endpoint.
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.
35 35  
36 -=== 3.1 HTTPS or HTTP ===
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:
37 37  
38 -We start at the top with the determination of HTTPS or HTTP. A simple rule of thumb is that when running in the eMagiz Cloud the endpoint starts with https:// and when the endpoint is running locally (i.e. on-premise) the endpoint starts with http:// (unless you secure it yourself, more on that later).
40 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]]
39 39  
40 -=== 3.2 Host ===
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.
41 41  
42 -The next part of the endpoint is the host. The host is effectively the (virtual) machine on which the endpoint is running. When hosting an endpoint in the eMagiz cloud the host part is the combination between the DNS left-most label on Route level and the cloudslot on which your environment is running. The first part of the equation can be found under Deploy -> Architecture. The second part can be found under Deploy -> Properties by looking for the {technicalnameproject}.amqp01.host. You need to combine the two elements via a dash -. An example of this would then be spwbsrv-test-cloud0001.emagizcloud.com. In case of an on-premise installation, you should ask your customer what the IP address or DNS name is to connect to the machine on which your runtime is running. If the runtime is running locally on your laptop the host equals localhost.
44 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]]
43 43  
44 -=== 3.3 Port and Path ===
46 +=== 3.1 URL ===
45 45  
46 -Whether or not the port needs to be defined to get to the endpoint is once again determined by the location. If the endpoint is hosted in the eMagiz Cloud the port is *not* part of the endpoint. However, when you host your endpoint locally the endpoint becomes part of your endpoint. Note that to make this piece work in the eMagiz Cloud you should set up your Route properly. More on that in our Cloud Management courses. You can determine the port, for the endpoint or the route, by navigating to the infra flow of the runtime through which you host your SOAP web service. In the infra flow you can also find the remainder of the path to get to the WSDL location.
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.
47 47  
48 -In the infra flow there is a support object of the type "Dynamic WSDL". In here you 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 {Id}.wsdl to the URI. In this example, when hosting the SOAP web service on-premise, a valid URI would be {{code}}http://localhost:8099/ws/soapgn3-connector/soapgn3-connector.wsdl{{/code}}.
50 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.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 {{code}}https://soap-test-cloud0000.emagizcloud.com/ws/soapgn3-connector/soapgn3-connector.wsdl{{/code}}{{/info}}
52 +=== 3.2 Retry Advice ===
51 51  
52 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
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.
53 53  
54 -== 4. Key takeaways ==
56 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]]
55 55  
56 -* The endpoint consists of the following elements:
57 - ** Starts with https:// or http://
58 - ** Second part is the host (i.e. where is the endpoint running)
59 - ** Third part is the port on which the incoming traffic is accepted
60 - ** These three things combined make up the first part of our endpoint that will vary per environment
61 - ** Following that we have a static remainder of the endpoint that is build up as follows: /{soap WS name}/{Id}/
62 - ** If you want to get to the WSDL simply add the name of the WSDL (which is defined by the Id given to the "Dynamic WSDL" support object) and the .wsdl extension to the endpoint when viewing it in the browser
63 -* The relevant information can be derived from the "Dynamic WSDL" support object and by determining where the endpoint is hosted
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
64 64  
65 -== 5. Suggested Additional Readings ==
60 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]
66 66  
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)
67 +
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
69 +
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 +
84 +== 4. Assignment ==
85 +
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.
88 +
89 +== 5. Key takeaways ==
90 +
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
97 + ** Authentication
98 +
99 +== 6. Suggested Additional Readings ==
100 +
67 67  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
68 68  
103 +== 7. Silent demonstration video ==
104 +
105 +{{video attachment="novice-soap-webservice-connectivity-calling-a-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
106 +
69 69  )))((({{toc/}}))){{/container}}{{/container}}