Changes for page Configure your SOAP web service
Last modified by Erik Bakker on 2024/08/26 12:38
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 29.1
edited by Erik Bakker
on 2022/06/10 13:22
on 2022/06/10 13:22
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Headerline1 +Processing a File per Line - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In thismicrolearning, wewilllearnhowyoucandefine aheaderlinein which youspecifythenamingofthevariouscolumns.Somexternalsystemsrequireheaderline when yousupplythemwith datavia a flatfilethatisplacedsomewhere.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 4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 ... ... @@ -12,50 +12,84 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around learning how to p lace aheader lineonaflat-fileoutput.15 +This microlearning centers around learning how to process an incoming file per line. 16 16 17 -By header line we mean:Alinein theoutput thatdefines thenamingof thevariouscolumns17 +By processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message 18 18 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. 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 20 20 21 -== 3. Headerline ==23 +== 3. Processing a File per Line == 22 22 23 -In thismicrolearning,we will learn howyoucandefineaheaderlineinwhichyouspecifythenaming ofthevariouscolumns.Someexternalsystemsrequireheaderlinewhenyou supplythemwith data via aflat filethatisplacedsomewhere.The header lineisthe firstlinetheflatfileoutput. Withinthisline, the variouscolumnnames arespecifiedforclarity.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. 24 24 25 -To a ddsucha headerlineineMagiz you need to navigate to the Create phase of eMagiz and open the exit flow in which you want todropthe file to a certain location. Within the context of this flow, we need to add functionality that will ensure thata headerline iswrittentotheoutput beforeanyfunctionallinesreadded. To do so first enter "Start Editing" mode on flow level. After you have done so please add a fileoutboundchanneladapter to the flowincluding an input channel. We will use this component towriteour headerlinetotheflat file output.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. 26 26 27 - Ensure thatthe directoryto whichyou referenceisthesame asin yourfunctionalfileoutboundchannel adapter.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. 28 28 29 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity- header-line--file-outbound-channel-header-line.png]]31 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--file-item-reader-directory.png]] 30 30 31 - Nowitistimeto turnourattention to theAdvancedtab.Forthe Mode selectIgnore. Select this optionto ensure thattheheaderline is only writtendownonce when thereis no output createdyet and not somewhere inthe middle,intheend,orevery time. Furthermore, selectthe option Append New Line to ensurethat theremainderofthe information is not appendedtothe same line.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. 32 32 33 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--file-outbound-channel-header-line-advanced.png]]35 +=== 3.1 Item reader Type === 34 34 35 - Afteryouhavedoneso weneedto addastandardtransformerthatdefinesthevariouscolumnamesobewrittentotheflatfileoutput. To do so add the standardtransformercomponenttothecanvasincludinganinputchannel.Afteryouhave donesodefine therelevantSpELexpression.In thiscase, weadviseusinga propertyvalue thatrepresentsa stringofcolumnnames. The value oftheproperty should besomething asfollows: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. 36 36 37 - 'Header1;Header2;Header3;Header4'39 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]] 38 38 39 - Do note that theseparator,inthis case, needs tomatchthe requirementsofthe external system.At the flowconfiguration level,the standard transformershould look as follows.41 +Based on your choice the exact configuration will differ. 40 40 41 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-header-line--define-columns-names.png]]43 +==== 3.1.1 Stax Event Item Reader ==== 42 42 43 - Ourlaststepistoensurehatthis pieceof logic is tiedto themain flowand isexecutedbeforewritingthefunctional line(s)to theoutput file. Tomakehathappen weneed toadd awiretaptothe flow.Withthehelpof this functionality, you can define whichpartofthelogictakes precedenceoveranotherpartofthe logic.Todoso doubleclickon thechannel on which you wantto placeawiretap,select the optionwiretap and selectthecorrectwiretap channel.Afteryouhavedonethisthe result should be something as follows: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. 44 44 45 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity- header-line--wiretap-result.png]]47 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]] 46 46 47 - Withthesecouple of steps, you have now successfully added logictoyour flow that willensurethat a headerlineisadded beforeany functional line(s) are written to the output file.49 +==== 3.1.2 Flat File Item Reader ==== 48 48 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 + 49 49 == 4. Assignment == 50 50 51 -Configure an e xit in which you defineand write aheaderlineoa flat-fileoutputbefore addingfunctionallines.84 +Configure an entry in which you define the component and configuration needed to process a file on a per-line basis. 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 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 59 59 60 60 == 6. Suggested Additional Readings == 61 61 ... ... @@ -65,6 +65,6 @@ 65 65 66 66 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 67 67 68 -{{video attachment="novice-file-based-connectivity- header-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}102 +{{video attachment="novice-file-based-connectivity-processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 69 69 70 70 )))((({{toc/}}))){{/container}}{{/container}}