Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:37
From version 40.1
edited by Erik Bakker
on 2022/10/31 09:06
Change comment: There is no comment for this version
To version 37.2
edited by Erik Bakker
on 2022/10/31 08:29
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Volume Mapping (On-premise)
1 +novice-file-based-connectivity-volume-mapping-on-premise
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,7 +1,6 @@
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.
2 2  
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 -
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 7  == 1. Prerequisites ==
... ... @@ -10,38 +10,20 @@
10 10  
11 11  == 2. Key concepts ==
12 12  
13 -This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise.
12 +This microlearning centers around learning how to archive correctly.
14 14  
15 -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.
14 +By archiving, we mean: Temporarily storing data for audit purposes and possible retry scenarios.
16 16  
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
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
22 22  
23 -== 3. Volume Mapping (On-premise) ==
20 +== 3. Archiving ==
24 24  
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.
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.
26 26  
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
24 +=== 3.1 Archiving itself ===
32 32  
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.
34 -
35 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
36 -
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.
38 -
39 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
40 -
41 -{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.
42 -
43 -=== 3.1 Volume ===
44 -
45 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.
46 46  
47 47  [[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-archiving--file-name-generator.png]]