Skip to Content

Changes for page Endpoint Check

Last modified by Erik Bakker on 2024/02/21 21:35
From version 46.1
edited by Eva Torken
on 2023/06/27 11:57
Change comment: There is no comment for this version
To version 27.2
edited by Erik Bakker
on 2022/06/10 13:08
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Endpoint Check
1 +novice-file-based-connectivity-header-line
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.etorken
1 +XWiki.ebakker
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,99 +1,77 @@
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 focus on using annotations to clarify your thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing), describe how the (more complex) parts of the flow work or describe (parts of) of your message definitions (i.e. CDM, API Gateway Data model, system message, etc.). This will help yourself and others every time changes are needed.
3 3  
4 -Should you have any questions, please contact academy@emagiz.com.
4 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 +* Last update: May 9th, 2021
7 +* Required reading time: 5 minutes
8 +
6 6  == 1. Prerequisites ==
10 +
7 7  * Basic knowledge of the eMagiz platform
8 8  
9 9  == 2. Key concepts ==
10 -This microlearning centers around the endpoint check.
11 11  
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
15 +This microlearning centers around using annotations.
16 +With annotations, we mean: A piece of text to explain something to yourself and others
13 13  
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: /ws/{path-specific-servlet-mapping}/
20 -* 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
18 +Annotations can be used for:
21 21  
22 -== 3. Endpoint Check ==
20 +* Describing a best practice everyone should follow
21 +* Describing (more complex) parts of the flow
22 +* Describe (parts of) your message definitions
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 +== 3. Annotations ==
25 25  
26 -The endpoint consists of the following elements:
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: /{context-path}/{path-specific-servlet-mapping}/
32 -* 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
26 +In this microlearning, we will focus on using annotations on the flow level to clarify our thought process. In the annotation, you either describe a best practice everyone should follow when they change that flow (i.e. within the asynchronous routing) or describe how the (more complex) parts of the flow work. This will help yourself and others every time changes are needed within the flow.
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.
28 +Annotations can be used for:
35 35  
36 -=== 3.1 HTTPS or HTTP ===
30 +* Describing a best practice everyone should follow
31 +* Describing (more complex) parts of the flow
32 +* Describe (parts of) your message definitions
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).
34 +To clarify the use cases let us take a look at how annotations can be added within the eMagiz platform. In our first example, we will take a look at asynchronous routing. In many eMagiz projects, a best practice is followed on how to add something to the asynchronous routing (or change something within the asynchronous routing). Because the best practice contains multiple steps it makes sense to use the annotation functionality of eMagiz to define all these steps and register them at the place you need them (i.e. the asynchronous routing). Having done so will result in something like this:
39 39  
40 -=== 3.2 Host ===
36 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-best-practice-async-routing.png]]
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.
38 +The second example is about using annotations on the flow level to describe parts of the flow. In this example, we will use the annotation to describe that we use a filter to determine which messages are picked up from a local directory and how we filter. That way anyway opening the flow has to merely read the annotation to get the context. Having done so will result in something like this:
43 43  
44 -=== 3.3 Port ===
40 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-parts-of-flow.png]]
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, 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).
42 +The third example does not take place on the flow level but the message definition level. Therefore instead of going to Create, we go to Design. In Design when you navigate to the CDM, API Gateway Data model, Event Streaming Data model, message definitions, etc. you have the option to add annotations to the canvas. In this example, we want to make clear to all that make changes that a certain part of our CDM is used by a lot of integrations within eMagiz and therefore everyone should be careful and think twice before adjusting anything related to that part. Having done so will result in something like this:
47 47  
48 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--server-connector-settings.png]]
44 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--describe-crucial-part-of-cdm.png]]
49 49  
50 -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.
46 +Now that we saw some examples let us turn our attention to the how. How can I add an annotation and how can I link it. Adding the annotation is simple. You drag the annotation icon from the left context menu onto the canvas. As a result, an empty annotation will be shown on the canvas. By double-clicking on it you can type whatever you want. Note that you need to be in "Start Editing" mode to change anything, including annotations.
51 51  
52 -=== 3.3 Context Path ===
48 +[[image:Main.Images.Microlearning.WebHome@novice-devops-perspectives-annotations--annotation-icon-context-menu.png]]
53 53  
54 -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.
50 +When you are satisfied with what you have written down you can press the Save button. After you have done so you can rescale the annotation to ensure that the complete text is visible. To link the annotation to a component (on flow level) or an entity (on message definition level) you hover over the annotation until your mouse indicator changes to a + icon, execute a right-click and drag from the annotation to the component in question.
55 55  
56 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--context-path.png]]
52 +Now you know what annotations are good for and how you can add them within the eMagiz platform.
57 57  
58 -=== 3.4 Path Specific Servlet Mapping ===
54 +== 4. Assignment ==
59 59  
60 -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.
56 +Add annotation on the flow level that describes how (a part of) a flow works.
57 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
61 61  
62 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--path-specific-servlet-mapping.png]]
59 +== 5. Key takeaways ==
63 63  
64 -Combining all of this, assuming we run in the eMagiz Cloud, will result in the following endpoint for our Test environment:
65 -* {{code}}https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/{{/code}}
61 +* Annotations can be used for:
62 + * Describing a best practice everyone should follow
63 + * Describing (more complex) parts of the flow
64 + * Describe (parts of) your message definitions
65 +* You can add annotations by dragging and dropping the annotation icon on the canvas.
66 66  
67 -Combining all of this, assuming we run locally on our laptop, will result in the following endpoint for our Test environment:
68 -* {{code}}http://localhost:9091/ws/spwbsrv-connector/{{/code}}
67 +== 6. Suggested Additional Readings ==
69 69  
70 -=== 3.5 Getting the WSDL name ===
69 +There are no suggested additional readings on this topic
71 71  
72 -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.
71 +== 7. Silent demonstration video ==
73 73  
74 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--wsdl-name.png]]
73 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
75 75  
76 -With this information we could reach the WSDL via the following endpoint, assuming we run in the eMagiz Cloud:
77 -* {{code}}https://spwbsrv-test-cloud0001.emagizcloud.com/ws/spwbsrv-connector/spwbsrv-connector.wsdl{{/code}}
75 +{{video attachment="novice-devops-perspectives-annotations.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
78 78  
79 -With this information we could reach the WSDL via the following endpoint, assuming we run locally on our laptop:
80 -* {{code}}http://localhost:9091/ws/spwbsrv-connector/spwbsrv-connector.wsdl{{/code}}
81 -
82 -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.
83 -
84 -== 4. Key takeaways ==
85 -
86 -* The endpoint consists of the following elements:
87 - ** Starts with https:// or http://
88 - ** Second part is the host (i.e. where is the endpoint running)
89 - ** Third part is the port on which the incoming traffic is accepted
90 - ** These three things combined make up the first part of our endpoint that will vary per environment
91 - ** Following that we have a static remainder of the endpoint that is build up as follows: /{context-path}/{path-specific-servlet-mapping}/
92 - ** 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
93 -* The relevant information can be derived from the Jetty component and by determining where the endpoint is hosted
94 -
95 -== 5. Suggested Additional Readings ==
96 -
97 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
98 -
99 99  )))((({{toc/}}))){{/container}}{{/container}}