SFTPTransfer - Revision history

Dgarratt at 17:53, 24 April 2026

2026-04-24T17:53:51Z

← Older revision		Revision as of 19:53, 24 April 2026
Line 6:		Line 6:

	SFTPTransfer automates recurring file transfers between Commander4j and external systems — for example, uploading despatch notifications to a customer portal or downloading order files from a supplier. It runs continuously, polling for new files at a configurable interval, and handles authentication, retry, backup, and archiving without operator involvement.		SFTPTransfer automates recurring file transfers between Commander4j and external systems — for example, uploading despatch notifications to a customer portal or downloading order files from a supplier. It runs continuously, polling for new files at a configurable interval, and handles authentication, retry, backup, and archiving without operator involvement.

			[[File:SFTPTransfer.jpg\|800px]]

	== Startup Modes ==		== Startup Modes ==

Dgarratt: Updated by push_wiki.py

2026-04-05T16:05:02Z

Updated by push_wiki.py

← Older revision		Revision as of 18:05, 5 April 2026
Line 116:		Line 116:

	All service commands must be run from an elevated command prompt (Run as Administrator).		All service commands must be run from an elevated command prompt (Run as Administrator).

			The default Windows service name is '''sftpTransfer_Service''' (the launcher name defined in the installer). You can specify a different name as an optional second parameter — useful if you need to run multiple instances on the same machine. If a custom name is used at install time, that same name must be passed to every subsequent command.

	{\| class="wikitable"		{\| class="wikitable"
Line 121:		Line 123:
	! Command !! Effect		! Command !! Effect
	\|-		\|-
	\| <code>sftpTransfer_Service.exe /install</code> \|\| Register ~~the Windows service~~ with automatic startup on boot		\| <code>sftpTransfer_Service.exe /install</code> \|\| Register as '''sftpTransfer_Service''' with automatic startup on boot
	\|-		\|-
	\| <code>sftpTransfer_Service.exe /install-demand</code> \|\| Register ~~the service~~ with manual startup only		\| <code>sftpTransfer_Service.exe /install "My SFTP Service"</code> \|\| Register with a custom service name
			\|-
			\| <code>sftpTransfer_Service.exe /install-demand</code> \|\| Register with manual startup only
	\|-		\|-
	\| <code>sftpTransfer_Service.exe /start</code> \|\| Start the service		\| <code>sftpTransfer_Service.exe /start</code> \|\| Start the service
Line 135:		Line 139:
	\| <code>sftpTransfer_Service.exe /uninstall</code> \|\| Remove the service registration		\| <code>sftpTransfer_Service.exe /uninstall</code> \|\| Remove the service registration
	\|}		\|}

			If a custom service name was used at install time, append it to all subsequent commands:

			sftpTransfer_Service.exe /start "My SFTP Service"
			sftpTransfer_Service.exe /stop "My SFTP Service"
			sftpTransfer_Service.exe /uninstall "My SFTP Service"

	Once installed, the service also appears in the Windows Services management console (<code>services.msc</code>).		Once installed, the service also appears in the Windows Services management console (<code>services.msc</code>).

Dgarratt: Updated by push_wiki.py

2026-04-05T15:55:54Z

Updated by push_wiki.py

@@ Line 20: / Line 20: @@
 |}
-On Windows the service mode can be managed using a wrapper such as WinSW. On Linux/macOS, use systemd, launchd, or nohup.
+On Windows, the native install package includes <code>sftpTransfer_Service.exe</code>, which manages the Windows service directly — see [[#Installing as a Windows Service|Installing as a Windows Service]] below. On Linux/macOS, use systemd, launchd, or nohup.
 == Configuration Files ==
@@ Line 110: / Line 110: @@
 SMTP settings for error notification emails. When a transfer failure occurs and email notification is enabled, SFTPTransfer sends an alert to the configured address. Fields include SMTP host, port, sender address, recipient address, and AES-encrypted SMTP password.
 == Authentication ==

Dgarratt: Updated by push_wiki.py

2026-04-01T10:31:55Z

Updated by push_wiki.py

Show changes

Dgarratt at 13:39, 11 September 2025

2025-09-11T13:39:31Z

← Older revision		Revision as of 15:39, 11 September 2025
Line 9:		Line 9:

	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.		The user interface consists of a number of tabs which contain both the settings and a log of activity.


	== Host Settings ==		== Host Settings ==

Dgarratt: /* System Log */

2025-09-11T13:39:17Z

System Log

← Older revision		Revision as of 15:39, 11 September 2025
Line 50:		Line 50:
	== System Log ==		== System Log ==
	[[File:SFTP_Transfer_System_Log.png\|border\|800px]]		[[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.

Dgarratt: /* Get Log */

2025-09-11T13:37:55Z

Get Log

← Older revision		Revision as of 15:37, 11 September 2025
Line 45:		Line 45:
	== Get Log ==		== Get Log ==
	[[File:SFTP_Transfer_Get_Log.png\|border\|800px]]		[[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 ==		== System Log ==
	[[File:SFTP_Transfer_System_Log.png\|border\|800px]]		[[File:SFTP_Transfer_System_Log.png\|border\|800px]]

Dgarratt: /* Put Log */

2025-09-11T13:36:17Z

Put Log

← Older revision		Revision as of 15:36, 11 September 2025
Line 40:		Line 40:
	== Put Log ==		== Put Log ==
	[[File:SFTP_Transfer_Put_Log.png\|border\|800px]]		[[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 ==		== Get Log ==

Dgarratt: /* Email Settings */

2025-09-11T13:33:17Z

Email Settings

← Older revision		Revision as of 15:33, 11 September 2025
Line 35:		Line 35:
	== Email Settings ==		== Email Settings ==
	[[File:SFTP_Transfer_Email_Properties.png\|border\|800px]]		[[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 ==		== Put Log ==

Dgarratt: /* jsch Settings */

2025-09-11T13:31:41Z

jsch Settings

← Older revision		Revision as of 15:31, 11 September 2025
Line 31:		Line 31:
	== jsch Settings ==		== jsch Settings ==
	[[File:SFTP_Transfer_jsch_Properties.png\|border\|800px]]		[[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]]		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 ==		== Email Settings ==