Changes for page Endpoint Check

Last modified by Erik Bakker on 2024/02/21 21:35

From 28.2 to 28.1 From 42.1 to 41.1

From version 41.1

edited by Erik Bakker
on 2022/08/22 15:43

Change comment: There is no comment for this version

To version 28.2

edited by Erik Bakker
on 2022/06/10 13:13

Change comment: Update document after refactoring.

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Endpoint Check
++novice-file-based-connectivity-processing-a-file-per-line

Content

@@ -1,111 +1,70 @@
  {{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.
++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.
--Should you have any questions, please contact academy@emagiz.com.
++Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
--* Last update: June 11th, 2021
--* Required reading time: 7 minutes
++* Last update: May 28th, 2021
++* Required reading time: 5 minutes
  == 1. Prerequisites ==
++
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
--This microlearning centers around the endpoint check.
--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
++This microlearning centers around learning how to place a header line on a flat-file output.
--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
++By header line we mean: A line in the output that defines the naming of the various columns
--== 3. Endpoint Check ==
++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.
--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.
++== 3. Header line ==
--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
++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.
--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.
++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.
--=== 3.1 HTTPS or HTTP ===
++Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter.
--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).
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]
--=== 3.2 Host ===
++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.
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]
--=== 3.3 Port ===
++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:
--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).
++'Header1;Header2;Header3;Header4'
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--server-connector-settings.png]]
++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.
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]
--=== 3.3 Context Path ===
++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:
--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-file-based-connectivity-header-line--wiretap-result.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--context-path.png]]
++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.
--=== 3.4 Path Specific Servlet Mapping ===
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--path-specific-servlet-mapping.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/
--
--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/
--
--=== 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 ==
--Determine the endpoint of your SOAP Webservice and retrieve the WSDL.
++Configure an exit in which you define and write a header line to a flat-file output before adding functional lines.
  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* 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
++* The header line contains the names of the columns of the flat file output
++* Use the Ignore mode to ensure the header line is created once
++* Use the wiretap to ensure the header line is created first
  == 6. Suggested Additional Readings ==
--If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
++There are no suggested additional readings on this topic
  == 7. Silent demonstration video ==
--{{video attachment="novice-soap-webservice-connectivity-endpoint-check.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
++{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Endpoint Check

Summary

Details

Navigation