Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26

From 35.1 to 35.2 From 44.1 to 45.1

From version 35.2

edited by Erik Bakker
on 2022/06/12 09:35

Change comment: Update document after refactoring.

To version 44.1

edited by Erik Bakker
on 2022/12/30 12:24

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--novice-soap-webservice-connectivity-validate-incoming-messages
++Endpoint Check

Parent

@@ -1,1 +1,1 @@
--WebHome
++Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Content

@@ -1,100 +1,109 @@
--{{container}}{{container layoutStyle="columns"}}(((
--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.
++{{container}}{{container layoutStyle="columns"}}(((
++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.
  Should you have any questions, please contact academy@emagiz.com.
--* Last update: April 1st, 2022
--* Required reading time: 5 minutes
--
  == 1. Prerequisites ==
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
--This microlearning centers around calling a SOAP Webservice.
++This microlearning centers around the endpoint check.
--With SOAP, we mean:  A messaging protocol specification for exchanging structured information in the implementation of web services in computer networks.
++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
--* To call a REST Webservice you need either:
--    ** A Web Service Outbound Gateway
--* Critical information when configuring this component:
--    ** URL
--    ** Retry Advice
--    ** Error Handling
--    ** Authentication
--
--== 3. Calling a SOAP Webservice ==
++The endpoint consists of the following elements:
++* Starts with https:// or http://
++* Second part is the host (i.e. where is the endpoint running)
++* Third part is the port on which the incoming traffic is accepted
++* These three things combined make up the first part of our endpoint that will vary per environment
++* Following that we have a static remainder of the endpoint that is build up as follows: /ws/{path-specific-servlet-mapping}/
++* 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
--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. Endpoint Check ==
--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:
++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.
--* URL
--* Retry Advice
--* Error Handling
--* Authentication
++The endpoint consists of the following elements:
++* Starts with https:// or http://
++* Second part is the host (i.e. where is the endpoint running)
++* Third part is the port on which the incoming traffic is accepted
++* These three things combined make up the first part of our endpoint that will vary per environment
++* Following that we have a static remainder of the endpoint that is build up as follows: /{context-path}/{path-specific-servlet-mapping}/
++* 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
--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.
++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.
--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:
++=== 3.1 HTTPS or HTTP ===
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--exit-flow-starting-point.png]]
++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).
--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.
++=== 3.2 Host ===
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component.png]]
++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.
--=== 3.1 URL ===
++=== 3.3 Port ===
--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.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-url.png]]
++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 {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".
--=== 3.2 Retry Advice ===
++{{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}}
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-button.png]]
++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).
--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
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--server-connector-settings.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-empty.png]]
++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.
--The best practice for this configuration is as follows for asynchronous solutions:
--* Select the option called Simple Retry Policy
--* Set the max attempts at 6
--* Select the Fixed back off policy
--* Set the backoff period at 5000 (ms)
++=== 3.3 Context Path ===
--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
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-retry-advice-pop-up-filled-in.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--context-path.png]]
--=== 3.3 Error Handling ===
++=== 3.4 Path Specific Servlet Mapping ===
--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".
++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.
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--path-specific-servlet-mapping.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-calling-a-soap-webservice--web-service-outbound-component-fault-message-resolver.png]]
++Combining all of this, assuming we run in the eMagiz Cloud, will result in the following endpoint for our Test environment:
++* https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/
--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:
++Combining all of this, assuming we run locally on our laptop, will result in the following endpoint for our Test environment:
++* http://localhost:9091/ws/spwbsrv-connector/
--[[image:Main.Images.Microlearning.WebHome@microlearning/novice-soap-webservice-connectivity-calling-a-soap-webservice--flow-result.png]]
++=== 3.5 Getting the WSDL name ===
++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.
++
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--wsdl-name.png]]
++
++With this information we could reach the WSDL via the following endpoint, assuming we run in the eMagiz Cloud:
++* https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/spwbsrv-connector.wsdl
++
++With this information we could reach the WSDL via the following endpoint, assuming we run locally on our laptop:
++* http://localhost:9091/ws/spwbsrv-connector/spwbsrv-connector.wsdl
++
++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.
++
  == 4. Assignment ==
--Build a flow within your project in which you do a call to an external party that hosts a SOAP web service.
++Determine the endpoint of your SOAP Webservice and retrieve the WSDL.
  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* eMagiz will create a valid SOAP message when using this component
--* eMagiz provides a support object for better error handling of SOAP faults
--* There are four key configuration elements:
--    ** URL
--    ** Retry Advice
--    ** Error Handling
--    ** Authentication
++* The endpoint consists of the following elements:
++    ** Starts with https:// or http://
++    ** Second part is the host (i.e. where is the endpoint running)
++    ** Third part is the port on which the incoming traffic is accepted
++    ** These three things combined make up the first part of our endpoint that will vary per environment
++    ** Following that we have a static remainder of the endpoint that is build up as follows: /{context-path}/{path-specific-servlet-mapping}/
++    ** 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
++* The relevant information can be derived from the Jetty component and by determining where the endpoint is hosted
  == 6. Suggested Additional Readings ==
@@ -102,6 +102,6 @@
  == 7. Silent demonstration video ==
--{{video attachment="novice-soap-webservice-connectivity-calling-a-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++{{video attachment="novice-soap-webservice-connectivity-endpoint-check.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Endpoint Check

Summary

Details

Navigation