Changes for page SMB Connectivity

Summary

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

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ebakker
	1	+XWiki.BoukeReitsma

Content

...	...	@@ -1,6 +1,5 @@
1		-{{container}}
2		-{{container layoutStyle="columns"}}(((
3		-In some situations, direct communication with a local file directory is not possible, or in other case, an external party requires the files to be placed elsewhere. Typically, these files need to be retrieved from or uploaded to a server location using the FTP or SFTP protocols. However, there is a third communication protocol that can be used for file transfer. In this microlearning we will take a look at Server Message Block (SMB) connectivity within eMagiz.
	1	+{{container}}{{container layoutStyle="columns"}}(((
	2	+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. However, there is a third communication protocol that can be used for file transfer. In this microlearning we will take a look at Server Message Block (SMB) connectivity within eMagiz.
4	4
5	5	Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6	6
...	...	@@ -31,10 +31,8 @@
31	31
32	32	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.
33	33
34		-{{warning}}Note that the auto create directory setting on all SMB components only works for a "one-level" directory (i.e. /directory) and not for a "multi-level" directory (i.e. /directory/sub). To ensure this "multi-level" directory is created by eMagiz you need to take a look at this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.File based connectivity.advanced-file-connectivity-dynamically-manipulate-smb-settings.WebHome||target="blank"]]{{/warning}}
	33	+eMagiz provides only one support objects to connect to an SMB:
35	35
36		-eMagiz provides only one support object to connect to an SMB:
37		-
38	38	* SMB session factory
39	39
40	40	[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-support-object.png]]
...	...	@@ -46,7 +46,7 @@
46	46	* SMB inbound Channel adapter
47	47	* SMB outbound Channel adapter
48	48
49		-On top of that, you need the following support object.
	46	+On top of that, you need the following support objects.
50	50
51	51	* SMB session factory
52	52
...	...	@@ -62,17 +62,14 @@
62	62	* Port
63	63	* Username
64	64	* Password
65		-* Share and directory
66	66
67		-{{info}}
68		-The value for the share and directory field is the main folder for your file share. If the main folder is the exchange folder, then within the SMB inbound channel adapter, a / is needed as remote directory.
69		-{{/info}}
	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.
70	70
71	71	[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-session-factory-filled-in.png]]
72	72
73		-In the advanced tab there are only two settings to change. The minimum and maximum SMB protocol version. By default, these are set to 2.02 and 3.1.1 respectively to allow a wide range of save protocol version. However, if you want to only allow the best performing version, the minimum 3.0.2 is advised. If you aim for the best secured connection version 3.1.1 has the most functionality in this area. The best practise on this is set the minimum version as high as possible to mimize risks.
	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.
74	74
75		-Now that we have configured the support object,we can add the SMB inbound channel adapter to the flow.
	69	+Now that we have configured the support object adding the SMB inbound channel adapter to the flow has become time.
76	76
77	77	[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-inbound-channel-adapter-empty.png]]
78	78
...	...	@@ -80,44 +80,33 @@
80	80
81	81	[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-inbound-channel-adapter-filled-in.png]]
82	82
83		-Apart from these configurations, you could also add a filter, just as we learned in the [[Crash Course Messaging on file-based connectivity>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.WebHome||target="blank"]]. 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. In case there are multiple readers from the folder and/or there are legal requirements to store source files for a certain time period, you should not use the delete remote files option. However, not deleting files read files can cause overloading the machine if no alternative delete policies is in place.
	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.
84	84
85	85	=== 3.2 SMB Gateway ===
86	86
87		-The SMB Gateway is an additional component that can be used to interact with your SMB share. It allows the use of a set of pre-configured commands to perform actions such as deleting files. Compared to the outbound channel adapter replies are send back to eMagiz. These reply messages depend on the selected command. Every command option is explained in detail within the helptext. An example configuration to send files is shown below.
	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.
88	88
89	89	[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-smb-connectivity-smb-outbound-gateway-filled-in.png]]
90	90
91	91	{{info}}
92		-Please note that for some commands an SpEL expression is required to respresent a path. This setting can be found in the advanced settings. An example for the mget command could be **myfilesdirectory/** to get only files from this directory.
	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.
93	93	{{/info}}
94	94
95		-All available options are:
96		-
97		-* List files
98		-* List file names
99		-* Retrieve file
100		-* Retrieve multiple files
101		-* Remove file(s)
102		-* Move/rename file
103		-* Send file
104		-* Send mulitple files
105		-
106	106	This concludes our microlearning, in which we learned how to set up the connectivity with an SMB.
107	107
108	108	== 4. Key takeaways ==
109	109
110		-* SMB (Server Message Block) is a network protocol for transmitting files between computers over Transmission Control Protocol/Internet Protocol (TCP/IP) connections.
111		-* 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.
112		-* Servers must be set up to run SMB services, and the client must have SMB software installed to access these services.
113		-* eMagiz provides several components to set up the SMB connection
	93	+* FTP (File Transfer Protocol) is a network protocol for transmitting files between computers over Transmission Control Protocol/Internet Protocol (TCP/IP) connections.
	94	+* 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.
	95	+* Servers must be set up to run FTP services, and the client must have FTP software installed to access these services.
	96	+* eMagiz provides several components to set up the FTP connection
114	114
115	115	== 5. Suggested Additional Readings ==
116	116
117	117	If you are interested in this topic and want more information, please read the release notes provided by eMagiz. Furthermore, check out these links:
118	118
119		-* [[SMB Support>>https://docs.spring.io/spring-integration/reference/smb.html||target="blank"]]
120		-* [[SMB Overview>>https://learn.microsoft.com/en-us/windows-server/storage/file-server/file-server-smb-overview||target="blank"]]
	102	+* [[FTP Inbound>>https://docs.spring.io/spring-integration/docs/2.1.x/reference/html/ftp.html#ftp-inbound||target="blank"]]
	103	+* [[FTP Session Factory>>https://docs.spring.io/spring-integration/docs/4.3.x/reference/html/ftp.html#ftp-session-factory||target="blank"]]
	104	+* [[FTP Explained>>https://searchnetworking.techtarget.com/definition/File-Transfer-Protocol-FTP||target="blank"]]
121	121
122		-)))((({{toc/}}))){{/container}}
123		-{{/container}}
	106	+)))((({{toc/}}))){{/container}}{{/container}}