Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:37
From version 37.1
edited by Erik Bakker
on 2022/08/22 14:24
Change comment: There is no comment for this version
To version 54.1
edited by Erik Bakker
on 2023/04/11 12:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Archiving
1 +Volume Mapping (On-premise)
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,6 +1,11 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In most cases, the customer wants some kind of insurance policy to determine whether a file has entered or left eMagiz. One way of supplying such functionality for file-based data exchange is through the use of archiving functionality. With the help of this functionality can you easily write the file as received (or about to be sent) to a separate location. By ensuring that the data stays in that location for a certain amount of time and by giving the customer and yourself access you have a sort of audit trail that details the messages that have been exchanged. This archive could also be used to analyze problems in case things go wrong. In this microlearning, we will learn how you can set up that archiving and learn how to clean up the archiving to ensure that data is only kept for a limited period.
3 3  
3 +{{warning}}
4 +Please note that this microlearning is for the new monitoring stack only.
5 +{{/warning}}
6 +
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 +
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 6  == 1. Prerequisites ==
... ... @@ -9,81 +9,137 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning centers around learning how to archive correctly.
17 +This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise.
13 13  
14 -By archiving, we mean: Temporarily storing data for audit purposes and possible retry scenarios.
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.
15 15  
16 -* Archiving is used for audit purposes
17 -* Archiving is used for retry scenarios
18 -* Ensure that data is cleaned after a retention period to keep in control of the data
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
19 19  
20 -== 3. Archiving ==
27 +== 3. Volume Mapping (On-premise) ==
21 21  
22 -In most cases, the customer wants some kind of insurance policy to determine whether a file has entered or left eMagiz. One way of supplying such functionality for file-based data exchange is through the use of archiving functionality. With the help of this functionality can you easily write the file as received (or about to be sent) to a separate location. By ensuring that the data stays in that location for a certain amount of time and by giving the customer and yourself access you have a sort of audit trail that details the messages that have been exchanged. This archive could also be used to analyze problems in case things go wrong. In this microlearning, we will learn how you can set up that archiving and learn how to clean up the archiving to ensure that data is only kept for a limited period.
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.
23 23  
24 -=== 3.1 Archiving itself ===
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
25 25  
26 -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.
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.
27 27  
28 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-name-generator.png]]
40 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
29 29  
30 -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.
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.
31 31  
32 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-basic.png]]
44 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
33 33  
34 -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.
46 +{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
35 35  
36 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-config-file-outbound-advanced.png]]
48 +=== 3.1 Volume ===
37 37  
38 -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.
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).
39 39  
40 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archiving-result.png]]
52 +==== 3.1.1 Link to Machine Volume ====
41 41  
42 -=== 3.2 Clean up the Archive ===
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.
43 43  
44 -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.
56 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
45 45  
46 -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.
58 +Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
47 47  
48 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-list-filter-for-archive-cleanup.png]]
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."
49 49  
50 -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.
62 +{{info}}Based on your selection, the relevant input fields will change.{{/info}}
51 51  
52 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup.png]]
64 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
53 53  
54 -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.
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."
55 55  
56 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-inbound-archive-cleanup-max-messages-per-poll.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.
57 57  
58 -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().
70 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
59 59  
60 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--archive-cleanup-deletion.png]]
72 +==== 3.1.2 Link to Network Volume ====
61 61  
62 -This will ensure that each file that is retrieved will indeed be deleted from the archive.
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.
63 63  
76 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--network-volumes-configuration.png]]
77 +
78 +Once you have done so, we press "Save" and switch back to the "Runtime volumes" tab.
79 +
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."
81 +
82 +{{info}}Based on your selection, the relevant input fields will change.{{/info}}
83 +
84 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
85 +
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 +
64 64  == 4. Assignment ==
65 65  
66 -Configure an entry in which you build the archiving and the clean up of the archiving.
67 -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.
68 68  
69 69  == 5. Key takeaways ==
70 70  
71 -* Archiving is used for audit purposes
72 -* Archiving is used for retry scenarios
73 -* Ensure that data is cleaned after a retention period to keep in control of the data
74 -* Don't forget the max messages per poll
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.
75 75  
76 76  == 6. Suggested Additional Readings ==
77 77  
78 -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:
142 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
79 79  
80 -* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]]
81 -* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]]
82 -
83 83  == 7. Silent demonstration video ==
84 84  
85 -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.
86 86  
87 -{{video attachment="novice-file-based-connectivity-characterset.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
148 +TBA
88 88  
89 89  )))((({{toc/}}))){{/container}}{{/container}}