Skip to main content

​
Intro

The DOMO SFTP connector enables the user to quickly get their data into Domo by capturing and processing.csv,.tsv,.txt,.xls,.xlsb and.xlsx files that have been uploaded to Domo’s SFTP server. You can connect to your SFTP account in the Data Center. This topic discusses the fields and menus that are specific to the SFTP connector user interface. To add DataSets, set update schedules, and edit DataSet information, see Adding a DataSet Using a Connector.

​
Prerequisites

To connect to your SFTP account and create a DataSet, you must have the following:
  • SFTP Hostname
  • SFTP Port
  • SFTP Username
  • SFTP Password
  • SFTP Private Key
  • Private Key Passphrase
Note: Either Password or SFTP Private Key and Private Key Passphrase are mandatory along with SFTP Hostname, SFTP Port and SFTP Username.

​
Connecting to Your SFTP Account

This section enumerates the options in the Credentials and Details panes on the SFTP Connector page. The components of the other panes on this page, Scheduling, and Name & Describe Your DataSet, are universal across most connector types and are discussed in great detail in Adding a DataSet Using a Connector.

​
Credentials Pane

This pane contains fields for entering credentials to connect to your SFTP account. The following table describes what is needed for each field:

Field

Description

SFTP Hostname

Enter your SFTP server host name.

SFTP Port

Enter the SFTP server port number. The default value is 22.

SFTP Username

Enter the SFTP Server username.

SFTP Password

Enter the SFTP server password.

SFTP Private Key

Enter the private key.

Private Key Passphrase

Enter the passphrase.

Once you have entered valid SFTP credentials, you can use the same account any time to create a new SFTP DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector/Adapter Accounts.

​
Details Pane

Menu

Description

what file type would you like to import? Select the file type you would like to import.
Directory Path Select the directory path you would like to import the file from.
Date Format

Select the date format used in the selected file. There are two formats available.

  • Month Day Year (MMDDYYYY)
  • Day Month Year (DDMMYYYY)
Enter File Name Enter the file name. The file name is case-sensitive.
File Name Match Type Select the file name match type.
File Compression Type Select the file compression type.
File Encryption Type Select the encryption method that was used to encrypt your file.
Order of Decryption And Decompression When your file is encrypted and compressed, select if you want to decrypt and then decompress or decompress and then decrypt.
PGP Private Key Enter the Private Key to decrypt the PGP encrypted file.
PGP Passphrase Enter the Passphrase used for generating the PGP public-private key pairs.
Zip Sub-File Name Enter the name of the file inside the zip archive.
Zip Sub-File Name Match Type Select the zip sub-file name match type.

​
Advanced Pane

Menu Description
Delimiter Select the desired delimiter for parsing CSV files.
Custom Delimiter Enter the desired CSV delimiter character. Enter \t for tab or Unicode chars in \uxxxx form (e.g. \u005E)
Quote Character Select the desired quote character for parsing CSV files. (A double quote is the CSV standard.
Custom Quote Character Enter the desired CSV quote character. Enter Unicode chars in \uxxxx form (e.g. \u005E).
Escape character Select the desired escape character for parsing CSV files.
Custom Escape Character Enter the desired CSV escape character. Enter Unicode chars in \uxxxx form (e.g. \u005E).
File Encoding Select file encoding. Defaults to UTF-8.
Convert big number to string Select the checkbox if you want to convert big number to string.
Use Start Row Scheme Select the checkbox if you want to specify header, data and footer row numbers.
Header Start Row Enter the number for the header row in the file. The header row is the row that contains the column names.
Data Start Row Enter the number for the first data row in the file.
Footer Enter the number of rows at the end of the file to skip. For example, to skip the last two rows you would enter.
Mode Select the mode for data ranges.
Layout Select the layout for parsing.
Column Headers Range Enter the range for the column headers. For example, A1:Z1 .
Row Headers Range Enter the range for the row headers. For example, A1:A100 .
Data Range Enter the range for the data. For example, A2:Z100 .
Sheet Name Enter the sheet name in the Excel file.
Sheet Name Match Type Select the sheet name match type.
Excel File Password Enter the password for the Excel file.

​
Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.