Skip to Content

Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26
From version 28.2
edited by Erik Bakker
on 2022/06/10 13:13
Change comment: Update document after refactoring.
To version 53.1
edited by Danniar Firdausy
on 2024/09/04 10:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -novice-file-based-connectivity-processing-a-file-per-line
1 +Endpoint Check
Parent
... ... @@ -1,1 +1,1 @@
1 -WebHome
1 +Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,70 +1,83 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will learn how you can define a header line in which you specify the naming of the various columns. Some external systems require a header line when you supply them with data via a flat file that is placed somewhere.
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 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
4 +Should you have any questions, please contact academy@emagiz.com.
5 5  
6 -* Last update: May 28th, 2021
7 -* Required reading time: 5 minutes
8 -
9 9  == 1. Prerequisites ==
10 -
11 11  * Basic knowledge of the eMagiz platform
12 12  
13 13  == 2. Key concepts ==
10 +This microlearning centers around the endpoint check.
14 14  
15 -This microlearning centers around learning how to place a header line on a flat-file output.
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 -By header line we mean: A line in the output that defines the naming of the various columns
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
18 18  
19 -Some external parties require that the first line in the flat file output (i.e. CSV) is filled with column names (i.e. headers). In eMagiz, we call this line a header line.
22 +== 3. Endpoint Check ==
20 20  
21 -== 3. Header line ==
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.
22 22  
23 -In this microlearning, we will learn how you can define a header line in which you specify the naming of the various columns. Some external systems require a header line when you supply them with data via a flat file that is placed somewhere. The header line is the first line in the flat file output. Within this line, the various column names are specified for clarity.
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
24 24  
25 -To add such a header line in eMagiz you need to navigate to the Create phase of eMagiz and open the exit flow in which you want to drop the file to a certain location. Within the context of this flow, we need to add functionality that will ensure that a header line is written to the output before any functional lines are added. To do so first enter "Start Editing" mode on flow level. After you have done so please add a file outbound channel adapter to the flow including an input channel. We will use this component to write our header line to the flat file output.
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.
26 26  
27 -Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter.
36 +=== 3.1 HTTPS or HTTP ===
28 28  
29 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]
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).
30 30  
31 -Now it is time to turn our attention to the Advanced tab. For the Mode select Ignore. Select this option to ensure that the header line is only written down once when there is no output created yet and not somewhere in the middle, in the end, or every time. Furthermore, select the option Append New Line to ensure that the remainder of the information is not appended to the same line.
40 +=== 3.2 Host ===
32 32  
33 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]
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.
34 34  
35 -After you have done so we need to add a standard transformer that defines the various column names to be written to the flat file output. To do so add the standard transformer component to the canvas including an input channel. After you have done so define the relevant SpEL expression. In this case, we advise using a property value that represents a string of column names. The value of the property should be something as follows:
44 +=== 3.3 Port and Path ===
36 36  
37 -'Header1;Header2;Header3;Header4'
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."
38 38  
39 -Do note that the separator, in this case, needs to match the requirements of the external system. At the flow configuration level, the standard transformer should look as follows.
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}}.
40 40  
41 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]
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}}
42 42  
43 -Our last step is to ensure that this piece of logic is tied to the main flow and is executed before writing the functional line(s) to the output file. To make that happen we need to add a wiretap to the flow. With the help of this functionality, you can define which part of the logic takes precedence over another part of the logic. To do so double click on the channel on which you want to place a wiretap, select the option wiretap and select the correct wiretap channel. After you have done this the result should be something as follows:
52 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
44 44  
45 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]]
54 +== 4. Key takeaways ==
46 46  
47 -With these couple of steps, you have now successfully added logic to your flow that will ensure that a header line is added before any functional line(s) are written to the output file.
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
48 48  
49 -== 4. Assignment ==
65 +== 5. Suggested Additional Readings ==
50 50  
51 -Configure an exit in which you define and write a header line to a flat-file output before adding functional lines.
52 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
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 +** [[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"]]
79 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
80 +** [[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"]]
53 53  
54 -== 5. Key takeaways ==
55 -
56 -* The header line contains the names of the columns of the flat file output
57 -* Use the Ignore mode to ensure the header line is created once
58 -* Use the wiretap to ensure the header line is created first
59 -
60 -== 6. Suggested Additional Readings ==
61 -
62 -There are no suggested additional readings on this topic
63 -
64 -== 7. Silent demonstration video ==
65 -
66 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
67 -
68 -{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
69 -
70 70  )))((({{toc/}}))){{/container}}{{/container}}