Connecting to SFTP

Concept Information

ACCESSDATA command

SFTP is a secure file transfer protocol that uses Secure Shell Protocol (SSH). You can use the SFTP data connector to import your organization's SFTP data.

Note

The SFTP data connector can be used to import file types with extensions .xlsx and csv only. Script support for this connector may also be limited.

Before you start

To connect to SFTP, you must gather the following:

  • the credentials to connect to the SFTP server
  • the host name or IP address of the SFTP server
  • the correct connection port
  • the path in the SFTP server

For help gathering the connection prerequisites, contact the SFTP administrator in your organization. If your administrator cannot help you, you or your administrator should contact SFTP Support.

Create an SFTP connection

  1. From the Analytics main menu, select Import > Database and application.
  2. From the New Connections tab, in the ACL Connectors section, select SFTP.

    Tip

    You can filter the list of available connectors by entering a search string in the Filter connections box. Connectors are listed alphabetically.

  3. In the Data Connection Settings panel, enter the connection settings and at the bottom of the panel, click Save and Connect.

    You can accept the default Connection Name, or enter a new one.

The connection for SFTP is saved to the Existing Connections tab. In the future, you can reconnect to SFTP from the saved connection.

Once the connection is established, the Data Access window opens to the Staging Area and you can begin importing data. For help importing data from SFTP, see Working with the Data Access window.

Connection settings

Basic settings

Setting Description Example
User The user account to authenticate against the SFTP server.  
Password The password used to authenticate the user with the SFTP server.  
Host The host name or IP address of the instance running the SFTP server. https://sftp.abc.com/
Port The port for the SFTP server. 443
Path

The current working directory on the SFTP server. You can change the working directory by setting it to an absolute directory path or a relative path with respect to the existing value of this property.

 

Advanced settings

Setting Description Example
Limit Key Size The maximum length of a primary key column. 255
Map To Long Varchar This property controls whether a column is returned as SQL_LONGVARCHAR or not. -1
Map To WVarchar This property controls whether string types map to SQL_WVARCHAR instead of SQL_VARCHAR.  
Pseudo Columns

This property indicates whether to include pseudo columns as columns to the table.

The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3".

 
SSL Server Certificate

The certificate that must be accepted from the server when connecting using SSL.

You can provide any of the following:

  • a full PEM certificate
  • path to a local file containing the certificate
  • public key
  • MD5 or SHA1 thumbprint (hex values can also be either space or colon separated)

Any other certificate that is not trusted by the machine is rejected.