Skip to Content

Changes for page Endpoint Check

Last modified by Erik Bakker on 2024/02/21 21:35
From version 34.2
edited by Erik Bakker
on 2022/06/12 09:34
Change comment: Update document after refactoring.
To version 39.1
edited by Erik Bakker
on 2022/06/12 09:39
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-soap-webservice-connectivity-calling-a-soap-webservice
1 +Endpoint Check
Content
... ... @@ -1,9 +1,9 @@
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 learn the basics of this configuration in the various phases of the platform so you can easily set up your 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 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.
3 3  
4 4  Should you have any questions, please contact academy@emagiz.com.
5 5  
6 -* Last update: June 10th, 2021
6 +* Last update: June 11th, 2021
7 7  * Required reading time: 7 minutes
8 8  
9 9  == 1. Prerequisites ==
... ... @@ -10,83 +10,95 @@
10 10  * Basic knowledge of the eMagiz platform
11 11  
12 12  == 2. Key concepts ==
13 -This microlearning centers around configuring your SOAP web service.
13 +This microlearning centers around the endpoint check.
14 14  
15 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service
15 +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 -Crucial parts in the configuration are:
18 -* Operation Name
19 -* SOAP Webservice Namespace
20 -* Validation
21 -* Authentication
22 -
23 -Of these four points, the last two will be discussed in separate microlearnings.
17 +The endpoint consists of the following elements:
18 +* Starts with https:// or http://
19 +* Second part is the host (i.e. where is the endpoint running)
20 +* Third part is the port on which the incoming traffic is accepted
21 +* These three things combined make up the first part of our endpoint that will vary per environment
22 +* Following that we have a static remainder of the endpoint that is build up as follows: /ws/{path-specific-servlet-mapping}/
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 24  
25 -== 3. Configure your SOAP Webservice ==
25 +== 3. Endpoint Check ==
26 26  
27 -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 learn the basics of this configuration in the various phases of the platform so you can easily set up your SOAP web service.
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.
28 28  
29 -Crucial parts in the configuration are:
30 -* Operation Name
31 -* SOAP Webservice Namespace
32 -* Validation
33 -* Authentication
29 +The endpoint consists of the following elements:
30 +* Starts with https:// or http://
31 +* Second part is the host (i.e. where is the endpoint running)
32 +* Third part is the port on which the incoming traffic is accepted
33 +* These three things combined make up the first part of our endpoint that will vary per environment
34 +* Following that we have a static remainder of the endpoint that is build up as follows: /{context-path}/{path-specific-servlet-mapping}/
35 +* 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
34 34  
35 -Of these four points, the last two will be discussed in separate microlearnings. In this microlearning, we will focus on the first two aspects of the configuration. As you might have noticed I did not mention the fact whether the integration is synchronous or asynchronous as a crucial part of the configuration. The reason being that when configuring a (SOAP) web service you always need to send an acknowledgment back to the client calling the web service to let them know what the status of the message is. In case you want to set up the rest of your integration asynchronously you can send an empty message back as acknowledgment. In case you want to set up the rest of your integration synchronously you need to send the response you have received from the backend operation back to the client. More on the choice between asynchronous and synchronous in a later stage.
37 +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 36  
37 -=== 3.1 Operation Name ===
39 +=== 3.1 HTTPS or HTTP ===
38 38  
39 -Let us first zoom in on the parts of the configuration before we learn how you can implement it in eMagiz. Starting with the operation name. When you have dealt with the API Gateway offering of eMagiz in the past or have some knowledge of how APIs work the notion of an operation name should not be unfamiliar. In essence, it is a unique name that defines a certain operation. In eMagiz the best practice for naming the operation is as follows:
41 +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 40  
41 -* Send{technicalnameoftheoperation}
43 +=== 3.2 Host ===
42 42  
43 -When you are in Create you will notice that eMagiz uses the default suffix of Request and Response is added to the operation name. Therefore the full operation name a client needs to call to get the desired result if you adhere to the best practice is:
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.
44 44  
45 -* Send{technicalnameoftheoperation}Request
47 +=== 3.3 Port ===
46 46  
47 -=== 3.2 SOAP Webservice Namespace ===
49 +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, in two steps. First, we navigate to the all entry we have created and open the Jetty component. The first segment of the Jetty Server talks about the server connector. In this part, the port is defined (either via a property or statically).
48 48  
49 -The second part of the configuration is the SOAP Webservice Namespace. When hosting a SOAP Webservice via the standard eMagiz tooling you need to define a namespace. To smoothen this process eMagiz automatically generates a namespace based on the configuration settings you choose in the Design phase of eMagiz.
51 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--server-connector-settings.png]]
50 50  
51 -=== 3.3 Configuration in eMagiz ===
53 +If it is defined via a property you can search for the corresponding value under Deploy -> Properties by checking on the property name and filtering on runtime level to get to the port. If it is defined statically you can simply read it here. Note that the best practice is to use a property value as that allows you to use a different range for your port numbering between environments. In other words, it allows you to use the 9000 range for Test, the 8000 range for Acceptance, and the 9000 range for Production. This is also to safeguard against someone accidentally sending data to the wrong environment.
52 52  
53 -Now that we know what configurations are required, we can see how we can implement this in eMagiz. In the Capture phase, nothing changes. You simply draw a system on the canvas including at least one line that goes from the system towards eMagiz. When you are done you move to the Design phase in eMagiz. In this phase, you need to correctly set up the operation name(s) and the SOAP Webservice Namespace.
55 +=== 3.3 Context Path ===
54 54  
55 -The configuration in Design starts at the system level. At the system level, you need to define the technical name (or let eMagiz automatically fill it in for you) and select the checkbox called Combined Entry Connector. By selecting this checkbox you tell eMagiz that you want to host an endpoint for others to call.
57 +The first part of the static remainder of the endpoint is the context. By default, this is filled with /ws but you as a user can alter this. You can check the current value by opening the Jetty component again and looking at the context path that is filled in.
56 56  
57 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]
59 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--context-path.png]]
58 58  
59 -As you can see, selecting this option opens up a new choice to make. In this case between SOAP Webservice and Custom.
61 +=== 3.4 Path Specific Servlet Mapping ===
60 60  
61 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]]
63 +The last part of our endpoint is determined by the path-specific servlet mapping. You can once again find the value (and change it if you want to) within the Jetty component. In this component, you can see the servlet mappings and see the path that belongs to that servlet. For SOAP Webservice the best practice is to have only one servlet-mapping and in 99% of the cases, the auto-generated value of eMagiz is more than fine.
62 62  
63 -In this case, we opt for the SOAP web service. After you have done so eMagiz will automatically define the SOAP Webservice Name and SOAP Webservice Namespace.
65 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--path-specific-servlet-mapping.png]]
64 64  
65 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]]
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/
66 66  
67 -With this, you are done with your configuration on the system level. Don't forget to update the status of your task. Now that we have configured the system it is time to configure the integration that is drawn from the system to eMagiz. We can do so by double-clicking on it (or by accessing the context menu and selecting the edit option). When you open the Edit page on the integration level you will notice that a new segment is added (compared to other integrations). This segment defines the settings on the system level we have just specified and defines the operation name.
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 68  
69 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
73 +=== 3.5 Getting the WSDL name ===
70 70  
71 -As you can see eMagiz has already prefilled the operation name for you based on the best practice at eMagiz. If you want to change you have the option to do so. Do note that for the sake of consistency it would be smart to use the same naming convention within a single project to avoid confusion.
75 +To get to the WSDL to verify if it is available to be shared with external parties the last thing you need is the WSDL name. You can find this one, surprisingly enough, in the Jetty component. To get to the WSDL name double click on the servlet that is defined under the heading Servlets and navigate to the Advanced tab. Here you will see the name of the WSDL. If you have adhered to the default of eMagiz the name will mimic the name of your path-specific servlet mapping.
72 72  
73 -=== 3.4 Add integration to Create ===
77 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--wsdl-name.png]]
74 74  
75 -Now that we have finished the configuration in Design the last step of this microlearning is to add the integration to Create. You can simply do so by navigating to Create -> Add integrations and selecting the integration to move it to Create. After you have selected it press Save to add the integration to Create.
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
76 76  
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
84 +
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 +
77 77  == 4. Assignment ==
78 78  
79 -Configure a SOAP web service that consists of at least one operation and add it to Create.
89 +Determine the endpoint of your SOAP Webservice and retrieve the WSDL.
80 80  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
81 81  
82 82  == 5. Key takeaways ==
83 83  
84 -* Crucial parts in the configuration are:
85 - ** Operation Name
86 - ** SOAP Webservice Namespace
87 - ** Validation
88 - ** Authentication
89 -* For ease, you can use the default naming convention of eMagiz
94 +* The endpoint consists of the following elements:
95 + ** Starts with https:// or http://
96 + ** Second part is the host (i.e. where is the endpoint running)
97 + ** Third part is the port on which the incoming traffic is accepted
98 + ** These three things combined make up the first part of our endpoint that will vary per environment
99 + ** Following that we have a static remainder of the endpoint that is build up as follows: /{context-path}/{path-specific-servlet-mapping}/
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 +* The relevant information can be derived from the Jetty component and by determining where the endpoint is hosted
90 90  
91 91  == 6. Suggested Additional Readings ==
92 92  
... ... @@ -94,6 +94,6 @@
94 94  
95 95  == 7. Silent demonstration video ==
96 96  
97 -{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
109 +{{video attachment="novice-soap-webservice-connectivity-endpoint-check.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
98 98  
99 99  )))((({{toc/}}))){{/container}}{{/container}}