Skip to Content
Last modified by Danniar Firdausy on 2024/09/18 20:30
From version 15.1
edited by eMagiz
on 2022/06/03 13:28
Change comment: There is no comment for this version
To version 2.1
edited by eMagiz
on 2022/06/02 12:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,64 +1,95 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
4 -= How to connect with the eMagiz SFTP Service =
1 +{{html wiki="true"}}
2 +<div class="ez-academy">
3 + <div class="ez-academy_body">
5 5  
6 -In this microlearning, we will provide short guide that will help eMagiz users how to connect to the eMagiz SFTP service. Allthough this is a regular SFTP service, there are some specific steps involved to allow an optimal configuration of the integration.
7 -
5 +<div class="doc">
6 +
7 +
8 +
9 += Determining the origin of log entries =
10 +
11 +In this microlearning, we will focus on how you can quickly and easily determine the origin of log entries. In other words, what caused the logging.
12 +
8 8  Should you have any questions, please contact academy@emagiz.com.
9 9  
10 -* Last update: June 2nd, 2022
15 +* Last update: July 22th, 2021
11 11  * Required reading time: 5 minutes
12 12  
13 13  == 1. Prerequisites ==
14 14  
15 15  * Basic knowledge of the eMagiz platform
16 -* Understanding of the way in which an SFTP file pickup or drop is configured in eMagiz
17 -* Reviewed microlearning :: TO ADD
21 +* Understanding of Monitoring concept
22 +* One or more log entries raised in the last two weeks within the context of your (Academy) project
18 18  
19 -[[Test link>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.eMagiz SFTP Connectivity.WebHome]]
20 -
21 -
22 22  == 2. Key concepts ==
23 -By the eMagiz SFTP, we mean: A specific SFTP offered by the eMagiz platform on which you can securely store and read messages. Considerations when connecting to the eMagiz SFTP
24 24  
25 -* Did you read the connect guide and made sure that all requirements are met?
26 -* Did you use the store component made available in the eMagiz store to set up the connection?
27 -* Did you verify that the indicator for temporary file name is set to false?
26 +This microlearning centers around determining the origin of log entries.
27 +By origin, in this context, we mean: Identifying which flow wrote an entry to the log that might be in need of analysis.
28 28  
29 +* Determining in which flow a log entry is raised can be done with the help of the Manage phase in eMagiz.
30 + * In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant without your project.
31 +* This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
32 +* Double-clicking on a log entry provides you with the relevant details
33 +* Note that log entries are not shown in full when they exceed a certain size so takes this into account when logging
34 +* When you know the flow and the details you have determined the origin of the log entry
29 29  
30 -== 3. How to steps ==
31 31  
32 -=== 3.1 Obtain an SFTP User account ===
33 -Make sure to get the access credentials from eMagiz Support. Ensure to obtain access credentials for all connected systems/applications that need to send or received files from the SFTP service. Every application team will get a specific user, and the eMagiz model will get it's own user. In this way, the data is securely provided to the ecosystem of the eMagiz model. For instance, in case there are 4 applications involved that need to get or send data to the SFTP service there will be 5 SFTP service users
34 34  
35 -=== 3.2 Create (agreed) folder structure ===
36 -Once the integration is realized in eMagiz, the user will have chosen the folder structure for each receiving or sending user. On the SFTP folder structure there will be tst, accp and prod folder as well. That folder structure can be set by the eMagiz user as desired but needs to be known by eMagiz. Please see the next point
38 +== 3. Determining the origin of log entries ==
37 37  
38 -=== 3.3 Create script ===
39 -For most implementations, external users or applications will send and receive files via the their own SFTP user. Each eMagiz integration model will have it's own SFTP user. To some use cases, files put on the eMagiz integration model SFTP user need to be synchronized with the external application SFTP user. On that case, a script needs to be provided to eMagiz Support. Please consult eMagiz Support to get help in case needed - samples are available.
40 +You can determine the origin of a log entry with a two-step approach:
40 40  
41 -=== 3.4 Optimize SFTP user settings ===
42 -Once the folder structure is fixed across test, accp and prod folders, a signal needs to be send to eMagiz Support. The eMagiz SFTP settings will be optimized accordingly using Event Notifications in AWS. Please ensure to transmit this signal as soon as possible to avoid misconfigured eMagiz SFTP settings for users. Send a notification to productmanagement@emagiz.com.
42 +1. Search in the Monitoring overview for log entries
43 +2. Select a specific log entry for further analysis
43 43  
45 +=== 3.1 Monitoring overview Manage ===
46 +
47 +To see and analyze the log entries you need to navigate to Manage -> Monitoring. This overview shows all log entries within your project that have been written to the log in the last fourteen days (assuming you did adhere to the fair use policy). Within this overview, you have the ability to search on various options such as runtime, type, and timestamp.
48 +
49 +<p align="center">[[image:intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-unfiltered.png||]]</p>
50 +
51 +<p align="center">[[image:intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-filtered.png||]]</p>
52 +
53 +=== 3.2 Select a specific log entry for further analysis ===
54 +
55 +After you have filtered the log entries to your liking you can select a specific log entry by double-clicking on the log entry. By doing so a pop-up will be presented in which the details of the log entry are written. On this details page, the flow and message are the most relevant from a user perspective.
56 +
57 +<p align="center">[[image:intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-log-entry-details.png||]]</p>
58 +
59 +Note that some log entries are grouped as they appeared in short proximity after each other and have to do with the same logging.
60 +
61 +<p align="center">[[image:intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-log-entry-details-grouped.png||]]</p>
62 +
63 +===== Practice =====
64 +
44 44  == 4. Assignment ==
45 45  
46 -Take a moment to locate the Store component for eMagiz.
67 +Determine the origin of at least five log entries that have been raised within your (Academy) project in the last two weeks. If your project has no log entries be creative in messing up stuff to create a log entry for which you can then determine the origin.
47 47  
48 48  == 5. Key takeaways ==
49 49  
50 -* The eMagiz SFTP Service requires use of a specific Store component
51 -* Please contact eMagiz Support to ensure the right configuration is created including the proper file paths inside the SFTP user folder
52 -* Ensure to update eMagiz Support whenever the file path changes
71 +* Determining in which flow a log entry is raised can be done with the help of the Manage phase in eMagiz.
72 + * In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant without your project.
73 +* This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
74 +* Double-clicking on a log entry provides you with the relevant details
75 +* Note that log entries are not shown in full when they exceed a certain size so takes this into account when logging
76 +* When you know the flow and the details you have determined the origin of the log entry
53 53  
54 54  
79 +
55 55  == 6. Suggested Additional Readings ==
56 56  
57 -None available
82 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz when executing these actions.
58 58  
59 59  == 7. Silent demonstration video ==
60 60  
61 -None available
62 -)))
63 -((({{toc/}}))){{/container}}
64 -{{/container}}
86 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
87 +
88 +<iframe width="1280" height="720" src="../../vid/microlearning/intermediate-active-monitoring-determining-origin-of-log-entry.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
89 +
90 +</div>
91 +
92 +</div>
93 +</div>
94 +
95 +{{/html}}