Skip to Content

Changes for page Pick up Files

Last modified by Danniar Firdausy on 2024/08/21 16:48
From version 22.5
edited by Danniar Firdausy
on 2024/08/20 15:55
Change comment: There is no comment for this version
To version 15.1
edited by eMagiz
on 2022/05/10 11:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -Pick up Files
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.marijn
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,8 +1,20 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
1 +{{html wiki="true"}}
2 +<div class="ez-academy">
3 + <div class="ez-academy_body">
4 +
5 +<div class="doc">
6 +
7 +
8 +
9 += Pick up Files =
10 +
2 2  In this microlearning, we will explain the basics of retrieving files from a local directory (i.e. a directory that is directly accessible within the network where the eMagiz process is running)
3 3  
4 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
13 +Should you have any questions, please contact academy@emagiz.com.
5 5  
15 +* Last update: February 25th, 2021
16 +* Required reading time: 8 minutes
17 +
6 6  == 1. Prerequisites ==
7 7  
8 8  * Basic knowledge of the eMagiz platform
... ... @@ -20,6 +20,8 @@
20 20  * Has eMagiz the appropriate rights to read from the directory where the messages are to be retrieved from
21 21  * What is the format (i.e. XML, JSON, EDI, TXT, CSV, etc.) of the files that eMagiz needs to retrieve
22 22  
35 +
36 +
23 23  == 3. Pick up Files ==
24 24  
25 25  One of the easiest connectivity methods to implement within eMagiz is the retrieval of files from a local directory.
... ... @@ -34,7 +34,7 @@
34 34  
35 35  By default, eMagiz has a filter that will only accept each file once. This option is called prevent duplicates
36 36  
37 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--prevent-duplicates.png]]
51 +<p align="center">[[image:crashcourse-messaging-pick-up-files--prevent-duplicates.png||]]</p>
38 38  
39 39  As the eMagiz help text clearly states this option will ensure that eMagiz will keep a list in memory and files are only to be passed once.
40 40  This check is done before any other filtering is done. So be aware when mixing these settings.
... ... @@ -50,7 +50,7 @@
50 50  
51 51  To filter which messages need to be retrieved from a local directory we use a composite file list filter.
52 52  
53 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--composite-file-list-filter-component.png]]
67 +<p align="center">[[image:crashcourse-messaging-pick-up-files--composite-file-list-filter-component.png||]]</p>
54 54  
55 55  In this filter, we use the following four criteria to filter our messages:
56 56  
... ... @@ -61,12 +61,12 @@
61 61  
62 62  The result of this configuration should be:
63 63  
64 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--composite-file-list-filter.png]]
78 +<p align="center">[[image:crashcourse-messaging-pick-up-files--composite-file-list-filter.png||]]</p>
65 65  
66 66  The next step would be to link this support object to the file inbound channel adapter (the starting point of our flow). To do so open the component and navigate to the Advanced tab.
67 67  Here you need to select the correct filter to reference your support object.
68 68  
69 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--composite-file-list-filter-linked.png]]
83 +<p align="center">[[image:crashcourse-messaging-pick-up-files--composite-file-list-filter-linked.png||]]</p>
70 70  
71 71  === 3.2 Frequency ===
72 72  
... ... @@ -79,7 +79,7 @@
79 79  * Fixed-Rate
80 80  * Cron Trigger
81 81  
82 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--frequency-options.png]]
96 +<p align="center">[[image:crashcourse-messaging-pick-up-files--frequency-options.png||]]</p>
83 83  
84 84  Both the Fixed Delay and the Fixed Rate are static. This means that when you want to change the frequency with which you look you will have to make a new version of the flow.
85 85  
... ... @@ -102,24 +102,32 @@
102 102  Files come in many different forms, shapes, and sizes. Due to the wide variety of options, you will need to ensure that the data is processed correctly.
103 103  How to process each message format (i.e. XML, JSON, EDI, CSV, etc.) correctly is explained in other microlearnings where we zoom in on each of the message formats.
104 104  
105 -For learning about picking up files we need to know that in order for eMagiz to process the content of the file in the onramp and further downstream the contents of the file need to be transformed to string.
119 +For learning about picking up files we need to know that in other for eMagiz to
120 +process the content of the file in the onramp and further downstream the contents of the file need to be transformed to string.
106 106  
107 107  There is a component in eMagiz called the file to string transformer. You should place this directly after receiving the file from the external source
108 108  
109 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--file-to-string-component.png]]
124 +<p align="center">[[image:crashcourse-messaging-pick-up-files--file-to-string-component.png||]]</p>
110 110  
111 111  Configuration wise you need to select the option Delete files to ensure that the files are deleted
112 112  
113 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--file-to-string-configuration.png]]
128 +<p align="center">[[image:crashcourse-messaging-pick-up-files--file-to-string-configuration.png||]]</p>
114 114  
115 115  The result of linking the components together will lead to the following solution
116 116  
117 -[[image:Main.Images.Microlearning.WebHome@crashcourse-messaging-pick-up-files--simple-solution.png]]
132 +<p align="center">[[image:crashcourse-messaging-pick-up-files--simple-solution.png||]]</p>
118 118  
119 119  With all this in mind, you have successfully learned how to set up your first connectivity via a messaging flow in eMagiz!
120 120  
121 -== 4. Key takeaways ==
136 +===== Practice =====
122 122  
138 +== 4. Assignment ==
139 +
140 +Build an entry that retrieves files from an external source and ensures that the data is delivered on the onramp queue.
141 +This assignment can be completed with the help of your (Academy) project you have created/used in the previous assignment.
142 +
143 +== 5. Key takeaways ==
144 +
123 123  * Key considerations when picking up files are:
124 124   * What are the determining criteria to define when a file is "ready" to be picked up (age, pattern, size, etc.)
125 125   * With what frequency is eMagiz going to check for new files
... ... @@ -126,12 +126,20 @@
126 126   * Has eMagiz the appropriate rights to read from the directory where the messages are to be retrieved from
127 127   * What is the format (i.e. XML, JSON, EDI, TXT, CSV, etc.) of the files that eMagiz needs to retrieve
128 128  
129 -== 5. Suggested Additional Readings ==
130 130  
131 -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 link:
132 132  
133 -* [[Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
134 -** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
135 -*** [[File Inbound (Store Item)>>doc:Main.eMagiz Store.Accelerators.File Inbound.WebHome||target="blank"]]
136 -* [[Pick up Files (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22pick+up+files%22||target="blank"]]
137 -)))((({{toc/}}))){{/container}}{{/container}}
153 +== 6. Suggested Additional Readings ==
154 +
155 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
156 +
157 +== 7. Silent demonstration video ==
158 +
159 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
160 +
161 +<iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-messaging-pick-up-files.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
162 +
163 +</div>
164 +</div>
165 +</div>
166 +
167 +{{/html}}