Changes for page Volume Mapping (On-premise)

Last modified by Erik Bakker on 2024/08/26 12:37

From 32.2 to 32.1 From 47.1 to 46.1

From version 46.1

edited by Erik Bakker
on 2022/10/31 11:27

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.

Raw
Rendered

Summary

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

Details

Page properties

Title

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

Default language

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

Content

@@ -1,9 +1,11 @@
  {{container}}{{container layoutStyle="columns"}}(((
++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.
--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.
--
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
++* Last update: May 31th, 2021
++* Required reading time: 7 minutes
++
  == 1. Prerequisites ==
  * Basic knowledge of the eMagiz platform
@@ -10,94 +10,51 @@
  == 2. Key concepts ==
--This microlearning centers around learning how to set up your volume mapping correctly so you can exchange file-based data on-premise.
++This microlearning centers around learning how to define the character set to ensure that eMagiz processes the information correctly.
--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.
++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.
--There are several options for volume mapping for your on-premise machine.
--* Volume
--* Bind mount
--* Temporary file system
--* Named pipe
++* Some external system talk in a different character set
++* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
++* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
--== 3. Volume Mapping (On-premise) ==
++== 3. Character set ==
--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.
++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.
--There are several options for volume mapping for your on-premise machine.
--* Volume
--* Bind mount
--* Temporary file system
--* Named pipe
++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:
--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.
++- File to string transformer
++- Flat file to XML transformer
++- File outbound channel adapter
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-option-context-menu.png]]
++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.
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-characterset--characterset-configuration.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--volume-mapping-pop-up.png]]
++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.
--{{info}}Note that you should be in "Start editing" mode to make any changes to the configuration of your volume mapping.{{/info}}
++Congratulations you have successfully learned how to specify the character set.
--=== 3.1 Volume ===
--
--The first type available to you is Volume. With this option you create one or more folders on docker that is relevant for that runtime to read and/or write **persistent** data. To configure this type you need to link the runtime volume to a machine volume that you can create within the same pop-up. This means that you can re-use a "Machine volume" over multiple runtimes (i.e. containers).
--
--So, at first we open the tab called "Machine volume". By pressing the "New" button we can define a new "Machine volume". In the pop-up that follows we can define the name of a machine volume and tell whether the volume already exists on your docker installation or not.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--machine-volumes-configuration.png]]
--
--Once you have done so we press "Save" and switch back to the "Runtime volumes" tab. In here we press the "New" button to create a new "Runtime volume". In the pop-up that follows we first need to select the Type we want to use. For this example we use the type called "Volume". Based on your selection the relevant input fields will change.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume.png]]
--
--The first thing we need to select is the "Machine volume". Once we have selected our "Machine volume" we need to select the Target that is 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."
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-volume-filled-in.png]]
--
--{{warning}}Note, that when you use the Volume option the external system with which you exchange data on-premise via a file based method need 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}}
--
--=== 3.2 Bind mount ===
--
--An alternative option to read and write **persistent** data is to use the "Bind mount" option avaiable. In general we advice to use the "Volume" option because they have better performance and bind mounts are dependent on the directory structure and OS of the host machine. Having said that not all external systems can adapt to this that easily. That is why the "Bind mount" option can be of interest in your use case.
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount.png]]
--
--To configure a "Bind mount" you need to define a source and a target directory that are linked to each other. The source directory defines the directory on your local system (that might already be in use currently to exchange files). The target directory defines a directory on your docker installation that can be accessed by the runtime.
--
--{{warning}}Note, that when the source directory does not exists the runtimes cannot be deployed correctly.{{/warning}}
--
--[[image:Main.Images.Microlearning.WebHome@novice-file-based-connectivity-volume-mapping-on-premise--runtime-volumes-configuration-type-bind-mount-filled-in.png]]
--
--{{info}}Note, that when you use this option your directory reference in your flow should refer to the "target" directory configured here.{{/info}}
--
--=== 3.3 Temporary file system ===
--
--=== 3.4 Named pipe ===
--
--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.
--
  == 4. Assignment ==
--Configure an entry in which you build the archiving and the clean up of the archiving.
++Configure an entry in which you define the component and configuration needed to process a file on a per-line basis.
  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* Archiving is used for audit purposes
--* Archiving is used for retry scenarios
--* Ensure that data is cleaned after a retention period to keep in control of the data
--* Don't forget the max messages per poll
++* Some external system talk in a different character set
++* eMagiz talks in default UTF-8 as a character set and assumes everyone else also does this
++* In cases of mismatch correct is at the point where you talk with the other system (i.e. entry or exit)
++* eMagiz provides several components within which you can define the character set
  == 6. Suggested Additional Readings ==
--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:
++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:
--* [[File Archiving>>doc:Main.eMagiz Store.Accelerators.File Archiving.WebHome||target="blank"]]
--* [[Delete Folder(s)>>doc:Main.eMagiz Store.Accelerators.Delete Folder(s).WebHome||target="blank"]]
++* https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html
++* https://www.techopedia.com/definition/941/character-set
++* https://www.smashingmagazine.com/2012/06/all-about-unicode-utf8-character-sets/
  == 7. Silent demonstration video ==

Changes for page Volume Mapping (On-premise)

Summary

Details

Navigation