Skip to Content

Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26
From version 37.2
edited by Erik Bakker
on 2022/06/12 09:37
Change comment: Update document after refactoring.
To version 52.1
edited by Erik Bakker
on 2024/08/26 12:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-soap-webservice-connectivity-securing-your-soap-webservice
1 +Endpoint Check
Parent
... ... @@ -1,1 +1,1 @@
1 -WebHome
1 +Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,69 +1,81 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
2 +In this microlearning, we will discuss setting up a communication point for customers using eMagiz, hosting a SOAP Webservice, checking endpoint availability, and understanding the components of the endpoint URL.
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: 5 minutes
8 -
9 9  == 1. Prerequisites ==
10 10  * Basic knowledge of the eMagiz platform
11 11  
12 12  == 2. Key concepts ==
13 -This microlearning centers around SOAP Headers.
10 +This microlearning centers around the endpoint check.
14 14  
15 -By SOAP Headers, we mean: headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties
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
16 16  
17 -You can exchange data from:
18 -* SOAP Header to Message Header
19 -* Message Header to SOAP Header
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
20 20  
21 -In both cases ensure that the correct information is exchanged.
22 -
23 -== 3. SOAP Headers ==
22 +== 3. Endpoint Check ==
24 24  
25 -When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
24 +When setting up a point where your customers can talk to you, eMagiz offers various methods for creating such a point. One option is 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 is up and running. In this microlearning, we will learn how you can perform such a check.
26 26  
27 -You can exchange data from:
28 -* SOAP Header to Message Header
29 -* Message Header to SOAP Header
26 +* The endpoint consists of the following elements:
27 + ** Starts with https:// or http://
28 + ** The second part is the host (i.e., where the endpoint is running)
29 + ** The 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, which will vary per environment
31 + ** Following that, we have a static remainder of the endpoint that is built up as follows: /{soap WS name}/{Id}/
32 + ** If you want to get to the WSDL, 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
30 30  
31 -In both cases ensure that the correct information is exchanged.
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 to find the first part of our endpoint.
32 32  
33 -In a previous microlearning, we already discussed one aspect of this. As you probably recall from our microlearning on [Securing your SOAP Webservice](novice-soap-web service-connectivity-securing-your-soap-webservice.md) we needed to exchange data between the SOAP header that our client was sending and a message header on the message so we could check whether or not the client was authorized to call the operation.
36 +=== 3.1 HTTPS or HTTP ===
34 34  
35 -In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'.
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 running locally (i.e., on-premise), the endpoint starts with http:// (unless you secure it yourself; more on that later).
36 36  
37 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]]
40 +=== 3.2 Host ===
38 38  
39 -As you can see you can map from and to message headers with regards to the SOAP Headers. As we already discussed the first scenario in an earlier microlearning I will for now continue with the other scenario. This scenario is mainly needed when eMagiz calls a SOAP web service that is hosted by an external party. Since we would normally do this in an exit (gate/flow) let us open such an exit in eMagiz and enter "Start Editing" mode.
42 +The next part of the endpoint is the host. The host is the (virtual) machine on which the endpoint runs. When hosting an endpoint in the eMagiz cloud, the host part is the combination of the DNS left-most label on the Route level and the cloud slot 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 is spwbsrv-test-cloud0001.emagizcloud.com. In 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 runs locally on your laptop, the host equals localhost.
40 40  
41 -The first step we need to take is to ensure that the information that we need to send to the SOAP web service in question (in this a unique reference number) is available in a message header. This can be done by verifying in all steps that preceded before the message entered the exit whether or not this piece of information was already added to a message header. In this case, we assume that this is the case since we want to focus on the 'complex SOAP header mapper' component and its relation to the web services outbound gateway. To correctly exchange data from a message header to a SOAP header we need to define a valid SpEL expression. See the help text of the component for a suggestion of what a valid SpEL expression is. The key part in this is knowing how the external party wants to receive the header(s) and how you (or one of your colleagues) has named the message header. When you have those two information elements you can write the correct expression. The result should be something as follows:
44 +=== 3.3 Port and Path ===
42 42  
43 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]]
46 +The location determines whether or not the port needs to be defined to get to the endpoint. 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. Set up your route properly to make this piece work in the eMagiz Cloud. 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. You can also find the remainder of the path to the WSDL location in the "infra flow."
44 44  
45 -Once you are satisfied you can press Save and link the support object to the web service outbound gateway.
48 +The infra flow has a support object of the type "Dynamic WSDL". 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}}.
46 46  
47 -With this information, you can place SOAP Headers on message headers and vice versa every time you need it.
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}}
48 48  
49 -== 4. Assignment ==
52 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
50 50  
51 -Call an external web service and send along some SOAP Headers.
52 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
54 +== 4. Key takeaways ==
53 53  
54 -== 5. Key takeaways ==
56 +* The endpoint consists of the following elements:
57 + ** Starts with https:// or http://
58 + ** The second part is the host (i.e., where the endpoint is running)
59 + ** The 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, which will vary per environment
61 + ** Following that, we have a static remainder of the endpoint that is built up as follows: /{soap WS name}/{Id}/
62 + ** If you want to get to the WSDL, 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
55 55  
56 -* You can exchange data from:
57 - ** SOAP Header to Message Header
58 - ** Message Header to SOAP Header
59 -* You need the SOAP structure and the message header name to make it work
65 +== 5. Suggested Additional Readings ==
60 60  
61 -== 6. Suggested Additional Readings ==
67 +* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
68 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]]
69 +*** [[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"]]
70 +*** [[Securing your SOAP Webservice (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-securing-your-soap-webservice||target="blank"]]
71 +*** [[Validate Incoming Messages (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-validate-incoming-messages-gen3.WebHome||target="blank"]]
72 +*** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]]
73 +*** [[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"]]
74 +*** [[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"]]
75 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
76 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
77 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
78 +** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
79 +* [[Endpoint Check (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22endpoint+check%22||target="blank"]]
62 62  
63 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
64 -
65 -== 7. Silent demonstration video ==
66 -
67 -{{video attachment="novice-soap-webservice-connectivity-soap-headers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
68 -
69 69  )))((({{toc/}}))){{/container}}{{/container}}