Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26

From 29.1 to 30.1 From 39.1 to 40.1

From version 30.1

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

Change comment: There is no comment for this version

To version 39.1

edited by Erik Bakker
on 2022/06/12 09:39

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Processing a File per Line
++Endpoint Check

Content

@@ -1,104 +1,111 @@
  {{container}}{{container layoutStyle="columns"}}(((
--In some cases, you want to treat each unique part of your input file as its message instead of processing the complete file as its message. In this microlearning, we will learn how you can process a (large) file on a per-line basis.
++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.
--Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
++Should you have any questions, please contact academy@emagiz.com.
--* Last update: May 31th, 2021
++* Last update: June 11th, 2021
  * Required reading time: 7 minutes
  == 1. Prerequisites ==
--
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
++This microlearning centers around the endpoint check.
--This microlearning centers around learning how to process an incoming file per line.
++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
--By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
++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
++
++== 3. Endpoint Check ==
--* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
--* Ability to process each line based on distinctive logic that is relevant on line level
--* Can be used for flat file as well as XML input files
++hen 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. Processing a File per 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 some cases, you want to treat each unique part of your input file as its message instead of processing the complete file as its message. In this microlearning, we will learn how you can process a (large) file on a per-line basis.
++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 make this work in eMagiz you need to navigate to the Create phase of eMagiz and open the entry flow in which you want to retrieve the file to a certain location. Within the context of this flow, we need to add functionality that will ensure that each line is read and processed separately and will become its unique message. To do so first enter "Start Editing" mode on flow level. After you have done so please add a file item reader message source to the flow. We will use this component to read and process our input file on a per-line basis.
++=== 3.1 HTTPS or HTTP ===
--The first step would be to define the directory from which we read our messages. As always reference to the directory with the help of a property.
++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-processing-a-file-per-line--file-item-reader-directory.png]]
++=== 3.2 Host ===
--Secondly, just as when reading the file as a whole ensure that you use a filter to retrieve only the correct files from the directory.
++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.
--=== 3.1 Item reader Type ===
++=== 3.3 Port ===
--Now it is time to select our Item reader Type. As the help text of the eMagiz component suggest there are two choices with this component. The first (and most frequently used) option is the Flat file item reader. With this option, you can read each line within the flat file input file and output is at a separate message. The second option is called the Stax event item reader. With this option, you can read your input XML and output messages on a per-record basis.
++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).
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--server-connector-settings.png]]
--Based on your choice the exact configuration will differ.
++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.
--==== 3.1.1 Stax Event Item Reader ====
++=== 3.3 Context Path ===
--For the Stax event item reader, you need to define the name of the element on which you want to split the XML and define whether you want to throw an error in case no such element exists in the input file (By (de)selecting the option Strict). The default setting of eMagiz is advisable for this option.
++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-processing-a-file-per-line--stax-event-item-reader-config.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--context-path.png]]
--==== 3.1.2 Flat File Item Reader ====
++=== 3.4 Path Specific Servlet Mapping ===
--For the Flat File item reader, there are some more choices and configurations to be made. There are three options you can choose from:
--- Pass through line mapper
--- Default line mapper
--- Pattern matching composite line mapper
++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.
--Each of these options has some advantages and disadvantages. Adhering to the best practices of eMagiz (i.e. no transformation in the entry) the best option would be to use the pass-through line mapper. As the name suggests this option does nothing except give a string back to the flow on a per line basis. However, choosing this option means that the actual transformation from that string to XML needs to happen later in the process (most likely in the onramp) with the help of a flat-file to XML transformer (more on that component in a later course).
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--path-specific-servlet-mapping.png]]
--The other two options transform the input line into an XML output. So you win one step in the process. However, no standard eMagiz error handling is advisable when you start transforming data within the entry. So in case, something goes wrong to analyze the error will become more difficult. Furthermore, another potential disadvantage is that when one line fails the processing of the rest of the file also halts.
++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/
--For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen.
++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/
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]
++=== 3.5 Getting the WSDL name ===
--As you can see on the Basic level we are done. However, it is always good to check out the settings on the Advanced tab, especially in this case, to see if there are additional configuration options that could benefit us. The setting of most interest, in this case, is the Lines to Skip setting (default setting is 0). With this setting, you can define whether or not you want to process the header line(s) that exists within your input file. The remainder of the settings is (in most cases) good the way eMagiz has set them up.
++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-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-endpoint-check--wsdl-name.png]]
--=== 3.2 Poller ===
++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
--Now that we have selected and configured the item reader type it becomes time to fill in the last part of the configuration, the poller. For polling eMagiz offers three options:
++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
--- Fixed Delay Trigger
--- Fixed Rate Trigger
--- Cron Trigger
++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.
--Of these options, the cron trigger is used most frequently in eMagiz. The reason being is that you can define this option via a property that you can alter without having to alter the flow version in Create.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--poller-config.png]]
--
--After finishing all these configuration steps we can press Save to save our work and ensure that we can process the input file on a per-line basis.
--
  == 4. Assignment ==
--Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
++Determine the endpoint of your SOAP Webservice and retrieve the WSDL.
  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
--* Ability to process each line based on distinctive logic that is relevant on line level
--* Can be used for flat file as well as XML input files
--* Try to avoid complex transformations within the entry
++* 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
  == 6. Suggested Additional Readings ==
--There are no suggested additional readings on this topic
++If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
  == 7. Silent demonstration video ==
--This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
++{{video attachment="novice-soap-webservice-connectivity-endpoint-check.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
--{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
--
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Endpoint Check

Summary

Details

Navigation