Search Results

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.


The General tab has the following fields.

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


Refer to the following table for the details.

Field Datatype Literal Value/Module Property Description
Host string Yes The host name or IP address of the SFTP server.
Port integer 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 The user name to log on to the SFTP server.
Password password Yes The password to use when logging on to the SFTP server when password supported authentication is used.
Connection Timeout (msec) integer Yes 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.

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.