Changes for page Endpoint Check

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Configure your SOAP web service
	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,99 +1,81 @@
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	+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: 7 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 configuring your SOAP web service.
	10	+This microlearning centers around the endpoint check.
14	14
15		-By configuring, we mean: Designing and determining the characteristics of the SOAP web service
	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		-Crucial parts in the configuration are:
18		-* Operation Name
19		-* SOAP Webservice Namespace
20		-* Validation
21		-* Authentication
	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
22	22
23		-Of these four points, the last two will be discussed in separate microlearnings.
24		-
25		-== 3. Configure your SOAP Webservice ==
	22	+== 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.
	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.
28	28
29		-Crucial parts in the configuration are:
30		-* Operation Name
31		-* SOAP Webservice Namespace
32		-* Validation
33		-* Authentication
	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
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.
	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.
36	36
37		-=== 3.1 Operation Name ===
	36	+=== 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:
	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).
40	40
41		-* Send{technicalnameoftheoperation}
	40	+=== 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:
	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.
44	44
45		-* Send{technicalnameoftheoperation}Request
	44	+=== 3.3 Port and Path ===
46	46
47		-=== 3.2 SOAP Webservice Namespace ===
	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."
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.
	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}}.
50	50
51		-=== 3.3 Configuration in eMagiz ===
	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}}
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.
	52	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
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.
	54	+== 4. Key takeaways ==
56	56
57		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-check.png]]
	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
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.
	65	+== 5. Suggested Additional Readings ==
60	60
61		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-choice.png]]
	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		-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.
64		-
65		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--combined-entry-soap-ws-namespace.png]]
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.
68		-
69		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-configure-your-soap-webservice--edit-integration.png]]
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.
72		-
73		-=== 3.4 Add integration to Create ===
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.
76		-
77		-== 4. Assignment ==
78		-
79		-Configure a SOAP web service that consists of at least one operation and add it to Create.
80		-This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
81		-
82		-== 5. Key takeaways ==
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
90		-
91		-== 6. Suggested Additional Readings ==
92		-
93		-If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
94		-
95		-== 7. Silent demonstration video ==
96		-
97		-{{video attachment="novice-soap-webservice-connectivity-configure-your-soap-webservice.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
98		-
99	99	)))((({{toc/}}))){{/container}}{{/container}}