Skip to Content

Changes for page SOAP Headers

Last modified by Erik Bakker on 2024/08/26 12:48
From version 42.1
edited by Erik Bakker
on 2022/08/22 15:57
Change comment: There is no comment for this version
To version 30.1
edited by Erik Bakker
on 2022/06/10 13:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -SOAP Headers
1 +Processing a File per Line
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,66 +1,104 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
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: May 31th, 2021
7 +* Required reading time: 7 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 SOAP Headers.
11 11  
12 -By SOAP Headers, we mean: headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties
15 +This microlearning centers around learning how to process an incoming file per line.
13 13  
14 -You can exchange data from:
15 -* SOAP Header to Message Header
16 -* Message Header to SOAP Header
17 +By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
17 17  
18 -In both cases ensure that the correct information is exchanged.
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
19 19  
20 -== 3. SOAP Headers ==
23 +== 3. Processing a File per Line ==
21 21  
22 -When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
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.
23 23  
24 -You can exchange data from:
25 -* SOAP Header to Message Header
26 -* Message Header to SOAP Header
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.
27 27  
28 -In both cases ensure that the correct information is exchanged.
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.
29 29  
30 -In a previous microlearning, we already discussed one aspect of this. As you probably recall from our microlearning on [[Securing your SOAP Webservice>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-securing-your-soap-webservice.WebHome||target="blank"]] we needed to exchange data between the SOAP header that our client was sending and a message header on the message so we could check whether or not the client was authorized to call the operation.
31 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]]
31 31  
32 -In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'.
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.
33 33  
34 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]]
35 +=== 3.1 Item reader Type ===
35 35  
36 -As you can see you can map from and to message headers with regards to the SOAP Headers. As we already discussed the first scenario in an earlier microlearning I will for now continue with the other scenario. This scenario is mainly needed when eMagiz calls a SOAP web service that is hosted by an external party. Since we would normally do this in an exit (gate/flow) let us open such an exit in eMagiz and enter "Start Editing" mode.
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.
37 37  
38 -The first step we need to take is to ensure that the information that we need to send to the SOAP web service in question (in this a unique reference number) is available in a message header. This can be done by verifying in all steps that preceded before the message entered the exit whether or not this piece of information was already added to a message header. In this case, we assume that this is the case since we want to focus on the 'complex SOAP header mapper' component and its relation to the web services outbound gateway. To correctly exchange data from a message header to a SOAP header we need to define a valid SpEL expression. See the help text of the component for a suggestion of what a valid SpEL expression is. The key part in this is knowing how the external party wants to receive the header(s) and how you (or one of your colleagues) has named the message header. When you have those two information elements you can write the correct expression. The result should be something as follows:
39 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]
39 39  
40 -[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]]
41 +Based on your choice the exact configuration will differ.
41 41  
42 -Once you are satisfied you can press Save and link the support object to the web service outbound gateway.
43 +==== 3.1.1 Stax Event Item Reader ====
43 43  
44 -With this information, you can place SOAP Headers on message headers and vice versa every time you need it.
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.
45 45  
47 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]
48 +
49 +==== 3.1.2 Flat File Item Reader ====
50 +
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 +
46 46  == 4. Assignment ==
47 47  
48 -Call an external web service and send along some SOAP Headers.
84 +Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
49 49  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
50 50  
51 51  == 5. Key takeaways ==
52 52  
53 -* You can exchange data from:
54 - ** SOAP Header to Message Header
55 - ** Message Header to SOAP Header
56 -* You need the SOAP structure and the message header name to make it work
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
57 57  
58 58  == 6. Suggested Additional Readings ==
59 59  
60 -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
61 61  
62 62  == 7. Silent demonstration video ==
63 63  
64 -{{video attachment="novice-soap-webservice-connectivity-soap-headers.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.
65 65  
102 +{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
103 +
66 66  )))((({{toc/}}))){{/container}}{{/container}}