Intro
A character-separated values (CSV) file stores tabular data in plain text form. The Domo CSV Advanced connector allows you to access CSV files that you have uploaded to an SFTP server. You can also import files via HTTPS calls.Primary Use Cases | Use this connector to access CSV files from an SFTP server. |
Primary Metrics | N/A |
Primary Company Roles | Analysts |
Average Implementation Time | 1 hour |
Ease of Use (on a 1-to-10 scale with 1 being easiest) | 4 |
Best Practices
If you are using SFTP, make sure your credentials are ready and verified via your SSH key. The accepted formats for the key are either DES or RSA. If you are using HTTPS, you only need to verify that your resource is protected.Prerequisites
If you plan to access CSV files by connecting to an SFTP server, you must have a username and password to authenticate to that server. If you plan to access CSV files over HTTPS, credentials are required only if the resource is protected. You need the username and password associated with your CSV file. You also your SSH key and the passphrase for your ssh key.Connecting to CSV Files
This section enumerates the options in the Credentials, Details, and Advanced panes in the CSV Advanced Connector page. 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 Data Connector.Credentials Pane
In this pane you may need to enter a username and password, depending on what protocol you are using to access CSV data and whether the data is protected. If you plan to access CSV files by connecting to an SFTP server, you must enter the credentials for that server here (username, password, and host name). If you plan to access files over HTTPS, you only need to enter credentials if the resource is protected. You must also whitelist the IP addresses from the following article on the server: Whitelisting IP Addresses for Connectors. In either case, once you click Next, this CSV account is saved and you can use the same account any time you go to create a new CSV Advanced DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors. You may also have the option to import the CSV file from a URL. If this is the case, you need the URL and potentially a username and password, depending on whether the source requires them.Details Pane
In this pane you choose a protocol (HTTP request or SFTP file transfer) then fill in the details for that protocol. This pane includes the following fields and menus:Menu | Description |
|---|---|
Select the Protocol to access the CSV File | Select a protocol for accessing the CSV file. Use SFTP to access a CSV file located on an SFTP server. Use HTTP Request to access a CSV file using an HTTP GET request. The request is triggered by the use of a unique URL parameter defined by the service providing the CSV file. |
Enter the URL to your CSV file | Enter the URL for the CSV file. If using the File Transfer protocol, enter the URL to the folder containing the CSV file. For example: s ftp://hostname/home/test . You’ll also have to include the port in the URL if the SFTP server is not configured to run on the standard port 22. The 1234 port specific URL would look like s ftp://hostname:1234/home/test Note: Due to security concerns, Domo no longer permits uploading data using FTP. If necessary, please update your server settings to support SFTP instead of FTP. If using the HTTP Request protocol, enter the full URL for the CSV file. You must provide the URL as well as the fully qualified path, including the filename. For example: http://www.ferc.gov/docs-filing/eqr/…v/contract.txt If you are using the SFTP protocol, you can request a file for a specific date. You need to name your file using the format |
Would you like to enter a file name to search for or select a file to retrieve every time | Select whether you want to select a specific file from the specified directory or search for a file name. |
Enter File Name | Enter the name of the file to import into Domo. To import the most recently modified file, add [latest] to the file name prefix. |
File Name Match Type | Select the file name match type. Note:: If you select File Name Contains String or File Name Starts With String, the most recently uploaded file is retrieved. |
Select a file from the above directory | Select a file from the specified directory. You can select a CSV, TXT or GZ file to parse or a ZIP file to unzip. |
Select a file type | Select the file type for the file you want to access. |
Enter the CSV file from the zip archive | Enter the CSV file to parse from the zip file. |
Select a file from the Zip archive | Select a CSV file to parse from the unzip folder. |
Enter a filename from inside the Zip archive | Enter the name of the file to parse from the ZIP archive. If you leave this field blank, the first file found is processed. |
HTTP Headers | Enter additional headers for your HTTP/HTTPS CSV URL, if necessary. Use the format header Name1 = ‘headerValue1’ and headerName2 = ‘headerValue2’ . |
HTTP Body | Enter additional request body for your HTTPS CSV URL, if necessary. |
Date Format | Select the required date format. Use this option to correct incorrectly formatted dates. |
Add file name column | Adds the retrieved file name to the dataset in the BATCH_FILE_NAME column. If you select this option, only columns in the header row are used. Data without a column name in the header row is excluded. A blank column name is considered a column name. |
| Convert Double type to Decimal | Select this checkbox to convert Double to Decimal. |
| Update only if the source file is modified | Choose whether to retrieve and update data only if the source file has changed since the last execution. |
| Cast Columns to String Datatype | Enter a comma separated list of fields that need to be treated as STRING in Domo. |
Advanced Pane
In this pane you select the delimiter for your CSV file.Menu | Description |
|---|---|
Delimiter Character | Select the delimiter character used to separate columns in your CSV 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 Data Connector.Troubleshooting
- Verify that your credentials are correct.
- If you cannot connect using SFTP, check your firewall settings.
FAQ
Does the connector support connecting to an FTPS server?
Does the connector support connecting to an FTPS server?
How frequently will my data update?
How frequently will my data update?
Are there any API limits that I need to be aware of?
Are there any API limits that I need to be aware of?
Can I use the same CSV Advanced account for multiple datasets?
Can I use the same CSV Advanced account for multiple datasets?
What do I do if I cannot connect using SFTP?
What do I do if I cannot connect using SFTP?