SFTP Connection

The SFTP Connection shared resource describes a connection to an SFTP server. SFTP connections are used when configuring activities in the SFTP palette.

General

The General tab has the following fields.

Field	Visual Difference?	Description
Package	Yes	The name of the package.
Name	Yes	The name to be displayed as the label for the shared resource.
Description	Yes	Short description of the shared resource.

Field

Visual

Difference?

Description

Package

Yes

The name of the package.

Name

Yes

The name to be displayed as the label for the shared resource.

Description

Yes

Short description of the shared resource.

SFTPConnection

Refer to the following table for the details.

Field	Datatype	Literal Value/Module Property	Visual Difference?	Description
Host	string	Yes	Yes	The host name or IP address of the SFTP server.
Port	integer	Yes	Yes	The port number of the SFTP server. For SFTP connections, '22' is the default, when no value is specified in this field.
User Name	string	Yes	Yes	The user name to log on to the SFTP server.
Password	password	Yes	Yes	The password to use when logging on to the SFTP server when password supported authentication is used.
Two Factor Authentication		No	No	Select this check box to connect to an SFTP server which is configured with two factor authentication, password authentication and public key authentication. Note: When this checkbox is selected, the Public Key Authentication checkbox will be disabled as public key authentication is mandatory for two factor authentication. Note: If an SFTP server is not configured with two factor authentication, but is configured with either password or public key authentication, then selecting this checkbox and specifying the values for both password and public key would also establish a successful connection.
Public Key Authentication		No	No	Select this check box to specify the private key, when using private key supported authentication. This check box when selected, displays the Private Key and Private Key Password fields.
Private Key	string	Yes	No	The private key to authenticate your login. It should be in open SSH format. It is recommended that you use password protected private keys. The password and private-key are the preferred methods of authentication when using the SFTP module. Note: It is recommended to configure the PrivKey path located out of the project to maintain privacy. Ensure that the private key file exists in the same project as the shared resource. You can set the relative path of the file using the Browse Workspace option from the Resource Picker.
Private Key Password	password	Yes	No	The password of the private key. It is applicable only when private key supported authentication is used.
Strict HostKey Check		No	No	When selected, it connects only to known hosts with valid host keys that are stored in the known host file. Host keys not listed in the known host list are rejected. It verifies the incoming host key against the keys in the known hosts list. If the host key does not match an existing known host entry for the remote server, the connection is rejected. When not selected, the client does not verify the server's host key entry into the know host file while establishing the connection. Note: This option can be selected with Password authentication, Two Factor Authentication or Public Key Authentication methods.
Known Host File	string	Yes	No	Contains the public keys with corresponding Host IP address for all hosts with which the client can communicate. This field is available only when Strict HostKey Check check box is selected. Configure the path of known_host file in this field. Known_Host_File does not exist - Browse using the Choose a resource and select the folder you want to generate the known_host file. Note: It is recommended to configure the Known_ Host file path located out of the project to maintain privacy. Known_Host_File exists - Import the file with any preferred name within the project to use as known_host file. You can browse Known Host file with .txt extension in BusinessWorks workspace.
Connection Timeout (msec)	integer	Yes	No	The timeout specified in this field (in milliseconds) applies to the following situations: Making the socket connection to the SFTP Server. Reading a reply from the socket after sending a SFTP control command. Reading data from the socket. If the specified time is reached when attempting any of these operations, the activity using this SFTP Connection terminates with a Connection Timeout error.
Setup Host Public Key		No	No	Click to install the Host Key with the corresponding Host IP into the Known Host File. This field is available only when Strict HostKey Check check box is selected.

Test Connection Button

When the Test Connection button is clicked, TIBCO ActiveMatrix BusinessWorks attempts to connect to the specified remote SFTP server on the specified port using the specified user name, and password. Use this button to determine if the specified connection configuration is correct and valid.