Changes for page Endpoint Check

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-novice-soap-webservice-connectivity-soap-headers
	1	+novice-file-based-connectivity-characterset

Content

...	...	@@ -1,120 +1,104 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
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.
	2	+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.
3	3
4		-Should you have any questions, please contact academy@emagiz.com.
	4	+Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
6		-* Last update: June 10th, 2021
	6	+* Last update: May 31th, 2021
7	7	* Required reading time: 7 minutes
8	8
9	9	== 1. Prerequisites ==
	10	+
10	10	* Basic knowledge of the eMagiz platform
11	11
12	12	== 2. Key concepts ==
13		-This microlearning centers around configuring your SOAP web service.
14	14
15		-By configuring, we mean: Designing and determining the characteristics of the SOAP web service
	15	+This microlearning centers around learning how to process an incoming file per line.
16	16
17		-Crucial parts in the configuration are:
18		-* Operation Name
19		-* SOAP Webservice Namespace
20		-* Validation
21		-* Authentication
	17	+By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
22	22
23		-Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
24		-
25		-== 3. Validate Incoming Messages ==
	19	+* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
	20	+* Ability to process each line based on distinctive logic that is relevant on line level
	21	+* Can be used for flat file as well as XML input files
26	26
27		-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.
	23	+== 3. Processing a File per Line ==
28	28
29		-Crucial parts in the configuration are:
30		-* Operation Name
31		-* SOAP Webservice Namespace
32		-* Validation
33		-* Authentication
	25	+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.
34	34
35		-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.
	27	+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.
36	36
37		-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 all values (except for the ws and .wsdl part) with actual values.
	29	+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.
38	38
39		-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:
	31	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]]
40	40
41		-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
42		-<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
43		- xmlns="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/"
44		- attributeFormDefault="unqualified" elementFormDefault="unqualified"
45		- targetNamespace="http://www.academy.emagiz.com/ns/mlacade-bus/spwbsrv-connector/1.0/">
	33	+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.
46	46
47		-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:
	35	+=== 3.1 Item reader Type ===
48	48
49		-<xs:complexType name="Input">
50		- <xs:sequence>
51		- <xs:element name="String" type="nonEmptyString"/>
52		- <xs:element minOccurs="0" name="Decimal" type="xs:decimal"/>
53		- <xs:element name="Enum" type="Enum"/>
54		- <xs:element name="Integer" type="xs:long"/>
55		- <xs:element name="Boolean" type="xs:boolean"/>
56		- <xs:element minOccurs="0" name="DateTime" type="xs:dateTime"/>
57		- </xs:sequence>
58		- </xs:complexType>
59		- <xs:simpleType name="nonEmptyString">
60		- <xs:restriction base="xs:string">
61		- <xs:minLength value="1"/>
62		- </xs:restriction>
63		- </xs:simpleType>
64		- <xs:simpleType name="Enum">
65		- <xs:restriction base="xs:string">
66		- <xs:enumeration value="URGENT"/>
67		- <xs:enumeration value="HIGH"/>
68		- <xs:enumeration value="MEDIUM"/>
69		- <xs:enumeration value="LOW"/>
70		- <xs:enumeration value="PLANNING"/>
71		- </xs:restriction>
72		- </xs:simpleType>
	37	+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.
73	73
74		-To wrap things up you need to define your Request and Response element and close the schema:
	39	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]
75	75
76		-<xs:element name="SendNptRequest">
77		- <xs:complexType>
78		- <xs:sequence>
79		- <xs:element name="Input" type="Input"/>
80		- </xs:sequence>
81		- </xs:complexType>
82		- </xs:element>
83		- <xs:element name="SendNptResponse">
84		- <xs:complexType/>
85		- </xs:element>
86		- </xs:schema>
	41	+Based on your choice the exact configuration will differ.
87	87
88		-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.
	43	+==== 3.1.1 Stax Event Item Reader ====
89	89
90		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--uploaded-file.png]]
	45	+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.
91	91
92		-[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages--file-linked-to-xsd-component.png]]
	47	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]
93	93
94		-With this done you have successfully added validation to your SOAP web service.
	49	+==== 3.1.2 Flat File Item Reader ====
95	95
	51	+For the Flat File item reader, there are some more choices and configurations to be made. There are three options you can choose from:
	52	+- Pass through line mapper
	53	+- Default line mapper
	54	+- Pattern matching composite line mapper
	55	+
	56	+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).
	57	+
	58	+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.
	59	+
	60	+For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen.
	61	+
	62	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]
	63	+
	64	+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.
	65	+
	66	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]
	67	+
	68	+=== 3.2 Poller ===
	69	+
	70	+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:
	71	+
	72	+- Fixed Delay Trigger
	73	+- Fixed Rate Trigger
	74	+- Cron Trigger
	75	+
	76	+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.
	77	+
	78	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--poller-config.png]]
	79	+
	80	+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.
	81	+
96	96	== 4. Assignment ==
97	97
98		-Add validation to the SOAP Webservice we have been configuring.
	84	+Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
99	99	This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
100	100
101	101	== 5. Key takeaways ==
102	102
103		-* Crucial parts in the configuration are:
104		- ** Operation Name
105		- ** SOAP Webservice Namespace
106		- ** Validation
107		- ** Authentication
108		-* Validation is done with the help of an XSD
109		-* The WSDL is used for external documentation
110		-* Use the XSD generated by eMagiz based on the system message as a starting point
	89	+* Easy way of reading a file line by line and sending it to eMagiz (Low on memory)
	90	+* Ability to process each line based on distinctive logic that is relevant on line level
	91	+* Can be used for flat file as well as XML input files
	92	+* Try to avoid complex transformations within the entry
111	111
112	112	== 6. Suggested Additional Readings ==
113	113
114		-If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
	96	+There are no suggested additional readings on this topic
115	115
116	116	== 7. Silent demonstration video ==
117	117
118		-{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
	100	+This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
119	119
	102	+{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
	103	+
120	120	)))((({{toc/}}))){{/container}}{{/container}}