Changes for page eMagiz SFTP Connection guide

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.dfirdausy
	1	+XWiki.eMagiz

Content

...	...	@@ -1,49 +1,63 @@
1	1	{{container}}
2	2	{{container layoutStyle="columns"}}
3	3	(((
4		-In this microlearning, we will provide short guide that will help eMagiz users how to connect to the eMagiz SFTP service. Although this is a regular SFTP service, there are some specific steps involved to allow an optimal configuration of the integration.
	4	+= How to connect with the eMagiz SFTP Service =
5	5
6		-Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
	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	+
	8	+Should you have any questions, please contact academy@emagiz.com.
7	7
	10	+* Last update: June 2nd, 2022
	11	+* Required reading time: 5 minutes
	12	+
8	8	== 1. Prerequisites ==
9	9
10	10	* Basic knowledge of the eMagiz platform
11	11	* Understanding of the way in which an SFTP file pickup or drop is configured in eMagiz
12		-* Reviewed microlearning : [[eMagiz SFTP Connectivity>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.intermediate-file-based-connectivity-emagiz-sftp-connectivity.WebHome||target="blank"]]
13		-
	17	+
	18	+ bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/File%20based%20connectivity/intermediate-file-based-connectivity-emagiz-sftp-connectivity/
	19	+
	20	+ [[Connect Guide eMagiz SFTP>>doc:Main.eMagiz Academy.Microlearnings.WebHome]]
	21	+
14	14	== 2. Key concepts ==
15	15
16		-This microlearning focuses on guiding you to connecting to the eMagiz SFTP service.
17		-* By the eMagiz SFTP, we mean: A specific SFTP offered by the eMagiz platform on which you can securely store and read messages.
	24	+This microlearning centers around determining the origin of log entries.
	25	+By origin, in this context, we mean: Identifying which flow wrote an entry to the log that might be in need of analysis.
18	18
19		-== 3. eMagiz SFTP Connection guide ==
	27	+* Determining in which flow a log entry is raised can be done with the help of the Manage phase in eMagiz.
	28	+ * In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant without your project.
	29	+* This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
	30	+* Double-clicking on a log entry provides you with the relevant details
	31	+* Note that log entries are not shown in full when they exceed a certain size so takes this into account when logging
	32	+* When you know the flow and the details you have determined the origin of the log entry
20	20
21		-=== 3.1 Obtain an SFTP User account ===
22		-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 its 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
23	23
24		-=== 3.2 Create (agreed) folder structure ===
25		-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 test, 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
26	26
27		-=== 3.3 Create script ===
28		-For most implementations, external users or applications will send and receive files via their own SFTP user. Each eMagiz integration model will have its 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.
	36	+== 3. How to steps ==
29	29
30		-=== 3.4 Optimize SFTP user settings ===
31		-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.
	38	+== 4. Assignment ==
32	32
33		-== 4. Key takeaways ==
	40	+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.
34	34
35		-* Ensure you are using the designated Store component for connecting to the eMagiz SFTP service.
36		-* Please contact eMagiz Support to ensure the right configuration is created including the proper file paths inside the SFTP user folder
37		-* Ensure to notify eMagiz Support of any changes to file paths or configurations to maintain proper integration and avoid potential issues.
	42	+== 5. Key takeaways ==
38	38
39		-== 5. Suggested Additional Readings ==
	44	+* Determining in which flow a log entry is raised can be done with the help of the Manage phase in eMagiz.
	45	+ * In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant without your project.
	46	+* This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
	47	+* Double-clicking on a log entry provides you with the relevant details
	48	+* Note that log entries are not shown in full when they exceed a certain size so takes this into account when logging
	49	+* When you know the flow and the details you have determined the origin of the log entry
40	40
41		-If you are interested in this topic and want more information, please read the release notes provided by eMagiz. Furthermore, check out these links:
42	42
43		-* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
44		-** [[File based connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.WebHome||target="blank"]]
45		-*** [[eMagiz SFTP Connectivity (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.intermediate-file-based-connectivity-emagiz-sftp-connectivity.WebHome||target="blank"]]
46		-* [[SFTP (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=%22sftp%22||target="blank"]]
	52	+
	53	+== 6. Suggested Additional Readings ==
	54	+
	55	+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.
	56	+
	57	+== 7. Silent demonstration video ==
	58	+
	59	+This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
	60	+
47	47	)))
48	48	((({{toc/}}))){{/container}}
49	49	{{/container}}