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 42.1
edited by Erik Bakker
on 2022/10/31 09:08
on 2022/10/31 09:08
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,67 @@ 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.{{/info}} 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 - Basedonyour choicethe exact configurationwill differ.45 +=== 3.2 Bind mount === 42 42 43 -=== =3.1.1StaxEventItemReader====47 +=== 3.3 Temporary file system === 44 44 45 - FortheStax event itemreader,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.49 +=== 3.4 Named pipe === 46 46 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 - 82 82 == 4. Assignment == 83 83 84 -Configure an entry in which you definethecomponentandconfiguration neededtoprocessafileona per-linebasis.53 +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 theentry58 +* Archiving is used for audit purposes 59 +* Archiving is used for retry scenarios 60 +* Ensure that data is cleaned after a retention period to keep in control of the data 61 +* Don't forget the max messages per poll 93 93 94 94 == 6. Suggested Additional Readings == 95 95 96 - Thereare no suggested additional readingson thistopic65 +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 67 +* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]] 68 +* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]] 69 + 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"/}}74 +{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}} 103 103 104 104 )))((({{toc/}}))){{/container}}{{/container}}