Changes for page Endpoint Check

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.CarlijnKokkeler
	1	+XWiki.dfirdausy

Content

...	...	@@ -1,5 +1,5 @@
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. 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.
	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
...	...	@@ -21,31 +21,31 @@
21	21
22	22	== 3. Endpoint Check ==
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.
	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.
25	25
26	26	* The endpoint consists of the following elements:
27	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
	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
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.
	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.
35	35
36	36	=== 3.1 HTTPS or HTTP ===
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).
	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).
39	39
40	40	=== 3.2 Host ===
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.
	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.
43	43
44	44	=== 3.3 Port and Path ===
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.
	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."
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}}.
	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}}.
49	49
50	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}}
51	51
...	...	@@ -55,11 +55,11 @@
55	55
56	56	* The endpoint consists of the following elements:
57	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
	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	63	* The relevant information can be derived from the "Dynamic WSDL" support object and by determining where the endpoint is hosted
64	64
65	65	== 5. Suggested Additional Readings ==
...	...	@@ -74,7 +74,10 @@
74	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	75	* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
76	76	** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.SOAP Web service Connectivity.WebHome||target="blank"]]
	77	+** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.WebHome||target="blank"]]
	78	+*** [[Routes (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Cloud Management.intermediate-emagiz-cloud-management-routes||target="blank"]]
77	77	* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
78	78	** [[Webservice Security (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Webservice Security.WebHome||target="blank"]]
	81	+* [[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"]]
79	79
80	80	)))((({{toc/}}))){{/container}}{{/container}}