Skip to Content

Changes for page Pick up Files

Last modified by Danniar Firdausy on 2024/08/21 16:48
From version 17.1
edited by Erik Bakker
on 2022/06/10 08:38
Change comment: Imported from XAR
To version 23.1
edited by Danniar Firdausy
on 2024/08/21 16:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Pick up Files
Parent
... ... @@ -1,0 +1,1 @@
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,13 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -= Pick up Files =
2 +In this microlearning, we will explain the basics of retrieving files from a local directory using eMagiz. We will cover the essentials for setting up file retrieval from a directory that is directly accessible within the network where the eMagiz process is running. We will walk you through key concepts, considerations, and best practices to ensure a smooth file handling process.
3 3  
4 -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)
4 +If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 -
8 -* Last update: February 25th, 2021
9 -* Required reading time: 8 minutes
10 -
11 11  == 1. Prerequisites ==
12 12  
13 13  * Basic knowledge of the eMagiz platform
... ... @@ -15,18 +15,9 @@
15 15  == 2. Key concepts ==
16 16  
17 17  This microlearning centers around retrieving files from a local directory via eMagiz.
18 -By retrieving we mean: Checking with a certain interval if new files are ready to be pulled from the directory by emagiz
19 -By local directory we mean: A directory that is directly accessible within the network where the eMagiz process is running
13 +* With retrieving we mean: Checking with a certain interval if new files are ready to be pulled from the directory by emagiz
14 +* With local directory we mean: A directory that is directly accessible within the network where the eMagiz process is running
20 20  
21 -Key considerations when picking up files are:
22 -
23 -* What are the determining criteria to define when a file is "ready" to be picked up (age, pattern, size, etc.)
24 -* With what frequency is eMagiz going to check for new files
25 -* Has eMagiz the appropriate rights to read from the directory where the messages are to be retrieved from
26 -* What is the format (i.e. XML, JSON, EDI, TXT, CSV, etc.) of the files that eMagiz needs to retrieve
27 -
28 -
29 -
30 30  == 3. Pick up Files ==
31 31  
32 32  One of the easiest connectivity methods to implement within eMagiz is the retrieval of files from a local directory.
... ... @@ -109,8 +109,7 @@
109 109  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.
110 110  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.
111 111  
112 -For learning about picking up files we need to know that in other for eMagiz to
113 -process the content of the file in the onramp and further downstream the contents of the file need to be transformed to string.
98 +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.
114 114  
115 115  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
116 116  
... ... @@ -126,31 +126,19 @@
126 126  
127 127  With all this in mind, you have successfully learned how to set up your first connectivity via a messaging flow in eMagiz!
128 128  
114 +== 4. Key takeaways ==
129 129  
116 +* Criteria for File Retrieval: Determine the criteria for identifying when a file is "ready" to be picked up, such as age, pattern, or size. Ensure these criteria are properly configured to avoid issues with file processing.
117 +* File Formats: Ensure you handle various file formats (e.g., XML, JSON, EDI, CSV) correctly. Use the file to string transformer to process file contents as needed.
118 +* Check Frequency: Decide how frequently eMagiz will check the local directory for new files. You can choose between options like Fixed Delay, Fixed Rate, or Cron Trigger, based on your needs and expected changes in frequency.
119 +* Access Rights: Verify that eMagiz has the necessary permissions to read from the directory and any parent directories. Proper access rights are crucial for successful file retrieval.
130 130  
131 -== 4. Assignment ==
121 +== 5. Suggested Additional Readings ==
132 132  
133 -Build an entry that retrieves files from an external source and ensures that the data is delivered on the onramp queue.
134 -This assignment can be completed with the help of your (Academy) project you have created/used in the previous assignment.
123 +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:
135 135  
136 -== 5. Key takeaways ==
137 -
138 -* Key considerations when picking up files are:
139 - * What are the determining criteria to define when a file is "ready" to be picked up (age, pattern, size, etc.)
140 - * With what frequency is eMagiz going to check for new files
141 - * Has eMagiz the appropriate rights to read from the directory where the messages are to be retrieved from
142 - * What is the format (i.e. XML, JSON, EDI, TXT, CSV, etc.) of the files that eMagiz needs to retrieve
143 -
144 -
145 -
146 -== 6. Suggested Additional Readings ==
147 -
148 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
149 -
150 -== 7. Silent demonstration video ==
151 -
152 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
153 -
154 -{{video attachment="crashcourse-messaging-pick-up-files.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
155 -
125 +* [[Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
126 +** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
127 +*** [[File Inbound (Store Item)>>doc:Main.eMagiz Store.Accelerators.File Inbound.WebHome||target="blank"]]
128 +* [[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"]]
156 156  )))((({{toc/}}))){{/container}}{{/container}}