Skip to Content

Changes for page Endpoint Check

Last modified by Erik Bakker on 2024/02/21 21:35
From version 39.1
edited by Erik Bakker
on 2022/06/12 09:39
Change comment: There is no comment for this version
To version 46.1
edited by Eva Torken
on 2023/06/27 11:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.etorken
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -3,9 +3,6 @@
3 3  
4 4  Should you have any questions, please contact academy@emagiz.com.
5 5  
6 -* Last update: June 11th, 2021
7 -* Required reading time: 7 minutes
8 -
9 9  == 1. Prerequisites ==
10 10  * Basic knowledge of the eMagiz platform
11 11  
... ... @@ -21,10 +21,10 @@
21 21  * These three things combined make up the first part of our endpoint that will vary per environment
22 22  * Following that we have a static remainder of the endpoint that is build up as follows: /ws/{path-specific-servlet-mapping}/
23 23  * If you want to get to the WSDL simply add the name of the WSDL and the .wsdl extension to the endpoint when viewing it in the browser
24 -
21 +
25 25  == 3. Endpoint Check ==
26 26  
27 -hen 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.
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.
28 28  
29 29  The endpoint consists of the following elements:
30 30  * Starts with https:// or http://
... ... @@ -42,7 +42,7 @@
42 42  
43 43  === 3.2 Host ===
44 44  
45 -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.
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.
46 46  
47 47  === 3.3 Port ===
48 48  
... ... @@ -65,10 +65,10 @@
65 65  [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--path-specific-servlet-mapping.png]]
66 66  
67 67  Combining all of this, assuming we run in the eMagiz Cloud, will result in the following endpoint for our Test environment:
68 -* https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/
65 +* {{code}}https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/{{/code}}
69 69  
70 70  Combining all of this, assuming we run locally on our laptop, will result in the following endpoint for our Test environment:
71 -* http://localhost:9091/ws/spwbsrv-connector/
68 +* {{code}}http://localhost:9091/ws/spwbsrv-connector/{{/code}}
72 72  
73 73  === 3.5 Getting the WSDL name ===
74 74  
... ... @@ -77,20 +77,15 @@
77 77  [[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--wsdl-name.png]]
78 78  
79 79  With this information we could reach the WSDL via the following endpoint, assuming we run in the eMagiz Cloud:
80 -* https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/spwbsrv-connector.wsdl
77 +* {{code}}https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/spwbsrv-connector.wsdl{{/code}}
81 81  
82 82  With this information we could reach the WSDL via the following endpoint, assuming we run locally on our laptop:
83 -* http://localhost:9091/ws/spwbsrv-connector/spwbsrv-connector.wsdl
80 +* {{code}}http://localhost:9091/ws/spwbsrv-connector/spwbsrv-connector.wsdl{{/code}}
84 84  
85 85  With this information, you should be able to access the WSDL and communicate both the endpoint as well as the WSDL to your external parties.
86 86  
87 -== 4. Assignment ==
84 +== 4. Key takeaways ==
88 88  
89 -Determine the endpoint of your SOAP Webservice and retrieve the WSDL.
90 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
91 -
92 -== 5. Key takeaways ==
93 -
94 94  * The endpoint consists of the following elements:
95 95   ** Starts with https:// or http://
96 96   ** Second part is the host (i.e. where is the endpoint running)
... ... @@ -100,12 +100,8 @@
100 100   ** If you want to get to the WSDL simply add the name of the WSDL and the .wsdl extension to the endpoint when viewing it in the browser
101 101  * The relevant information can be derived from the Jetty component and by determining where the endpoint is hosted
102 102  
103 -== 6. Suggested Additional Readings ==
95 +== 5. Suggested Additional Readings ==
104 104  
105 105  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
106 106  
107 -== 7. Silent demonstration video ==
108 -
109 -{{video attachment="novice-soap-webservice-connectivity-endpoint-check.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
110 -
111 111  )))((({{toc/}}))){{/container}}{{/container}}