Skip to Content

Changes for page SMB Connectivity

Last modified by Danniar Firdausy on 2024/09/18 20:40
From version 7.1
edited by Bouke Reitsma
on 2024/05/03 09:30
Change comment: There is no comment for this version
To version 15.1
edited by Bouke Reitsma
on 2024/05/06 11:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -28,110 +28,78 @@
28 28  * Servers must be set up to run SMB services, and the client must have SMB software installed to access these services.
29 29  * eMagiz provides several components to set up the SMB connection
30 30  
31 ------------------------------------------------------------------------------------------------------------------------------------
32 -
33 33  So, where the file pickup component searches on the local host for the correct directory, the idea of the SMB setup is that the directory with whom to communicate exists on a remote host. The local host and the remote host can talk to each other via the SMB protocol. That is, in a nutshell, the difference between setting up an SMB connection and communicating with local directories.
34 34  
35 -eMagiz provides only one support objects to connect to an FTP:
33 +eMagiz provides only one support objects to connect to an SMB:
36 36  
37 -* Default SMB session factory
35 +* SMB session factory
38 38  
39 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-ftp-connectivity--ftp-support-objects.png]]
37 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-support-object.png]]
40 40  
41 -The main difference between the two is the caching part. The caching session factory comes with the option to re-use the existing session for multiple requests. In other words, this way, you do not have to authenticate yourself every time you want to communicate with the FTP. This behavior is beneficial if a high frequency of communication is needed between eMagiz and the FTP to handle the incoming and outgoing data packages.
39 +=== 3.1 Configuration in eMagiz ===
42 42  
43 -If you only initiate communication infrequently, for example, once per day, the default session factory becomes more interesting as this closes the session after each transmission. This behavior is beneficial in cases of low-frequency communication because otherwise, the session would remain active for an extensive period.
41 +To configure the connection between eMagiz and the SMB, we need two (or three) components. This depends on whether we want to read, write or do both while communicating with the SMB. If we're going to do both, we need both of the functional components. In all other scenarios, you only need one of the functional components. The functional components that you might need are called:
44 44  
45 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-ftp-connectivity--ftp-caching-help-text.png]]
43 +* SMB inbound Channel adapter
44 +* SMB outbound Channel adapter
46 46  
47 -=== 3.1 Best practices for using FTP ===
46 +On top of that, you need the following support objects.
48 48  
49 -==== 3.1.1 Which session factory do I need? ====
48 +* SMB session factory
50 50  
51 -When occasionally retrieving or writing files to FTP, use the _Default FTP session factory_. A new connection will be set up when you use the _Default FTP session factory_ for every message/file. On some FTP servers, this might take up to seconds for each login. This fact might impact the performance of your flow.
50 +In this microlearning, we will use the SMB inbound channel adapter combined with the SMB session factory to illustrate the configuration. Please note that any other combination works similarly. To configure the connection with the SMB, we first navigate to the Create phase of eMagiz. Here we open the flow we want to edit. In this example, that will be an entry flow as we want to retrieve (read) data from the SMB.
52 52  
53 -When you need better performance (say writing multiple files in a minute or retrieving files every minute), use the _Default FTP **caching** session factory_. The _Default FTP **caching** session factory_ shares FTP sessions for messages in your flow.
52 +When you have opened the flow, you need to enter "Start Editing" mode. After you have done so, we first add the SMB session factory support object to our flow.
54 54  
55 -==== 3.1.2 Do I have to set up a retry mechanism? ====
54 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-session-factory-empty.png]]
56 56  
57 -When writing files to FTP, it is advisable to set a retry mechanism. Find the advanced tab on your _FTP outbound channel adapter_. Under _Request handler advice chain_ add a _Retry Advice_.
56 +Here, we need to define the following:
58 58  
59 -==== 3.1.3 I get a _Failed to list files/items_ or a _Failed to obtain pooled item_. What can I do? ====
58 +* Host
59 +* Port
60 +* Username
61 +* Password
60 60  
61 -Incorrect connection settings can cause this. Check whether the correct properties have been set and whether the runtime has retrieved the latest properties.
63 +As best practise, we also define the share and directory value. The value for this field is the main folder for your fileshare. In case the main folder is the exchange folder, this field should be empty and the main folder should be configured as remote directory in the SMB inbound Channel adapter.
62 62  
63 -==== 3.1.4 I get a _Failed to list files / items_, a _Pipe closed_ or an _input stream is closed_. What can I do? ====
65 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-session-factory-filled-in.png]]
64 64  
65 -A closed FTP session can cause these notifications due to inactivity. For the _Default FTP **caching** session factory_, always set the _Server alive interval_ property to 30000 (ms).
67 +The settings on the Advanced tab don't have to be changed in most cases. If your specific setup does require a change to these settings, please consult the help texts on the component level for advice.
66 66  
67 -==== 3.1.6 I get a _Failed to write to_. What can I do? ====
69 +Now that we have configured the support object adding the SMB inbound channel adapter to the flow has become time.
68 68  
69 -Maybe the target folder does not exist, and the _Auto-create directory_ is off. It is also possible that the connection settings are incorrect. Check whether the correct properties have been set and whether the runtime has retrieved the latest properties.
71 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-inbound-channel-adapter-empty.png]]
70 70  
71 -==== 3.1.7 I often get 'Disconnecting from sftp.example.com port 22' and then a 'Caught an exception, leaving main loop due to Socket closed' warnings. ====
73 +In this component, we need to define the remote directory where the original files are located. We need to specify the local directory used to store the files before they are processed temporarily. Furthermore, we need to link the support object we have just created and define a poller. For that last one, the best practice is the use of a cron trigger.
72 72  
73 -Too many connections can cause this to the same server at the same time. If you have many flows connecting to the same FTP server, ensure that the crons do not trigger simultaneously.
75 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-inbound-channel-adapter-filled-in.png]]
74 74  
75 -==== 3.1.8 I get a 'Failed to create SFTPClient' ====
77 +Apart from these configurations, you could also add a filter, just as we learned in the Crash Course Messaging on file-based connectivity. Finishing things off, we should consider the delete behavior we will use. Based on the filter and the business requirements, whether to delete and when to delete could differ. So please consider all your options in that regard.
76 76  
77 -SFTP, FTP, and FTPS are three different remote file transfer protocols with their _session factory_ components in the eMagiz flow designer. Make sure you use the one that corresponds to the server's protocol.
79 +=== 3.2 SMB Gateway ===
78 78  
79 -==== 3.1.9 One of my remote files is not picked up from the SFTP server (without any warning) ====
81 +The SMB Gateway is an additional component that can be used to interact with your SMB share. It enables the use of a set of pre-configured commands to for example delete files. The reply messages depend on the selected command. Every command option is explained within the helptext. An example configuration to send files is shown below.
80 80  
81 -The default local filter is _AcceptOnceFileListFilter_. This can be replaced by your file list filter on the _FTP inbound channel adapter's_.
82 -If every day you retrieve a file with the same filename and the _Delete remote files_ property is set, it is advised to use a different local filename. You can add the current timestamp, for example.
83 +[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-outbound-gateway-filled-in.png]]
83 83  
84 -==== 3.1.10 Which mode is needed ====
85 +{{info}}
86 +Please note that for some commands an SpEL expression is required to respresent a path. This setting can be found in the advanced settings.
87 +{{/info}}
85 85  
86 -When running in the current-generation architecture (G3) the FTP always needs to run **passive** mode.
89 +This concludes our microlearning, in which we learned how to set up the connectivity with an SMB.
87 87  
88 -=== 3.2 Configuration in eMagiz ===
89 -
90 -To configure the connection between eMagiz and the FTP, we need two (or three) components. This depends on whether we want to read, write or do both while communicating with the FTP. If we're going to do both, we need both of the functional components. In all other scenarios, you only need one of the functional components. The functional components that you might need are called:
91 -
92 -* FTP Inbound Channel adapter
93 -* FTP Outbound Channel adapter
94 -
95 -On top of that, you need one of the following support objects. If you are unsure of which to use, please check out the information above in this microlearning.
96 -
97 -* Default FTP caching session factory
98 -* Default FTP session factory
99 -
100 -In this microlearning, we will use the FTP Inbound channel adapter combined with the Default FTP session factory to illustrate the configuration. Please note that any other combination works similarly. To configure the connection with the FTP, we first navigate to the Create phase of eMagiz. Here we open the flow we want to edit. In this example, that will be an entry flow as we want to retrieve (read) data from the FTP.
101 -
102 -When you have opened the flow, you need to enter "Start Editing" mode. After you have done so, we first add the support object to our flow. In this case, we will use the Default FTP session factory.
103 -
104 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-ftp-connectivity--default-ftp-session-factory-empty.png]]
105 -
106 -Here, we need to define at least the host and the port. Note that the username and password are optional for an FTP, which makes it less secure. Although in practice, we generally see that the FTP is secured with the help of a username-password combination. As a best practice, we use property references to fill in the various elements.
107 -
108 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-ftp-connectivity--default-ftp-session-factory-filled-in.png]]
109 -
110 -The settings on the Advanced tab don't have to be changed in most cases. If your specific setup does require a change to these settings, please consult the help texts on the component level for advice.
111 -
112 -Now that we have configured the support object adding the FTP inbound channel adapter to the flow has become time.
113 -
114 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-ftp-connectivity--ftp-inbound-channel-adapter-empty.png]]
115 -
116 -In this component, we need to define the remote directory where the original files are located. We need to specify the local directory used to store the files before they are processed temporarily. Furthermore, we need to link the support object we have just created and define a poller. For that last one, the best practice is the use of a cron trigger.
117 -
118 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-ftp-connectivity--ftp-inbound-channel-adapter-filled-in.png]]
119 -
120 -Apart from these configurations, you could also add a filter, just as we learned in the Crash Course Messaging on file-based connectivity. Finishing things off, we should consider the delete behavior we will use. Based on the filter and the business requirements, whether to delete and when to delete could differ. So please consider all your options in that regard. This concludes our microlearning, in which we learned how to set up the connectivity with an FTP.
121 -
122 122  == 4. Key takeaways ==
123 123  
124 -* FTP (File Transfer Protocol) is a network protocol for transmitting files between computers over Transmission Control Protocol/Internet Protocol (TCP/IP) connections.
125 -* In an FTP transaction, the end user's computer is typically called the localhost. The second computer involved in FTP is a remote host, which is usually a server.
126 -* Servers must be set up to run FTP services, and the client must have FTP software installed to access these services.
127 -* eMagiz provides several components to set up the FTP connection
93 +* SMB (Server Message Block) is a network protocol for transmitting files between computers over Transmission Control Protocol/Internet Protocol (TCP/IP) connections.
94 +* In an SMB transaction, the end user's computer is typically called the localhost. The second computer involved in SMB is a remote host, which is usually a server.
95 +* Servers must be set up to run SMB services, and the client must have SMB software installed to access these services.
96 +* eMagiz provides several components to set up the SMB connection
128 128  
129 129  == 5. Suggested Additional Readings ==
130 130  
131 131  If you are interested in this topic and want more information, please read the release notes provided by eMagiz. Furthermore, check out these links:
132 132  
133 -* [[FTP Inbound>>https://docs.spring.io/spring-integration/docs/2.1.x/reference/html/ftp.html#ftp-inbound||target="blank"]]
134 -* [[FTP Session Factory>>https://docs.spring.io/spring-integration/docs/4.3.x/reference/html/ftp.html#ftp-session-factory||target="blank"]]
135 -* [[FTP Explained>>https://searchnetworking.techtarget.com/definition/File-Transfer-Protocol-FTP||target="blank"]]
102 +* [[SMB Support>>https://docs.spring.io/spring-integration/reference/smb.html||target="blank"]]
103 +* [[SMB Overview>>https://learn.microsoft.com/en-us/windows-server/storage/file-server/file-server-smb-overview||target="blank"]]
136 136  
137 137  )))((({{toc/}}))){{/container}}{{/container}}