Skip to main content

​
Intro

A character-separated values (CSV) file stores tabular data in plain-text form. Domo provides connectors that allow you to access CSV files you have uploaded to an SFTP (Secure File Transfer Protocol) server:
  • The Domo CSV SFTP Pull connector (formerly called the “CSV-SFTP” connector) allows you to access CSV files that you have uploaded to your own SFTP server.
  • The Domo CSV SFTP Advanced Security connector allows you to access CSV files from a directory or a zip file that you have uploaded to your own SFTP server.
  • The Domo CSV SFTP Push connector allows you to capture and process CSV files that have been uploaded to Domo’s own SFTP. With this connector, Domo gives you credentials, then you push your data to Domo.
This article discusses the CSV SFTP Advanced Security connector. For information about the CSV SFTP Push connector, visit CSV SFTP Push Connector. The CSV SFTP Advanced Security connector is a “File” connector, meaning it retrieves files and output them to Domo. In the Data Center, you can access the connector page for this and other File connectors by clicking File in the toolbar at the top of the window. You connect to CSV files in the Data Center. This topic discusses the fields and menus that are specific to the CSV SFTP Advanced Security connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Connector.

​
Prerequisites

To authenticate to the SFTP server, you must have the following:
  • SFTP Host name
  • SFTP Port number
  • SFTP Server Username
  • Public Key
To obtain your Public Key:
  • Enter the host name, port number, and SFTP server username then click Generate Key.
  • Copy the Public key on to the SFTP server.
You must also whitelist the IP addresses from the following article on the server: Whitelisting IP Addresses for Connectors.

​
Connecting to CSV Files

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

​
Credentials Pane

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

Field

Description

Host Enter the name of the SFTP host you want to connect to. This must begin with sftp://. For example: sftp://hostname .
Port Enter the port number for your SFTP server.
Username Enter the username you use to authenticate to the SFTP server.
After entering the host, port, and username, click the Generate Key button. Copy your Public Key to the SFTP server. Looking to upload a CSV file but do not have an SFTP server? Take a look at our Workbench solution available for download in your Domo instance.

​
Details Pane

In this pane you choose a CSV report from the SFTP server you’ve connected to.

Menu

Description

How Would You Like To Choose Your Directory? Select how would you like to choose the directory.
Directory Select the directory that contains the file you want to access.
Enter Directory Enter the directory path.
File Type Select the file type of the file selected from the directory.
Filter Your CSV File You can select the below options to filter your CSV file.
  • Select file - You can filter from the available CSV files using the Select CSV File Name field.
  • Enter file name – You can enter the name of the specific CSV file you want to filter using the Enter CSV File Name field.
  • All matching files - Filters out all the matching CSV files.
Select CSV File Name Select the CSV file name from the drop-down list.
Enter CSV File Name Enter the file name.
File Extension You can either enter csv or txt and search for files with the.csv or.txt extension. This is an optional field.
Partial/ Complete CSV File Name Enter the CSV file name you want to match and filter using the File Name Match Criteria field.
File Name Match Criteria Select the match criteria to filter out the CSV files.
  • Exact Match - Filters for the exact CSV file(s) that match the same file name entered in the Partial/ Complete CSV File Name field.
  • Contains - Filters the CSV file(s) which contains the file name entered in the Partial/ Complete CSV File Name field.
  • Starts With - Filters the CSV file(s) that starts with the file name entered in the Partial/ Complete CSV File Name field.
  • Ends With - Filters the CSV file(s) that ends with the file name entered in the Partial/ Complete CSV File Name field.
  • Regular Expression - Filters for a regular expression. For more information refer Regular expression .
Match Case Sensitive Select this checkbox if you want to filter the CSV file(s) that matches the case sensitive of the entered file name.
Filter Your ZIP File You can select the below options to filter your Zip file.
  • Select file - You can filter from the available ZIP file(s) using the Select ZIP File field.
  • Enter file name - You can enter the name of the specific ZIP file you want to filter using the Enter ZIP File Name field.
  • All matching files - Filters out all the matching ZIP file(s).
Select ZIP File Select a CSV file to parse from the unzip folder.
Enter ZIP File Name Enter a file name to parse from the zip archive.
Partial/ Complete ZIP File Name Enter the ZIP file name that you want to match and filter using the ZIP File Name Match Criteria field.
Zip File Name Match Criteria Select the match criteria to filter for the ZIP files.
  • Exact Match - Filters for the exact ZIP file(s) that match the same file name entered in the Partial/ Complete ZIP File Name field.
  • Contains - Filters the ZIP file(s) which contains the file name entered in the Partial/ Complete ZIP File Name field.
  • Starts With - Filters the ZIP file(s) that starts with the file name entered in the Partial/ Complete ZIP File Name field.
  • Ends With - Filters the ZIP file(s) that ends with the file name entered in the Partial/ Complete ZIP File Name field.
  • Regular Expression - Filters for a regular expression. For information refer to Regular Expression .
Match Case Sensitive Select this checkbox if you want to filter the ZIP file that match the case sensitive of the entered file name.
Filter Your ZIP Sub File You can select the below options to filter your file(s) from the selected Zip file.
Select Sub File From ZIP File Select a CSV file to parse from the unzipped folder.
Enter Sub File Name From ZIP File Enter a file name to parse from the zip archive.
Enter ZIP Sub File Extension Limits the search only to files with the specified extension, for example, csv, txt, and so on.
Partial/ Complete ZIP Sub-File Name Enter the ZIP sub-file name you want to match and filter using the Zip Sub-File Name Match Criteria .
Zip Sub-File Name Match Criteria Select the match criteria to filter for the ZIP sub-files.
  • Exact Match - Filters for the exact ZIP sub-file(s) that match the same file name entered in the Partial/ Complete ZIP Sub-File Name field.
  • Contains - Filters the ZIP file(s) which contains the file name entered in the Partial/ Complete ZIP Sub-File Name field.
  • Starts With - Filters the ZIP file(s) that starts with the file name entered in the Partial/ Complete ZIP Sub-File Name field.
  • Ends With - Filters the ZIP file(s) that ends with the file name entered in the Partial/ Complete ZIP Sub-File Name field.
  • Regular Expression - Filters with a regular expression. For information refer to Regular Expression .
Match Case Sensitive Select this checkbox if you want to filter the ZIP sub-files that match the case sensitive of the entered file name.
Delimiting Character Select the delimiting character used in your file. If your delimiter is not listed, then select ‘Other.’
Specify your delimiter Enter the character used to delimit your character separated values (CSV) text.
Quote Character Select the desired quote character for parsing CSV files. Double quote is the CSV standard default quote character.
Custom Quote Character Enter the desired CSV Quote character.
Escape Character Select the desired escape character for parsing CSV files.
Custom Escape Character Enter the desired CSV escape character.
File Encoding Select the file encoding.

​
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.