Skip to main content
waffle.svg
Domo Knowledge Base

SFTP Writeback Connector

Version 3

 

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.

Prerequisites

To configure this connector, you will need the following:

  • A Domo Client ID and Client Secret. To obtain these credentials, do the following:

    1. Log into your Domo developer account at https://developer.domo.com/login

    2. Create a new client

    3. When selecting the desired data and user application scope, make sure to check the boxes for both Data and User.  

    4. Click Create.

  • Your SFTP server hostname.

  • Your SFTP server port number.

  • Your SFTP server username and password. 

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

Port

Enter your SFTP server port number.

Username

Enter your SFTP server username.

Password

Enter your SFTP server password. 

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

Path

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

Select Filename

Select whether you want to reference your DataSet using the Input DataSet ID or an output file name. 

Filename

Enter the output file name for your data. 

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.