Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:39
From version 48.1
edited by Eva Torken
on 2023/06/27 11:02
Change comment: There is no comment for this version
To version 28.2
edited by Erik Bakker
on 2022/06/10 13:13
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Validate Incoming Messages
1 +novice-file-based-connectivity-processing-a-file-per-line
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.etorken
1 +XWiki.ebakker
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,75 +1,70 @@
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 to host 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 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.
3 3  
4 -If you have any questions, don't hesitate to contact academy@emagiz.com.
4 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 +* Last update: May 28th, 2021
7 +* Required reading time: 5 minutes
8 +
6 6  == 1. Prerequisites ==
10 +
7 7  * Basic knowledge of the eMagiz platform
8 8  
9 9  == 2. Key concepts ==
10 -This microlearning centers around configuring your SOAP web service.
11 11  
12 -By configuring, we mean: Designing and determining the characteristics of the SOAP web service.
15 +This microlearning centers around learning how to place a header line on a flat-file output.
13 13  
14 -Crucial parts in the configuration are:
15 -* Operation Name
16 -* SOAP Webservice Namespace
17 -* Validation
18 -* Authentication
17 +By header line we mean: A line in the output that defines the naming of the various columns
19 19  
20 -Of these four points, we will zoom in on the validation part of our SOAP Webservice in this microlearning.
19 +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.
21 21  
22 -== 3. Validate Incoming Messages ==
21 +== 3. Header line ==
23 23  
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 to host 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 +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.
25 25  
26 -Crucial parts in the configuration are:
27 -* Operation Name
28 -* SOAP Webservice Namespace
29 -* Validation
30 -* Authentication
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.
31 31  
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 proper credentials (security) and the correct answers (validation) can enter and perform their actions. In the previous microlearning, we talked about the validation part. In this microlearning, we talk about the security part.
27 +Ensure that the directory to which you reference is the same as in your functional file outbound channel adapter.
33 33  
34 -=== 3.1 Configuration on system message level in Design ===
29 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line.png]]
35 35  
36 -As you have learned from the crash course, you can validate an XML message with the help of an XSD. This XSD describes data types, order, associations, and length of attributes. You can use such an XSD to validate what your clients send you. eMagiz will automatically define a WSDL based on the combination of system messages you provide for each operation you want to host. To ensure that the WSDL is created correctly, don't forget to add an entity called "Send{givenname}Request" to the (request) system message and an entity called "Send{givenname}Response" in case you have a response system message. An example of how this needs to be configured in Design is shown below.
31 +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.
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--root-entity-for-wsdl.png]]
33 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]
39 39  
40 -=== 3.2 Effect in Create ===
35 +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:
41 41  
42 -In the infra flow, eMagiz automatically adds a support object of the "Dynamic WSDL" type. In this support object, the link is made between the system message definitions and the WSDL that will be created based on this.
37 +'Header1;Header2;Header3;Header4'
43 43  
44 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
39 +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.
45 45  
46 -{{warning}}Note that when you make changes to the system message after the integration is already in Create, or when you add a new integration to Create, you need to create a new version of your infra flow to be able to deploy the changes to your WSDL.{{/warning}}
41 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]
47 47  
48 -With this done, you have successfully added validation to your SOAP web service.
43 +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:
49 49  
45 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--wiretap-result.png]]
46 +
47 +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.
48 +
50 50  == 4. Assignment ==
51 51  
52 -Add validation to the SOAP Webservice we have been configuring.
53 -This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
51 +Configure an exit in which you define and write a header line to a flat-file output before adding functional lines.
52 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
54 54  
55 55  == 5. Key takeaways ==
56 56  
57 -* Crucial parts in the configuration are:
58 - ** Operation Name
59 - ** SOAP Webservice Namespace
60 - ** Validation
61 - ** Authentication
62 -* Validation is done with the help of an XSD
63 -* The WSDL is used for external documentation
64 -* eMagiz will automatically generate the WSDL for you based on your system messages
65 -** Do not forget to add the correct root entity to your system message to make the WSDL work
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
66 66  
67 67  == 6. Suggested Additional Readings ==
68 68  
69 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
62 +There are no suggested additional readings on this topic
70 70  
71 71  == 7. Silent demonstration video ==
72 72  
73 -{{video attachment="novice-soap-webservice-connectivity-validate-incoming-messages-gen3.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
66 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
74 74  
68 +{{video attachment="novice-file-based-connectivity-header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
69 +
75 75  )))((({{toc/}}))){{/container}}{{/container}}