Changes for page Validate Incoming Messages

Last modified by Eva Torken on 2024/02/21 21:34

From 28.1 to 28.2

From version 28.2

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

Change comment: Update document after refactoring.

To version 43.2

edited by Eva Torken
on 2024/02/21 21:34

Change comment: Update document after refactoring.

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--novice-file-based-connectivity-processing-a-file-per-line
++Validate Incoming Messages

Parent

@@ -1,1 +1,1 @@
--WebHome
++Main.eMagiz Academy.Microlearnings.Legacy Functionality.WebHome

Author

@@ -1,1 +1,1 @@
--XWiki.ebakker
++XWiki.etorken

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Content

@@ -1,70 +1,114 @@
  {{container}}{{container layoutStyle="columns"}}(((
--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.
++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 zoom in on the part that validation of the messages plays when offering such a SOAP web service.
--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 28th, 2021
--* Required reading time: 5 minutes
--
  == 1. Prerequisites ==
--
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
++This microlearning centers around configuring your SOAP web service.
--This microlearning centers around learning how to place a header line on a flat-file output.
++By configuring, we mean: Designing and determining the characteristics of the SOAP web service
--By header line we mean: A line in the output that defines the naming of the various columns
++Crucial parts in the configuration are:
++* Operation Name
++* SOAP Webservice Namespace
++* Validation
++* Authentication
--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.
++Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
--== 3. Header line ==
++== 3. Validate Incoming Messages ==
--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.
++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 zoom in on the part that validation of the messages plays when offering such a SOAP web service.
--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.
++Crucial parts in the configuration are:
++* Operation Name
++* SOAP Webservice Namespace
++* Validation
++* Authentication
--Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter.
++Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning. The SOAP Webservice serves as a point of entry where people with the rights credentials (security) and the right answers (validation) are allowed to enter and perform their actions. In the next microlearning, we will talk about the security part. In this microlearning, we talk about the validation part.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]
++As you have learned from the crash course you can validate an XML message with the help of an XSD. This XSD describes dataTypes, order, associations, and length of attributes. You can use such an XSD for the validation of what your clients send you. eMagiz will automatically define a WSDL based on the XSD that you provide that stores metainformation and stores the XSD for validation purposes. This way you can communicate the WSDL (location) to external parties as a reference document upon which they can build their solution. If you keep the eMagiz defaults you can access the WSDL via "http:~//localhost:port/ws/ws-name/ws-name.wsdl". Note that you need to replace all values (except for the ws and .wsdl part) with actual values.
--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.
++What eMagiz does need from you is the correct XSD for validation. As a starting point you should download the XSD that eMagiz has generated based on the system message(s) you have defined in the Design phase. Once you have that you can structure the XSD correctly. A valid XSD start with a schema segment. In this segment you need to define your SOAP WS namespace:
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]
++{{code language="xml"}}
++<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
++<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
++    xmlns="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/"
++    attributeFormDefault="unqualified" elementFormDefault="unqualified"
++    targetNamespace="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/">
++{{/code}}
--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:
++Once you have that you need to copy all complex and simple types from the XSD that you downloaded and paste them below the lines you have created:
--'Header1;Header2;Header3;Header4'
++{{code language="xml"}}
++<xs:complexType name="Input">
++        <xs:sequence>
++            <xs:element name="String" type="nonEmptyString"/>
++            <xs:element minOccurs="0" name="Decimal" type="xs:decimal"/>
++            <xs:element name="Enum" type="Enum"/>
++            <xs:element name="Integer" type="xs:long"/>
++            <xs:element name="Boolean" type="xs:boolean"/>
++            <xs:element minOccurs="0" name="DateTime" type="xs:dateTime"/>
++        </xs:sequence>
++    </xs:complexType>
++    <xs:simpleType name="nonEmptyString">
++        <xs:restriction base="xs:string">
++            <xs:minLength value="1"/>
++        </xs:restriction>
++    </xs:simpleType>
++    <xs:simpleType name="Enum">
++        <xs:restriction base="xs:string">
++            <xs:enumeration value="URGENT"/>
++            <xs:enumeration value="HIGH"/>
++            <xs:enumeration value="MEDIUM"/>
++            <xs:enumeration value="LOW"/>
++            <xs:enumeration value="PLANNING"/>
++        </xs:restriction>
++    </xs:simpleType>
++{{/code}}
--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.
++To wrap things up you need to define your Request and Response element and close the schema:
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]
++{{code language="xml"}}
++<xs:element name="SendNptRequest">
++        <xs:complexType>
++            <xs:sequence>
++                <xs:element name="Input" type="Input"/>
++            </xs:sequence>
++        </xs:complexType>
++    </xs:element>
++    <xs:element name="SendNptResponse">
++        <xs:complexType/>
++    </xs:element>
++    </xs:schema>
++{{/code}}
--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:
++Combining this will result in a valid XSD for my example. In your case, you will need to enter other values. When you are done with the creation of the XSD save it with a name such as spwbsrv-connector.xsd and upload it to the flow. After you have uploaded the XSD link it to the connector-xsd support object in your entry.
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.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.
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
--== 4. Assignment ==
++With this done you have successfully added validation to your SOAP web service.
--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.
++== 4. Key takeaways ==
--== 5. Key takeaways ==
++* Crucial parts in the configuration are:
++    ** Operation Name
++    ** SOAP Webservice Namespace
++    ** Validation
++    ** Authentication
++* Validation is done with the help of an XSD
++* The WSDL is used for external documentation
++* Use the XSD generated by eMagiz based on the system message as a starting point
--* 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
++== 5. Suggested Additional Readings ==
--== 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 ==
--
--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 Validate Incoming Messages

Summary

Details

Navigation