Changes for page Validate Incoming Messages

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Character set
	1	+Validate Incoming Messages

Default language

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

Content

...	...	@@ -1,67 +1,117 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-n some cases, the input you receive or the output that you need to send to an external party cannot handle all characters or the input or output is written with the help of a character set. In this microlearning, we will learn how you can define the character set for file-based connectivity to ensure that you can process and deliver files according to the specifications.
	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 31th, 2021
7		-* Required reading time: 7 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		-This microlearning centers around learning how to define the character set to ensure that eMagiz processes the information correctly.
	12	+By configuring, we mean: Designing and determining the characteristics of the SOAP web service
16	16
17		-By character set, we mean: The composite number of different characters that are being used and supported by computer software and hardware. It consists of codes, bit patterns, or natural numbers used in defining some particular character.
	14	+Crucial parts in the configuration are:
	15	+* Operation Name
	16	+* SOAP Webservice Namespace
	17	+* Validation
	18	+* Authentication
18	18
19		-* Some external system talk in a different character set
20		-* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
21		-* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
	20	+Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
22	22
23		-== 3. Character set ==
	22	+== 3. Validate Incoming Messages ==
24	24
25		-In some cases, the input you receive or the output that you need to send to an external party cannot handle all characters or the input or output is written with the help of a character set. In this microlearning, we will learn how you can define the character set for file-based connectivity to ensure that you can process and deliver files according to the specifications.
	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.
26	26
27		-Sometimes external systems only talk in a specific character set. To ensure that all the data is properly communicated between eMagiz and the other system we need to make sure that we define which character set that is so we can tell it to eMagiz via a component. That way eMagiz will deviate from its default (i.e. UTF-8) and will process the file according to that different character set. In practice, we mainly see windows-1252 as an alternative that pops up once in a while. In various components that deal with file handling, you can define the character set on which eMagiz should act. Examples of such components are:
	26	+Crucial parts in the configuration are:
	27	+* Operation Name
	28	+* SOAP Webservice Namespace
	29	+* Validation
	30	+* Authentication
28	28
29		-- File to string transformer
30		-- Flat file to XML transformer
31		-- File outbound channel 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.
32	32
33		-In all these components you have the option to define the character set within the Advanced tab of the component. In this microlearning, we will use the File to string transformer to illustrate how that will look.
	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.
34	34
35		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-characterset--characterset-configuration.png]]
	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:
36	36
37		-In this field, you can define the character set of your choice. 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 the correct character set is used. To do so first enter "Start Editing" mode on flow level. After that open, the File to string transformer, navigate to the Advanced tab, and fill in the correct character set. After you have defined the correct character set the only thing left to do is to Save the component. See the suggested additional readings section on the complete list of character sets that are supported by Java 8.
	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/">
38	38
39		-Congratulations you have successfully learned how to specify the character set.
	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:
40	40
	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>
	70	+
	71	+To wrap things up you need to define your Request and Response element and close the schema:
	72	+
	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>
	84	+
	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.
	86	+
	87	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]]
	88	+
	89	+[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
	90	+
	91	+With this done you have successfully added validation to your SOAP web service.
	92	+
41	41	== 4. Assignment ==
42	42
43		-Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
	95	+Add validation to the SOAP Webservice we have been configuring.
44	44	This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
45	45
46	46	== 5. Key takeaways ==
47	47
48		-* Some external system talk in a different character set
49		-* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
50		-* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
51		-* eMagiz provides several components within which you can define the character set
	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
52	52
53	53	== 6. Suggested Additional Readings ==
54	54
55		-If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
	111	+If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
56	56
57		-* https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html
58		-* https://www.techopedia.com/definition/941/character-set
59		-* https://www.smashingmagazine.com/2012/06/all-about-unicode-utf8-character-sets/
60		-
61	61	== 7. Silent demonstration video ==
62	62
63		-This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
	115	+{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
64	64
65		-{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
66		-
67	67	)))((({{toc/}}))){{/container}}{{/container}}