Changes for page Volume Mapping (On-premise)
Last modified by Erik Bakker on 2024/08/26 12:37
From 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
To version 40.1
edited by Erik Bakker
on 2022/10/31 09:06
on 2022/10/31 09:06
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Processinga FileperLine1 +Volume Mapping (On-premise) - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,11 +1,9 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 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 3 +When you need to read and write files from an on-premise disk, you need to know the path in which the data is stored and make sure that the docker container in your runtime(s) running has access to this path. There are several ways of dealing with this challenge. First, this microlearning will discuss the various alternatives and best approaches in these scenarios. 4 + 4 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 - 9 9 == 1. Prerequisites == 10 10 11 11 * Basic knowledge of the eMagiz platform ... ... @@ -12,93 +12,99 @@ 12 12 13 13 == 2. Key concepts == 14 14 15 -This microlearning centers around learning how to proces sanincoming file perline.13 +This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise. 16 16 17 -By processingper line, we mean:Splittingupthe inputdiscernable piecesthateachwillbecomeaunique message15 +By volume mapping, we mean: Creating a configuration through which the docker container can read and write data on a specific path on an on-premise machine. 18 18 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 17 +There are several options for volume mapping for your on-premise machine. 18 +* Volume 19 +* Bind mount 20 +* Temporary file system 21 +* Named pipe 22 22 23 -== 3. Processinga FileperLine ==23 +== 3. Volume Mapping (On-premise) == 24 24 25 - In somecases, youwantto treateachuniquepartofyourinputfileasitsmessageinsteadofprocessingthecompletefile as itsmessage.Inthis microlearning,we willlearnhowyou can processa(large) fileonaper-linebasis.25 +When you need to read and write files from an on-premise disk, you need to know the path in which the data is stored and make sure that the docker container in your runtime(s) running has access to this path. There are several ways of dealing with this challenge. First, this microlearning will discuss the various alternatives and best approaches in these scenarios. 26 26 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 +There are several options for volume mapping for your on-premise machine. 28 +* Volume 29 +* Bind mount 30 +* Temporary file system 31 +* Named pipe 28 28 29 - Thefirststepwouldbetodefinethe directoryfromwhichwereadourmessages.Asalwaysreferenceto the directorywith thehelp ofaproperty.33 +Below we will explain the differences between the various options available for your volume mapping. But before we do, we first explain how to set up this configuration within eMagiz. Then, you must navigate to Deploy -> Architecture on the model level. In this overview, you can access the Volume mapping per runtime deployed on-premise. To do so, you can right-click on the runtime to access the context menu. 30 30 31 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity- processing-a-file-per-line--file-item-reader-directory.png]]35 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]] 32 32 33 - Secondly,justaswhenreadingthefile asawholeensure thatyouusea filter to retrieveonlythe correctfilesfromthedirectory.37 +When you click this option, you will see the following pop-up. In this pop-up, you can define the machine-level and runtime-level volumes. More on that later. This is the starting point for configuring your volume mapping. We will walk through each available option and explain how they work and should be configured. 34 34 35 - === 3.1Itemr Type===39 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]] 36 36 37 -No w itis time to select ourItem reader Type. Asthe helptextof the eMagiz componentsuggesttherearetwochoices with this component.The first (andmost frequentlyused) optionis the Flat file itemreader.With this option,youcan read eachline within the flat file input fileand output isata separate message. Thesecond option is called the Stax event itemreader. With thisoption,youcan readyourinput XML andoutputmessagesonaer-record basis.41 +{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping. 38 38 39 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--item-reader-type-options.png]]43 +=== 3.1 Volume === 40 40 41 - Basedon yourchoice the exact configuration will differ.45 +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 archive the files. Within the context of this flow, we need to add functionality that will ensure that each input file is archived and cleaned up when older than three days. To do so first enter "Start Editing" mode on flow level. The first decision we have to take is how we are going to name the files within the archiving. The best practice, in this case, is the original filename + the current time as a suffix. You can define this by dragging a format file name generator (support object) to the canvas. 42 42 43 - ==== 3.1.1 Stax EventItemReader====47 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-name-generator.png]] 44 44 45 - FortheStax eventitemreader,you needtodefine thename oftheelementonwhich youwantto splitthe XMLand definewhetheryouwantto throwanerror inase nosuch element existsinthe inputfile(By (de)selectingtheoptionStrict). Thedefaultsettingof eMagizis advisablefor thisoption.49 +After we have done this please add a file outbound channel adapter to the flow including an input channel. Ensure that you use a property for the directory that references another directory compared to the input directory to prevent creating an infinite loop. 46 46 47 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity- processing-a-file-per-line--stax-event-item-reader-config.png]]51 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-basic.png]] 48 48 49 - ====3.1.2FlatFile ItemReader====53 +Now that we have configured the basics let us turn our attention to the advanced configuration. In the advanced tab of this component, we need to select the file name generator to ensure that the files are named correctly. In case you process each line separately you have to choose whether to save them as separate files in the archive or by appending them again. This can be achieved by selecting the correct Mode. In most cases, however, the default Mode of Replace will suffice. 50 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 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-advanced.png]] 55 55 56 - Each of theseoptionshasomeadvantagesanddisadvantages.Adheringto thebestpracticesofeMagiz (i.e. notransformationinthe entry)thebestoptionwouldbe touse the pass-throughlinemapper.As theamesuggeststhis optiondoesnothingexceptgiveastringbackto the flowon aperlinebasis. However, choosing thisoptionmeans that the actualtransformationfromthat stringtoXMLneedsto happen laterinthe process(mostlikelyin the onramp)with thehelp ofaflat-file toXML transformer(more onthatcomponentin alatercourse).57 +The moment you are satisfied press Save. Now that we have configured this it becomes time to determine how we get the needed input to write to our archive. In the example we are using here we want to archive our input file so we need to ensure that the data we received is written to the archive as soon as possible. To do so place a wiretap on the first channel after retrieving the file. This will make sure that the message is archived before processed further. The result should be something as shown below. Note that this same piece of logic could be applied in other flows within the eMagiz platform in a similar manner. 57 57 58 - The other two options transformthe input line intoan XML output. So you winone step in the process.However, no standardeMagiz error handling is advisablewhen you start transformingdata within the entry.So in case, something goes wrong to analyze the error will becomemore difficult. Furthermore,another potential disadvantageisthat when one line fails the processingof therest of the file also halts.59 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-result.png]] 59 59 60 - Fortheremainder of this microlearning,we will assume that the optionpassthrough linemapperischosen.61 +=== 3.2 Clean up the Archive === 61 61 62 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]63 +To ensure that the data is not kept indefinitely we need to clean up the archive. We do so to prevent problems with disk space but also to prevent data leaks of old data that could impact the privacy of others. Before we can set up the logic in eMagiz we need to talk to the customer to see what an acceptable term is within which the data is kept. In most cases, this is a week or two weeks. In this example, we have chosen three days. 63 63 64 - As youcan see onthe Basiclevelweare done. However,it isalwaysgoodto checkoutthesettingsontheAdvancedtab,especiallyinthiscase,toeif thereareadditionalconfigurationoptionsthatcouldbenefitus.Thesetting ofmost interest,inthiscase,istheLinesto Skipsetting (defaultsettingis 0). Withthissetting, youcanefinewhethernot youwantto processtheheader line(s)that existswithin your input file.The remainder ofthesettings is (in mostcases) goodhewayeMagiz hasset them up.65 +Now that we know the limit it is time to configure the components. We start with a composite file filter (support object). Within this filter, we at least define how old a file must be before it can be deleted (in milliseconds). If we turn three days into milliseconds we get 259200000. Furthermore, we at least define that we only want to delete regular files. 65 65 66 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity- processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]67 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-list-filter-for-archive-cleanup.png]] 67 67 68 - ===3.2Poller===69 +Having done so we can add a file inbound channel adapter to the canvas including an output channel. Ensure that the property reference for the directory matches the one you have used before in the outbound channel adapter. Furthermore link the filter to the component and define the poller according to the best practice. 69 69 70 - Now that wehave selected and configured theitemreadertypeit becomes timetofill in thelast part of thefiguration,the poller. For pollingMagizoffers threeoptions:71 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup.png]] 71 71 72 -- Fixed Delay Trigger 73 -- Fixed Rate Trigger 74 -- Cron Trigger 73 +One thing we should not forget within this configuration is to set the Max messages per poll on the Advanced tab of the poller-configuration to a sufficiently high number (i.e. 50). If you forget to do so and you only check once a day it will mean that only one message will be deleted that day. 75 75 76 - Of these options, then triggeris used most frequentlyineMagiz.Thereasonbeing is that youcan definethisptionvia a propertythat youcanalter without having toaltertheflow versionin Create.75 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup-max-messages-per-poll.png]] 77 77 78 - [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--poller-config.png]]77 +Now eMagiz will check on a set time interval whether there are files that are older than three days that are ready for deletion. One last step to go. This last step will ensure that all files that fit the bill will be deleted from the archive. Simply add a standard service activator to the canvas and define the following SPeL expression within the component: payload.delete(). 79 79 80 - After finishingall theseconfigurationsteps wecan press Savetosave our work and ensurehatwe can process theinput fileonaer-linebasis.79 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archive-cleanup-deletion.png]] 81 81 81 +This will ensure that each file that is retrieved will indeed be deleted from the archive. 82 + 82 82 == 4. Assignment == 83 83 84 -Configure an entry in which you definethecomponentandconfiguration neededtoprocessafileona per-linebasis.85 +Configure an entry in which you build the archiving and the clean up of the archiving. 85 85 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 86 86 87 87 == 5. Key takeaways == 88 88 89 -* Easy way ofreadinga fileline by line andsendingit toeMagiz(Low on memory)90 -* A bility to process eachlinebasedon distinctivelogicthatisrelevant on line level91 -* Canbe usedforflatfileswellasXMLinputfiles92 -* Trytoavoidcomplex transformationswithin theentry90 +* Archiving is used for audit purposes 91 +* Archiving is used for retry scenarios 92 +* Ensure that data is cleaned after a retention period to keep in control of the data 93 +* Don't forget the max messages per poll 93 93 94 94 == 6. Suggested Additional Readings == 95 95 96 - Thereare no suggested additional readingson thistopic97 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz and check out the following store content: 97 97 99 +* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]] 100 +* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]] 101 + 98 98 == 7. Silent demonstration video == 99 99 100 100 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. 101 101 102 -{{video attachment="novice-file-based-connectivity- processing-a-file-per-line.mp4" reference="Main.Videos.Microlearning.WebHome"/}}106 +{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 103 103 104 104 )))((({{toc/}}))){{/container}}{{/container}}