SFTPTransfer: Difference between revisions
Created page with "SFTP Transfer is a program designed to automate the movement of files to and from a SFTP server. You can configure it :- Monitor a local folder for files and automatically move them to a remote server. Monitor a remote SFTP folder and automatically move them to a local folder. This program performs the same function as the SFTP_Put and SFTP_Get programs but makes things a lot easier to configure as it has a user interface as shown below. You can configure a test the..." |
No edit summary |
||
| (14 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
Monitor a remote SFTP folder and automatically move them to a local folder. | Monitor a remote SFTP folder and automatically move them to a local folder. | ||
This program performs the same function as the | This program performs the same function as the [[SFTPSend]] and [[SFTPGet]] programs but makes things a lot easier to configure as it has a user interface as shown below. | ||
You can configure a test the program using the interactive display and then configure it to run as a background process. | You can configure a test the program using the interactive display and then configure it to run as a background process. | ||
The user interface consists of a number of tabs which contain both the settings and a log of activity. | |||
== Host Settings == | |||
[[File:SFTP_Transfer_Common.png|border|800px]] | |||
The first page used to define the SFTP host machine that you want to connect to. You can define it's IP Address and Port along with a known hosts file to validate it's authenticity and authentication details. | |||
At the bottom of this page you can enable email notifications and protect the settings with a password. | |||
== SFTP Put Settings == | |||
[[File:SFTP_Transfer_Put_Properties.png|border|800px]] | |||
The "Put Properties" allows you to define which local folder is to be monitored and where files should be sent to. To ensure no data is lost during transfer the system can also make backups of any files which it sends. To ensure that the backups do not accumulate forever you can also define a backup retention period. Files which have been backed up will be deleted when they are older that the backup retention period which is in "days". | |||
== SFTP Get Settings == | |||
[[File:SFTP_Transfer_Get_Properties.png|border|800px]] | |||
== jsch Settings == | |||
[[File:SFTP_Transfer_jsch_Properties.png|border|800px]] | |||
jsch is the name of a java library which this application uses. You can control how SFTP works by changing the values shown on this screen. For additional information on these settings refer to the project [https://github.com/mwiede/jsch github page] | |||
== Email Settings == | |||
[[File:SFTP_Transfer_Email_Properties.png|border|800px]] | |||
This page contains the settings required to connect to your email SMTP server at the top and distribution lists at the bottom. Note that for emails to be sent you also need to enable the email function on the initial host page. | |||
== Put Log == | |||
[[File:SFTP_Transfer_Put_Log.png|border|800px]] | |||
This screen shows the last 100 lines of the log. When the program detects one or more files in the local folder which it is monitoring it will attempt to send them to the nominated remote SFTP folder. To avoid problems which file handshaking files are transmitted with a temporary file extension and only when the file has been completely transmitted is the remote file renamed back to it's original name. This is good practice as it prevents a scenario where a remote application attempts to process a file which is still be uploaded. | |||
== Get Log == | |||
[[File:SFTP_Transfer_Get_Log.png|border|800px]] | |||
This is much the same as the Put log except it records all the files that are being downloaded. It also renames files with a temporary extension to avoid conflicts during transfer. Only when the file has been completely downloaded will it be renamed to it's original file extension. | |||
== System Log == | |||
[[File:SFTP_Transfer_System_Log.png|border|800px]] | |||
The System Log gives an overview of the whole application. It tells you which services have started and if you make a change to the configuration and save it you can verify that the background processes (threads) have reloaded the updated config. | |||
Latest revision as of 14:39, 11 September 2025
SFTP Transfer is a program designed to automate the movement of files to and from a SFTP server.
You can configure it :-
Monitor a local folder for files and automatically move them to a remote server. Monitor a remote SFTP folder and automatically move them to a local folder.
This program performs the same function as the SFTPSend and SFTPGet programs but makes things a lot easier to configure as it has a user interface as shown below.
You can configure a test the program using the interactive display and then configure it to run as a background process.
The user interface consists of a number of tabs which contain both the settings and a log of activity.
Host Settings
The first page used to define the SFTP host machine that you want to connect to. You can define it's IP Address and Port along with a known hosts file to validate it's authenticity and authentication details.
At the bottom of this page you can enable email notifications and protect the settings with a password.
SFTP Put Settings
The "Put Properties" allows you to define which local folder is to be monitored and where files should be sent to. To ensure no data is lost during transfer the system can also make backups of any files which it sends. To ensure that the backups do not accumulate forever you can also define a backup retention period. Files which have been backed up will be deleted when they are older that the backup retention period which is in "days".
SFTP Get Settings
jsch Settings
jsch is the name of a java library which this application uses. You can control how SFTP works by changing the values shown on this screen. For additional information on these settings refer to the project github page
Email Settings
This page contains the settings required to connect to your email SMTP server at the top and distribution lists at the bottom. Note that for emails to be sent you also need to enable the email function on the initial host page.
Put Log
This screen shows the last 100 lines of the log. When the program detects one or more files in the local folder which it is monitoring it will attempt to send them to the nominated remote SFTP folder. To avoid problems which file handshaking files are transmitted with a temporary file extension and only when the file has been completely transmitted is the remote file renamed back to it's original name. This is good practice as it prevents a scenario where a remote application attempts to process a file which is still be uploaded.
Get Log
This is much the same as the Put log except it records all the files that are being downloaded. It also renames files with a temporary extension to avoid conflicts during transfer. Only when the file has been completely downloaded will it be renamed to it's original file extension.
System Log
The System Log gives an overview of the whole application. It tells you which services have started and if you make a change to the configuration and save it you can verify that the background processes (threads) have reloaded the updated config.