Skip to Content

Changes for page eMagiz SFTP Connectivity

Last modified by Danniar Firdausy on 2024/09/18 20:23
From version 50.1
edited by Erik Bakker
on 2022/06/02 09:05
Change comment: There is no comment for this version
To version 87.5
edited by Danniar Firdausy
on 2024/09/18 20:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -Main.eMagiz Academy.Microlearnings.WebHome
1 +Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Content
... ... @@ -1,68 +1,58 @@
1 1  {{container}}
2 2  {{container layoutStyle="columns"}}
3 3  (((
4 -In this microlearning, we will learn what you should consider determining the impact of business logic within your integration solution. An eMagiz model is most useful when exchanging data between systems while taking care of data and protocol transformations. For example, an eMagiz model is generally less suited for incorporating business logic as these rules cannot be defined dynamically and are relatively complex. Filling your eMagiz model with a lot of business logic opens you up for a continuous discussion about data and interpretations of business rules. As that is not the core goal of an eMagiz model, you should always ask yourself what the most suitable place is to incorporate pieces of logic.
4 +In some cases, there is no communication possible with a local file directory, or there is a requirement from the external party to place the files somewhere else. It can occur that somewhere else is either an FTP or an SFTP server. With that consideration, this microlearning will walk you through setting up and managing the eMagiz SFTP connection. We will cover the essentials for connecting to eMagiz SFTP, including key considerations and options available in the eMagiz store.
5 5  
6 6  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
8 -* Last update: April 6th, 2021
9 -* Required reading time: 4 minutes
10 -
11 11  == 1. Prerequisites ==
12 12  
13 -Advanced knowledge of the eMagiz platform
10 +* Advanced knowledge of the eMagiz platform
11 +* [[eMagiz SFTP Connection Guide>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.eMagiz SFTP Connection guide.WebHome||target="blank"]]
14 14  
15 15  == 2. Key concepts ==
16 16  
17 -This microlearning centers around considering the impact of business logic
15 +This microlearning is about the eMagiz SFTP (connectivity).
16 +* By the eMagiz SFTP, we mean: A specific SFTP offered by the eMagiz platform on which you can securely store and read messages.
18 18  
19 -By business logic, we mean: Rules that determine what should happen to a message
18 +== 3. eMagiz SFTP Connectivity ==
20 20  
21 -The most interesting point when talking about business logic is:
20 +In some cases, there is no communication possible with a local file directory. Or there is a requirement from the external party to place the files somewhere else. Mainly the somewhere else is either an FTP or an SFTP. This microlearning will look at the eMagiz SFTP and learn how to set up the connection between eMagiz and the eMagiz SFTP. In the following microlearning, we will take a more general approach and look how to connect to other SFTP hosts via eMagiz.
22 22  
23 -* Where to draw the line?
22 +Considerations when connecting to the eMagiz SFTP
24 24  
25 -== 3. Considering the impact of business logic ==
24 +* Did you read the connect guide and made sure that all requirements are met?
25 +* Did you use the store component made available in the eMagiz store to set up the connection?
26 +* Did you verify that the indicator for temporary file name is set to false?
26 26  
27 -In this microlearning, we will learn what you should consider determining the impact of business logic within your integration solution. An eMagiz model is most useful when exchanging data between systems while taking care of data and protocol transformations. For example, an eMagiz model is generally less suited for incorporating business logic as these rules cannot be defined dynamically and are relatively complex. Filling your eMagiz model with a lot of business logic opens you up for a continuous discussion about data and interpretations of business rules. As that is not the core goal of an eMagiz model, you should always ask yourself what the most suitable place is to incorporate pieces of logic.
28 +To connect to the eMagiz SFTP eMagiz offers multiple options in the eMagiz store. Depending on whether you want to read or write data you need to select the SFTP Inbound Connectivity or the SFTP Outbound Connectivity option in the store.
28 28  
29 -(% class="wikigeneratedid" %)
30 -[[Invalid check>>image:advanced-active-monitoring-determining-cause-of-log-entry--current-faulty-check.png||alt="Figure one" id="Iadvanced-active-monitoring-determining-cause-of-log-entry--current-faulty-check.png"]]
30 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-emagiz-sftp-connectivity--store-alternatives.png]]
31 31  
32 -The most exciting point when talking about business logic is:
32 +Within each of the options you can select between the default connection or the caching connection. Depending on the frequency with which you want to connect to the SFTP you need to select the default or the caching variant. In cases were you have a lot of interaction with the SFTP we advise to use the caching variant. In cases were there is infrequent interaction with the SFTP we advise to use the default variant.
33 33  
34 -* Where to draw the line?
34 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-emagiz-sftp-connectivity--store-options.png]]
35 35  
36 -What is acceptable and what is not acceptable in eMagiz then quickly becomes the question. You could argue that any business rule is too much in eMagiz. However, that is a bit too strict of a definition as there are scenarios in which it is pretty helpful to manipulate the destination of messages while transporting them between systems. One example of this would be logic in the asynchronous routing that allows you to develop functionality within the routing and ensure that each piece of the functionality comes with an on/off switch. This way, you reduce problems when deploying and make it clear to all that data can be sent (or not sent) to certain offramps.
36 +== 4. Key takeaways ==
37 37  
38 +* Ensure you have read and understood the eMagiz SFTP connection guide and met all necessary requirements.
39 +* Use the suitable flow components from the eMagiz Store to establish your SFTP connection, e.g., by choosing between inbound and outbound connectivity options based on your needs.
40 +* Made sure to verify that the indicator for temporary file names is set to false to avoid potential issues.
38 38  
39 -Another valid scenario would be to filter messages based on a single criterion to reduce the data load sent to specific systems. For example, when you have one system that sends out employee information that needs to be sent to ten different systems, you could use the messaging pattern and filter out the relevant information in the offramp. However, you could also publish all employee information on a topic, let all those systems consume from it, and do the filtering themselves. Both are possible. The most interesting question in this scenario would be whether it can hurt if all systems access all employee information. If that is the case, then filtering in eMagiz becomes highly relevant suddenly.
42 +== 5. Suggested Additional Readings ==
40 40  
44 +If you are interested in this topic and want more information, please read the release notes provided by eMagiz. Furthermore, check out these links:
41 41  
42 -On the flip side, you should not implement business logic in eMagiz if the rules consist of multiple criteria and are dependent on other (tables of) information. So gathering all that and making the decision will become so complex that you should consider moving the logic to the business application itself. That way, you reduce the complexity of the integration. This reduces the risks of things going wrong and reduces the time needed to develop and maintain the integration.
46 +* [[eMagiz Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
47 +** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
48 +*** [[SFTP Inbound Connectivity (Explanation)>>doc:Main.eMagiz Store.Accelerators.SFTP Inbound Connectivity.WebHome||target="blank"]]
49 +*** [[SFTP Outbound Connectivity (Explanation)>>doc:Main.eMagiz Store.Accelerators.SFTP Outbound Connectivity.WebHome||target="blank"]]
50 +*** [[SFTP Gateway Connectivity (Explanation)>>doc:Main.eMagiz Store.Accelerators.SFTP Gateway Connectivity.WebHome||target="blank"]]
51 +* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
52 +** [[File based connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.WebHome||target="blank"]]
53 +*** [[eMagiz SFTP Connection Guide (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.File based connectivity.eMagiz SFTP Connection guide.WebHome||target="blank"]]
54 +* [[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"]]
55 +)))
43 43  
44 -
45 -The main takeaway should be that adding business logic comes at a price. Depending on the specific requirements, you have to decide whether the pros outweigh the cons. The most crucial part of using business logic is proper documentation. That way, it is clear what the business logic does, why it is there, and how it can be controlled.
46 -
47 -== 4. Assignment ==
48 -
49 -See if you can determine which business logic is implemented in your project and whether that was a wise decision. This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
50 -
51 -== 5. Key takeaways ==
52 -
53 -* Check out the pros and cons to determine whether business logic in eMagiz makes sense
54 -* Documentation is key
55 -
56 -== 6. Suggested Additional Readings ==
57 -
58 -* [[Asynchronous Routing>>doc:Main.eMagiz Academy.Microlearnings.WebHome]]
59 -
60 -
61 -== 7. Silent demonstration video ==
62 -
63 -There is no video for this microlearning.
64 -
65 -{{video attachment="advanced-active-monitoring-determining-cause-of-log-entry.mp4"/}})))
66 -
67 67  ((({{toc/}}))){{/container}}
68 68  {{/container}}
advanced-active-monitoring-determining-cause-of-log-entry--current-faulty-check.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -22.0 KB
Content
advanced-active-monitoring-determining-cause-of-log-entry.mp4
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -15.6 MB
Content