Skip to main content

​
Intro

Use this connector to export your data from a Domo DataSet to an SFTP server. To learn more about SFTP, visit the Wikipedia page at https://en.wikipedia.org/wiki/SSH_Fi…nsfer_Protocol. You export data to an SFTP server in the Data Center. This topic discusses the fields and menus that are specific to the SFTP Writeback connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.
Note: The owner of a writeback dataset must also be an owner or co-owner of the input dataset.

​
Prerequisites

To configure this connector, you will need the following:
  • A Domo Client ID and Client Secret.
  • Your SFTP server hostname.
Important: The SFTP Server host name must have sftp:// in the beginning of the URL and should not end with a front slash (/).
  • Your SFTP server port number.
  • Your SFTP server username and password.
  • Your SFTP server SSH private key.
  • The passphrase for your SSH private key.
Note: Domo does not support the SSH keys generated using ssh-keygen. The SSH keys need to be the DES or RSA keys (in PEM format) generated by OpenSSL.
OpenSSH private key format can be converted using ssh-keygen utility to the old PEM format. 
ssh-keygen -p -m PEM -f ~/.ssh/id_rsa
This will update the same file with the RSA key.

​
To obtain your Domo Client ID and Client Secret, do the following:

  1. Login to Domo developer account
  2. In the top right corner under My Account, click New Client.
  3. Enter the application name and description.
  4. Provide the application scope by selecting Account, Data, and User.
  5. Click Create.
  6. Once you have created a client, you can manage the client by clicking on Manage Client.
  7. Your Client Secret will appear in the Manage Client section.

​
Configuring the Connection

This section enumerates the options in the Credentials and Details panes in the SFTP Writeback 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

This pane contains fields for entering credentials to connect to your Domo developer account as well as your SFTP server. Depending on the configuration of the SFTP server, you may need either a Private Key and Passphrase, username and password, or both. The following table describes what is needed for each field:

Field

Description

Domo Client ID

Enter your Domo client ID.

Domo Client Secret

Enter your Domo client secret.

Hostname

Enter your SFTP server hostname.

Important: The SFTP Server host name must have sftp:// in the beginning of the URL and should not end with a front slash (/) .

Port

Enter your SFTP server port number.

Username

Enter your SFTP server username.

Password

Enter your SFTP server password.

SSH Private Key

Enter your SFTP server SSH private key (RSA).

Passphrase

Enter the passphrase for your SSH private key.

Once you have entered valid credentials, you can use the same account any time you go to set up a new Domo-SFTP connection. 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.

​
Details Pane

This pane contains a number of fields for specifying your data and indicating where it’s going.

Menu

Description

Input DataSet ID

Enter the DataSet ID (GUID) for the DataSet you want to copy to the SFTP server. You can find the ID by opening the details view for the DataSet in the Data Center and looking at the portion of the URL following datasources/ . For example, in the URL https://mycompany.domo.com/datasources/845305d8-da3d-4107-a9d6-13ef3f86d4a4/details/overview , the DataSet ID is 845305d8-da3d-4107-a9d6-13ef3f86d4a4.

Note: You must either own this DataSet or have the Admin role in Domo.

Path

Enter the path in your SFTP server where you would like the data to be saved.

Select the Filename

Select the output filename.

If you choose Use Input Dataset Name and your dataset name contains a macro <current_date>, then the connector will replace <current_date> with today’s date in the format selected from the Date Format dropdown.

Filename

Enter the output file name for your data.

If you wish to add the current date to the file name, then use the <current_date> macro.
For example: If the file name is domo_<current_date> , then the output file generated in SFTP would be domo_(today’s date in the format selected from the Date Format dropdown). If the Date Format is selected as MMddyyyy_HHmmss , the output file generated would be domo_05162021_161244 .

You also have the option to fetch the data any number of days back from the current date.

For example, if you want to fetch yesterday’s data, then you need to enter the file name as domo_<current_date-1> , and the format of the output file generated in SFTP would be domo_date format selected for previous day from Date Format drop-down.

  • domo_<current_date-2> - fetches the data the day before yesterday.
  • domo_<current_date-3> - fetches the data two day’s before with respect to the current date.
Note: Your output file is stored as a CSV file. You do not need to add the extension onto your file name.

Date Format

Select the date format for the macro replacement in the filename. This option is only applicable when the ‘File Name’ or ‘Input Dataset Name’ contains &ltcurrent_date&gt.

Include Advanced Function

Select this checkbox to include the Advanced Functions.

File Extension

This field appears when you select the Include Advanced Functions checkbox.

Select the extension you want to use for your output file.

Enter File Extension

This field appears when you select the Include Advanced Functions checkbox and the File Extension as User Defined Extension .

Enter the file extension.

Delimiter

This field appears when you select the Include Advanced Functions checkbox.

Select the character to be used as a delimiter for your output file.

Enter Delimiter

This field appears when you select the Include Advanced Functions checkbox and the Delimiter as Other .

Enter the character to be used as a delimiter for your output file.

Quote Character

This field appears when you select the Include Advanced Functions checkbox.

Select the character to be used for enclosing values in your output file.

Quote Character

This field appears when you select the Include Advanced Functions checkbox and the Quote Character as Other .

Enter the character to be used as a quote character for your output file.

Line Feed Delimiter

This field appears when you select the Include Advanced Functions checkbox.

Select the character to be used as a line feed delimiter in your output file.

Line Feed Delimiter

This field appears when you select the Include Advanced Functions checkbox and the Line Field Delimiter as Other .

Enter the character that should be used as a line feed delimiter for your output file.

File Encoding

This field appears when you select the Include Advanced Functions checkbox.

Select the encoding scheme for your output file.

Skip Headers

Select this checkbox if you want to skip the header of your output file.

My Domo Input DataSet is very large.

Select this checkbox to export a very large DataSet from Domo to SFTP. When this checkbox is selected, the connector uses a different and faster process. The export process does not support Advanced functions.

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