Changes for page Volume Mapping (On-premise)

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-novice-file-based-connectivity-characterset
	1	+Volume Mapping (On-premise)

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Content

...	...	@@ -1,11 +1,13 @@
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
4		-Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	3	+{{warning}}
	4	+Please note that this microlearning is for the new monitoring stack only.
	5	+{{/warning}}
5	5
6		-* Last update: May 31th, 2021
7		-* Required reading time: 7 minutes
	7	+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.
8	8
	9	+Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	10	+
9	9	== 1. Prerequisites ==
10	10
11	11	* Basic knowledge of the eMagiz platform
...	...	@@ -12,93 +12,137 @@
12	12
13	13	== 2. Key concepts ==
14	14
15		-This microlearning centers around learning how to process an incoming file per line.
	17	+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 processing per line, we mean: Splitting up the input into discernable pieces that each will become a unique message
	19	+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
	21	+There are several options for volume mapping for your on-premise machine.
	22	+* Volume
	23	+* Bind mount
	24	+* Temporary file system
	25	+* Named pipe
22	22
23		-== 3. Processing a File per Line ==
	27	+== 3. Volume Mapping (On-premise) ==
24	24
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.
	29	+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.
	31	+There are several options for volume mapping for your on-premise machine.
	32	+* Machine volume
	33	+* Bind mount
	34	+* Network volume
	35	+* Temporary file system
	36	+* Named pipe
28	28
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.
	38	+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]]
	40	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
32	32
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.
	42	+When you click this option, you will see the following pop-up. In this pop-up, you can define the machine-level, runtime-level volumes and network-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.1 Item reader Type ===
	44	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
36	36
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.
	46	+{{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]]
	48	+=== 3.1 Volume ===
40	40
41		-Based on your choice the exact configuration will differ.
	50	+The first Type available to you is Volume. With this option, you create one or more folders on Docker relevant to that runtime to read and write **persistent** data. To configure this Type, you need to link the runtime volume to a machine volume (or network volume) you can create within the same pop-up. This means you can re-use a "Machine volume" or a "Network volume" over multiple runtimes (i.e., containers).
42	42
43		-==== 3.1.1 Stax Event Item Reader ====
	52	+==== 3.1.1 Link to Machine Volume ====
44	44
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.
	54	+So, we first open the tab called "Machine volume." Then, by pressing the "New" button, we can define a new "Machine volume." In the pop-up that follows, we can specify the name of a machine volume and tell whether the Volume already exists on your docker installation or not.
46	46
47		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--stax-event-item-reader-config.png]]
	56	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
48	48
49		-==== 3.1.2 Flat File Item Reader ====
	58	+Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
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
	60	+In here, we push the "New" button to create a new "Runtime volume." In the following pop-up, we first need to select the Type we want to use. For this example, we use the Type called "Volume."
55	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).
	62	+{{info}}Based on your selection, the relevant input fields will change.{{/info}}
57	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.
	64	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
59	59
60		-For the remainder of this microlearning, we will assume that the option pass through line mapper is chosen.
	66	+The first thing we need to select is the "Machine volume." Once we have chosen our "Machine volume," we must set the Target specific for this runtime. This target defines the second part of the path to which the runtime will gain access. For example, when you fill in "/target", we can combine this with the "Machine volume" name to arrive at the correct directory from which eMagiz needs to read data (or write data to). So in our case, this would be "/file-directory/target."
61	61
62		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough.png]]
	68	+The last setting we need to configure is to define which rights we will grant our runtime on the Volume we are creating. The default setting is read/write rights for the runtime, which is sufficient in most cases. The result of following these steps will be the following.
63	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.
	70	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
65	65
66		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--flat-file-item-reader-passthrough-advanced.png]]
	72	+==== 3.1.2 Link to Network Volume ====
67	67
68		-=== 3.2 Poller ===
	74	+So, we first open the tab called "Network volume." Then, by pressing the "New" button, we can define a new "Network volume." In the pop-up that follows, we can specify the name of a machine volume and configure the relevant information for a network volume.
69	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:
	76	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
71	71
72		-- Fixed Delay Trigger
73		-- Fixed Rate Trigger
74		-- Cron Trigger
	78	+Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
75	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.
	80	+In here, we push the "New" button to create a new "Runtime volume." In the following pop-up, we first need to select the Type we want to use. For this example, we use the Type called "Volume."
77	77
78		-[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-processing-a-file-per-line--poller-config.png]]
	82	+{{info}}Based on your selection, the relevant input fields will change.{{/info}}
79	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.
	84	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
81	81
	86	+The first thing we need to select is the "Machine volume." Once we have chosen our "Machine volume," we must set the Target specific for this runtime. This target defines the second part of the path to which the runtime will gain access. For example, when you fill in "/target", we can combine this with the "Machine volume" name to arrive at the correct directory from which eMagiz needs to read data (or write data to). So in our case, this would be "/file-directory/target."
	87	+
	88	+The last setting we need to configure is to define which rights we will grant our runtime on the Volume we are creating. The default setting is read/write rights for the runtime, which is sufficient in most cases. The result of following these steps will be the following.
	89	+
	90	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
	91	+
	92	+{{warning}}Note that when you use the Volume option, the external system with which you exchange data on-premise via a file-based method needs to be able to write or read the data from the Volume (i.e., directory) you have configured in Docker. Should this be a problem, the Bind mount alternative discussed below should be considered.{{/warning}}
	93	+
	94	+=== 3.2 Bind mount ===
	95	+
	96	+An alternative option to read and write **persistent** data is to use the "Bind mount" option. In general, we advise using the "Volume" option because they have better performance, and bind mounts depend on the host machine's directory structure and OS. However, only some external systems can adapt to this that easily. For example, the "Bind mount" option can interest your use case.
	97	+
	98	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
	99	+
	100	+To configure a "Bind mount," you need to define a source and a target directory linked to each other. The source directory represents the directory on your local system (that might already be used currently to exchange files). The target directory defines a directory on your docker installation that the runtime can access.
	101	+
	102	+{{warning}}Note that when the source directory does not exist, the runtimes cannot be deployed correctly. One of the following two configurations displayed below are needed to find the source directory:
	103	+* /mnt/host/{local-directory}
	104	+* /run/desktop/mnt/host/{local-directory}{{/warning}}
	105	+
	106	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
	107	+
	108	+{{info}}Note that when you use this option, your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
	109	+
	110	+=== 3.3 Temporary file system ===
	111	+
	112	+The temporary file system option is for you if you do not want to work with **persistent** data but require **non-persistent** data. This way, you can increase the container's performance by avoiding writing into the container's writable layer.
	113	+
	114	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage.png]]
	115	+
	116	+To configure this option, you need a target location. On top of that, you can define the maximum size of the temporary file system.
	117	+
	118	+[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-temp-file-storage-filled-in.png]]
	119	+
	120	+{{warning}}We strongly advise you to define this number so that you can limit the potential impact this solution can have on the stability of your machine.{{/warning}}
	121	+
	122	+=== 3.4 Named pipe ===
	123	+
	124	+The named pipe option can be selected, but we yet have to see a valid use case within the context of eMagiz for using this option. Therefore we won't discuss this option further in this microlearning.
	125	+
82	82	== 4. Assignment ==
83	83
84		-Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
85		-This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
	128	+Navigate to Deploy -> Architecture and look at the Volume mapping options, read the help texts, and play around with the settings (if it is not a customer environment).
	129	+This assignment can be completed with the help of the (Academy) project you created/used in the previous assignment.
86	86
87	87	== 5. Key takeaways ==
88	88
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
	133	+* File-based communication on-premise changes in the new runtime architecture
	134	+* There are two ways to store **persistent** data
	135	+ ** Volume
	136	+ ** Bind mount
	137	+* The Volume option is considered the best alternative because they have better performance, and bind mounts are dependent on the directory structure and OS of the host machine
	138	+* When you want to deal with **non-persistent** data, the Temporary file storage option is the way to go.
93	93
94	94	== 6. Suggested Additional Readings ==
95	95
96		-There are no suggested additional readings on this topic
	142	+If you are interested in this topic and want more information, please read the help text provided by eMagiz.
97	97
98	98	== 7. Silent demonstration video ==
99	99
100		-This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
	146	+This video demonstrates how you could have handled the assignment and gives context to 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"/}}
	148	+TBA
103	103
104	104	)))((({{toc/}}))){{/container}}{{/container}}