Changes for page Validate Incoming Messages
Last modified by Eva Torken on 2024/02/21 21:34
From version 28.1
edited by Erik Bakker
on 2022/06/10 13:12
on 2022/06/10 13:12
Change comment:
There is no comment for this version
To version 39.1
edited by Erik Bakker
on 2022/08/22 15:37
on 2022/08/22 15:37
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Headerline1 +Validate Incoming Messages - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,70 +1,117 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - In thismicrolearning,wewilllearnhowyoucandefine aheaderlineinwhichyouspecifythenamingof thevariouscolumns.Someexternalsystemsquire a headerlinewhenyou supply them withdata viaa flat filethatis placedsomewhere.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. In this microlearning, we will zoom in on the part that validation of the messages plays when offering such a SOAP web service. 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 configuring your SOAP web service. 14 14 15 - Thismicrolearningcenters aroundlearninghowto placeaheaderlineon aflat-fileoutput.12 +By configuring, we mean: Designing and determining the characteristics of the SOAP web service 16 16 17 -By header line we mean: A line in the output that defines the naming of the various columns 14 +Crucial parts in the configuration are: 15 +* Operation Name 16 +* SOAP Webservice Namespace 17 +* Validation 18 +* Authentication 18 18 19 - Someexternal partiesrequirethatthefirstlinein theflatfileoutput(i.e. CSV) isfilledwith columnnames(i.e. headers). IneMagiz, wecallthislineheaderline.20 +Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning. 20 20 21 -== 3. Headerline ==22 +== 3. Validate Incoming Messages == 22 22 23 - Inthismicrolearning,we will learn how youcandefineaheader line inwhich you specifythenaming ofthe variouscolumns.Someexternalsystems requireaheader linewhenyousupplythem withdataviaaflat filethatisplacedsomewhere.Theheaderline is the firstline in theflatfile output.Within this line,thevarious columnnames are specified forclarity.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. In this microlearning, we will zoom in on the part that validation of the messages plays when offering such a SOAP web service. 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. 26 +Crucial parts in the configuration are: 27 +* Operation Name 28 +* SOAP Webservice Namespace 29 +* Validation 30 +* Authentication 26 26 27 - Ensurethatthe directorytowhichyoureference isthe same as inyourfunctionalfileoutboundchannel adapter.32 +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. 28 28 29 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]34 +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://host: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. 30 30 31 - Now it istimetoturnourattentionto theAdvancedtab.For the ModeselectIgnore.Selecthisoptionensurethatthe headerlineonly writtendownoncewhenthereisnooutputcreatedyet andnot somewherein themiddle,intheend,oreverytime.Furthermore,selectthe optionAppendNew Linetoensurethattheremainderoftheinformation is notappended tothesameline.36 +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: 32 32 33 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]] 38 +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 39 +<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" 40 + xmlns="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/" 41 + attributeFormDefault="unqualified" elementFormDefault="unqualified" 42 + targetNamespace="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/"> 34 34 35 - Afteryou havedonesoweneed toaddastandardtransformerthat definesthe various columnnamesto bewrittento the flatfileoutput.Todosothe standardtransformer component to the canvasincluding an inputchannel.After youhavedonesodefinetherelevant SpEL expression. In this case, we adviseusing a propertyvaluethat representsa string ofcolumn names. The value oftheproperty shouldbe something as follows:44 +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: 36 36 37 -'Header1;Header2;Header3;Header4' 46 +<xs:complexType name="Input"> 47 + <xs:sequence> 48 + <xs:element name="String" type="nonEmptyString"/> 49 + <xs:element minOccurs="0" name="Decimal" type="xs:decimal"/> 50 + <xs:element name="Enum" type="Enum"/> 51 + <xs:element name="Integer" type="xs:long"/> 52 + <xs:element name="Boolean" type="xs:boolean"/> 53 + <xs:element minOccurs="0" name="DateTime" type="xs:dateTime"/> 54 + </xs:sequence> 55 + </xs:complexType> 56 + <xs:simpleType name="nonEmptyString"> 57 + <xs:restriction base="xs:string"> 58 + <xs:minLength value="1"/> 59 + </xs:restriction> 60 + </xs:simpleType> 61 + <xs:simpleType name="Enum"> 62 + <xs:restriction base="xs:string"> 63 + <xs:enumeration value="URGENT"/> 64 + <xs:enumeration value="HIGH"/> 65 + <xs:enumeration value="MEDIUM"/> 66 + <xs:enumeration value="LOW"/> 67 + <xs:enumeration value="PLANNING"/> 68 + </xs:restriction> 69 + </xs:simpleType> 38 38 39 - Donote that the separator,inthiscase,needstomatch the requirementsoftheexternalsystem.At theflow configuration level,thestandardtransformershouldlook asfollows.71 +To wrap things up you need to define your Request and Response element and close the schema: 40 40 41 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]] 73 +<xs:element name="SendNptRequest"> 74 + <xs:complexType> 75 + <xs:sequence> 76 + <xs:element name="Input" type="Input"/> 77 + </xs:sequence> 78 + </xs:complexType> 79 + </xs:element> 80 + <xs:element name="SendNptResponse"> 81 + <xs:complexType/> 82 + </xs:element> 83 + </xs:schema> 42 42 43 - Our last step is toensurethat thispiece oflogicisiedto the mainflowandis executedbeforewritingthefunctionalline(s)tothe outputfile.To make that happenweneed toadd a wiretaptoflow. Withthehelp of this functionality,youcandefine whichpartof thelogictakes precedence overanotherpartof thelogic.To doso doubleclickonthechannelon whichyou wanttoplace awiretap,select theoptionwiretapandselectthecorrectwiretap channel. After you havedone thistheresult shouldbesomethingas follows:85 +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. 44 44 45 -[[image:Main.Images.Microlearning.WebHome@novice- file-based-connectivity-header-line--wiretap-result.png]]87 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]] 46 46 47 - With these couple of steps, you haveow successfullyadded logicto yourflow that willensure that a headerlineddedbeforeany functionalline(s)arewrittentheoutput file.89 +[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]] 48 48 91 +With this done you have successfully added validation to your SOAP web service. 92 + 49 49 == 4. Assignment == 50 50 51 - Configurean exitwhich youdefine and writeaheaderlinetoaflat-fileoutputbeforeaddingfunctional lines.95 +Add validation to the SOAP Webservice we have been configuring. 52 52 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 53 53 54 54 == 5. Key takeaways == 55 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 100 +* Crucial parts in the configuration are: 101 + ** Operation Name 102 + ** SOAP Webservice Namespace 103 + ** Validation 104 + ** Authentication 105 +* Validation is done with the help of an XSD 106 +* The WSDL is used for external documentation 107 +* Use the XSD generated by eMagiz based on the system message as a starting point 59 59 60 60 == 6. Suggested Additional Readings == 61 61 62 - Thereare no suggestedadditionalreadingsonthis topic111 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz. 63 63 64 64 == 7. Silent demonstration video == 65 65 66 - Thisvideodemonstrateshowyoucould havehandledheassignment andgivesyousomecontext onwhat you havejustlearned.115 +{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 67 67 68 -{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 69 - 70 70 )))((({{toc/}}))){{/container}}{{/container}}