› AutoStore › Route Components › Send to SFTP › Configuring Send to SFTP › Add/Edit Site Configuration dialog box

Add/Edit Site Configuration dialog box

Use this dialog box to add or edit SFTP site configuration.

SFTP authentication methods

SFTP (Secure File Transfer Protocol) provides several authentication methods to securely authenticate users and manage file access, allowing organizations to choose the best-suited option for their needs.

  • Password Authentication: Password Authentication is the traditional authentication method. Users authenticate by entering a username and password. This method is often used in smaller setups or environments where convenience is proiritized over security. To use Password Authentication method:
    • Provide a username in the User name field
    • Provide the username password in the Password field
  • Public Key Authentication: Public Key Authentication involves a public and private key pair. The public key is stored on the server while the private key remains securely with the user. Users authenticate by proving ownership of the private key rather than entering a password. This method is frequently used in corporate environments, particularly for remote access and automated file transfers, and allows users to implement single sign-on across the SSH servers to which they connect. To use Public Key Authentication method:
    • Provide a username in the User name field
    • Select the Certificate based authentication checkbox
    • Enter a private key file in the Private key file field
    • Provide the private key password to the Key file password field
    • Configuring an SSH host fingerprint is optional but recommended in production envinronments for security reasons.
  • Multi-Factor Authentication: Multi-Factor Authentication (Public Key Authentication method plus a password) combines two or more authentication factors (e.g., user password and private key passphrase). This mode is common in high-security environments or for sensitive data transfers. To use Multi-Factor Authentication method:
    • Configure settings as described for Public Key Authentication method
    • Enter the username password in the Password field
Option Description
Site name Enter the name of an SFTP site.
Server address Enter the IP address or the server name of the SFTP site. This field is mandatory.
Port Enter the port number that will be used by the component to establish connection to the SFTP server. The default port number is 22.
User name Enter the username of the client who will have access rights to the SFTP site. This field is mandatory.
Obtain password via RRT Select this checkbox if you want to obtain the password via Runtime Replacement Tag (RRT) at run time.
Password Enter the password for the specified username. This field is mandatory, except when using Public Key Authentication method. This value will be only used in case Obtain password via RRT checkbox is not selected.
Password RRT Enter an expression consisting of RRTs that will be replaced by the actual password at run time. This value will be only used in case Obtain password via RRT checkbox is selected.
Certificate based authentication Select this checkbox if you want to use Public Key Authentication method or Multi-Factor Authentication method.
Key file password Provide the private key password (or passphrase).
Private key file Add the private key file (PPK format is supported).
SSH host fingerprint This field is optional but recommended in production envinronments for security reasons. If you do not specify an SSH host fingerprint, all SSH host fingerprints will be accepted. See the WinSCP documentation for how to get the SSH host fingerprint.
Destination folder path Enter the folder where the documents will be stored on the SFTP server. If you specify a new folder in this field, it will be created on the SFTP server. However, if you do not specify a path or folder name, the data is stored in the root directory of the SFTP server.
Advanced Click this button to test sending data to the SFTP server. This button opens the Advanced Settings dialog box.
Test Click this button to configure and run the test of the connection to the specified SFTP site. This button opens the Run Test dialog box.
Overwrite destination file if file exists Select this checkbox to overwrite the file if it already exists. If you do not select this option, the file will not be overwritten, and respective error message will appear in the Status Monitor.
Rename file Select this checkbox if you want the output file to be renamed. The Schema field becomes enabled.
Schema Enter the schema name for the output file name. You can use RRTs to dynamically set the value of the schema.
The default schema is ~STF::FileName~_~STF::Counter~~STF::FileExt~. For example, if the input file name is File.tif, the renamed file will be File_1.tif.