Skip to Content
Last modified by Erik Bakker on 2024/08/26 12:37
From version 42.1
edited by Erik Bakker
on 2022/10/31 09:08
Change comment: There is no comment for this version
To version 32.2
edited by Erik Bakker
on 2022/06/10 13:32
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-archiving
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,9 +1,11 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 +n some cases, the input you receive or the output that you need to send to an external party cannot handle all characters or the input or output is written with the help of a character set. In this microlearning, we will learn how you can define the character set for file-based connectivity to ensure that you can process and deliver files according to the specifications.
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  
6 +* Last update: May 31th, 2021
7 +* Required reading time: 7 minutes
8 +
7 7  == 1. Prerequisites ==
8 8  
9 9  * Basic knowledge of the eMagiz platform
... ... @@ -10,62 +10,51 @@
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.
15 +This microlearning centers around learning how to define the character set to ensure that eMagiz processes the information 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.
17 +By character set, we mean: The composite number of different characters that are being used and supported by computer software and hardware. It consists of codes, bit patterns, or natural numbers used in defining some particular character.
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
19 +* Some external system talk in a different character set
20 +* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
21 +* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
22 22  
23 -== 3. Volume Mapping (On-premise) ==
23 +== 3. Character set ==
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.
25 +In some cases, the input you receive or the output that you need to send to an external party cannot handle all characters or the input or output is written with the help of a character set. In this microlearning, we will learn how you can define the character set for file-based connectivity to ensure that you can process and deliver files according to the specifications.
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
27 +Sometimes external systems only talk in a specific character set. To ensure that all the data is properly communicated between eMagiz and the other system we need to make sure that we define which character set that is so we can tell it to eMagiz via a component. That way eMagiz will deviate from its default (i.e. UTF-8) and will process the file according to that different character set. In practice, we mainly see windows-1252 as an alternative that pops up once in a while. In various components that deal with file handling, you can define the character set on which eMagiz should act. Examples of such components are:
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.
29 +- File to string transformer
30 +- Flat file to XML transformer
31 +- File outbound channel adapter
34 34  
35 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
33 +In all these components you have the option to define the character set within the Advanced tab of the component. In this microlearning, we will use the File to string transformer to illustrate how that will look.
36 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.
35 +[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-characterset--characterset-configuration.png]]
38 38  
39 -[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
37 +In this field, you can define the character set of your choice. 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 the correct character set is used. To do so first enter "Start Editing" mode on flow level. After that open, the File to string transformer, navigate to the Advanced tab, and fill in the correct character set. After you have defined the correct character set the only thing left to do is to Save the component. See the suggested additional readings section on the complete list of character sets that are supported by Java 8.
40 40  
41 -{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
39 +Congratulations you have successfully learned how to specify the character set.
42 42  
43 -=== 3.1 Volume ===
44 -
45 -=== 3.2 Bind mount ===
46 -
47 -=== 3.3 Temporary file system ===
48 -
49 -=== 3.4 Named pipe ===
50 -
51 51  == 4. Assignment ==
52 52  
53 -Configure an entry in which you build the archiving and the clean up of the archiving.
43 +Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
54 54  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
55 55  
56 56  == 5. Key takeaways ==
57 57  
58 -* 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
48 +* Some external system talk in a different character set
49 +* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
50 +* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
51 +* eMagiz provides several components within which you can define the character set
62 62  
63 63  == 6. Suggested Additional Readings ==
64 64  
65 -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:
55 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
66 66  
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"]]
57 +* https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html
58 +* https://www.techopedia.com/definition/941/character-set
59 +* https://www.smashingmagazine.com/2012/06/all-about-unicode-utf8-character-sets/
69 69  
70 70  == 7. Silent demonstration video ==
71 71