SFTPTransfer - Revision history

Dgarratt: Updated by push_wiki.py

2026-10-22T09:53:43Z

Updated by push_wiki.py

← Older revision		Revision as of 10:53, 22 October 2026
Line 3:		Line 3:
	SFTPTransfer replaces the earlier [[SFTPSend]] and [[SFTPGet]] tools with a single configurable service. Sites running [[Commander4j]] or [[Middleware4j]] typically use it to exchange files with ERP systems, customer portals, suppliers and print-and-apply labellers, but nothing in the program assumes those uses.		SFTPTransfer replaces the earlier [[SFTPSend]] and [[SFTPGet]] tools with a single configurable service. Sites running [[Commander4j]] or [[Middleware4j]] typically use it to exchange files with ERP systems, customer portals, suppliers and print-and-apply labellers, but nothing in the program assumes those uses.

	This page describes version 6.18.		This page describes version 6.19.

	[[File:SFTPTransfer.jpg\|800px]]		[[File:SFTPTransfer.jpg\|800px]]
Line 386:		Line 386:
	\| '''Monitor''' \|\| Started and Stopped (service start and shutdown, Run and Pause in the desktop) and the Daily Statistics Email (files and bytes sent and received, failures, errors raised and emailed). \|\| Enabled, frequency 0		\| '''Monitor''' \|\| Started and Stopped (service start and shutdown, Run and Pause in the desktop) and the Daily Statistics Email (files and bytes sent and received, failures, errors raised and emailed). \|\| Enabled, frequency 0
	\|-		\|-
	\| '''Error''' \|\| One message per error event: Connection failed, Connection lost, Upload failed, Download failed, Local folder not found, Remote folder could not be listed, Safe file missing, Local delete failed, Remote delete failed, Backup copy failed. Connection failed is sent once per outage, however many polls fail, and is followed by a Connection restored message (with the time the outage started and its length) when the next connection succeeds. \|\| Enabled, frequency 15 minutes		\| '''Error''' \|\| One message per error event: Connection failed, Connection lost, Upload failed, Download failed, Local folder not found, Remote folder could not be listed, Safe file missing, Local delete failed, Remote delete failed, Backup copy failed. Connection failed is sent once per outage, however many polls fail, and a Connection lost (a session dropped part-way through a pass) opens an outage in the same way. Either is followed by a single Connection restored message (with the time the outage started and its length) when the next connection succeeds. A folder listing that failed because the session dropped is reported as Connection lost alone, not also as Remote folder could not be listed. \|\| Enabled, frequency 15 minutes
	\|-		\|-
	\| '''Transfer''' \|\| One message per pass that transferred at least one file, listing the files and sizes (Put Files sent, Get Files received). Passes with nothing to do send nothing; failures go to the Error list. \|\| Disabled, frequency 0		\| '''Transfer''' \|\| One message per pass that transferred at least one file, listing the files and sizes (Put Files sent, Get Files received). Passes with nothing to do send nothing; failures go to the Error list. \|\| Disabled, frequency 0

Dgarratt: Updated by push_wiki.py

2026-10-20T13:40:07Z

Updated by push_wiki.py

Show changes

Dgarratt: Updated by push_wiki.py

2026-10-14T19:13:39Z

Updated by push_wiki.py

← Older revision		Revision as of 20:13, 14 October 2026
Line 84:		Line 84:
	! Tab !! Settings		! Tab !! Settings
	\|-		\|-
	\| '''SFTP''' \|\| Title, SFTP host and port, known hosts handling, authentication type, username and password, private and public key files, email, daily statistics and web log viewer switches, ~~application~~ password. Saved in <code>sftp_common.xml</code>.		\| '''SFTP''' \|\| Title, SFTP host and port, known hosts handling, authentication type, SFTP username and password, private and public key files, email, daily statistics and web log viewer switches, settings password. Saved in <code>sftp_common.xml</code>.
	\|-		\|-
	\| '''Put Properties''' \|\| Upload settings. Saved in <code>sftp_put.xml</code>.		\| '''Put Properties''' \|\| Upload settings. Saved in <code>sftp_put.xml</code>.
Line 155:		Line 155:
	\| Authentication Type \|\| <code>user password</code> or <code>user public key</code>.		\| Authentication Type \|\| <code>user password</code> or <code>user public key</code>.
	\|-		\|-
	\| Username, Password \|\| SFTP login. The password is set with the Assign SFTP user password button and stored encrypted.		\| SFTP Username, SFTP Password \|\| SFTP login. The password is set with the Assign SFTP user password button and stored encrypted.
	\|-		\|-
	\| Private Key File, Public Key File, Key Comment, Private Key Password \|\| Key pair for public key authentication (default <code>./ssh/sftpTransfer</code> and <code>.pub</code>). The Create button generates a new pair. The key password is set with its Assign button and stored encrypted.		\| Private Key File, Public Key File, Key Comment, Private Key Password \|\| Key pair for public key authentication (default <code>./ssh/sftpTransfer</code> and <code>.pub</code>). The Create button generates a new pair. The key password is set with its Assign button and stored encrypted.
Line 165:		Line 165:
	\| Web Log Viewer, Port \|\| Serves the logs as a read-only web page, see [[#Web Log Viewer\|Web Log Viewer]]. Default off, port 8080.		\| Web Log Viewer, Port \|\| Serves the logs as a read-only web page, see [[#Web Log Viewer\|Web Log Viewer]]. Default off, port 8080.
	\|-		\|-
	\| ~~Application Password~~ \|\| Optional. When set, the desktop window asks for it at start-up. Set and cleared with its own buttons.		\| SettingsPassword \|\| Optional. When set, the desktop window asks for it at start-up before the settings can be seen or changed. Set and cleared with its own buttons.
	\|-		\|-
	\| Log Level \|\| The desktop log level, written whenever the combo is changed.		\| Log Level \|\| The desktop log level, written whenever the combo is changed.
Line 442:		Line 442:
	! Method !! How to configure		! Method !! How to configure
	\|-		\|-
	\| User password \|\| Authentication Type <code>user password</code>. Enter the Username and set the Password with its Assign button.		\| User password \|\| Authentication Type <code>user password</code>. Enter the SFTP Username and set the SFTP Password with its Assign button.
	\|-		\|-
	\| User public key \|\| Authentication Type <code>user public key</code>. Point Private Key File and Public Key File at an existing pair, or press Create to generate a pair and then install the public key on the server yourself. If the private key is passphrase protected, set the passphrase with the Private Key Password Assign button.		\| User public key \|\| Authentication Type <code>user public key</code>. Point Private Key File and Public Key File at an existing pair, or press Create to generate a pair and then install the public key on the server yourself. If the private key is passphrase protected, set the passphrase with the Private Key Password Assign button.
Line 453:		Line 453:
	=== Password Encryption ===		=== Password Encryption ===

	The SFTP password, the private key passphrase, the SMTP password and the ~~application~~ password are stored encrypted in the XML files. They are set through the desktop window: each password field has an Assign button that opens a dialog, and the encrypted value is written when settings are applied. Plain text passwords are never stored. The encrypted values are specific to SFTPTransfer and cannot be copied from the configuration of other Commander4j programs.		The SFTP password, the private key passphrase, the SMTP password and the settings password are stored encrypted in the XML files. They are set through the desktop window: each password field has an Assign button that opens a dialog, and the encrypted value is written when settings are applied. Plain text passwords are never stored. The encrypted values are specific to SFTPTransfer and cannot be copied from the configuration of other Commander4j programs.

	== Thread Architecture ==		== Thread Architecture ==

Dgarratt: Updated by push_wiki.py

2026-10-14T18:43:47Z

Updated by push_wiki.py

← Older revision		Revision as of 19:43, 14 October 2026
Line 444:		Line 444:
	\| User password \|\| Authentication Type <code>user password</code>. Enter the Username and set the Password with its Assign button.		\| User password \|\| Authentication Type <code>user password</code>. Enter the Username and set the Password with its Assign button.
	\|-		\|-
	\| User public key \|\| Authentication Type <code>user public key</code>. Point Private Key File and Public Key File at an existing pair, or press Create to generate ~~one~~ and install the public key on the server. If the private key is passphrase protected, set the passphrase with the Private Key Password Assign button.		\| User public key \|\| Authentication Type <code>user public key</code>. Point Private Key File and Public Key File at an existing pair, or press Create to generate a pair and then install the public key on the server yourself. If the private key is passphrase protected, set the passphrase with the Private Key Password Assign button.
	\|}		\|}

Dgarratt: Updated by push_wiki.py

2026-10-14T18:41:46Z

Updated by push_wiki.py

Show changes

Dgarratt at 17:53, 24 April 2026

2026-04-24T17:53:51Z

← Older revision		Revision as of 18: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 17: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 14: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 ==