Import SFTP Data into Microsoft Power Query

The Connect Server enables you to use Web services to connect to and query SFTP data. This article details how to import an OData feed of SFTP data into Microsoft Power Query.

Connect to SFTP from Power Query

To work with live SFTP data in Microsoft Power Query, we need to connect to SFTP from Connect Server, provide user access to the new virtual database, and create OData endpoints for the SFTP data.

Add a Connect Server User

Create a User to connect to SFTP from Microsoft Power Query through Connect Server.

1. Click Users -> Add
2. Configure a User
3. Click Save Changes and make note of the Authtoken for the new user

Connect to SFTP from Connect Server

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Open Connect Server and click Connections
2. Select "SFTP" from Available Data Sources
3. Enter the necessary authentication properties to connect to SFTP.

   SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

   Set the following connection properties to control the relational view of the file system:

   • RemotePath: Set this to the current working directory.
   • TableDepth: Set this to control the depth of subfolders to report as views.
   • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
   Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions (SELECT is all that is required for Reveal).

Add SFTP OData Endpoints in Connect Server

After connecting to SFTP, create OData Endpoints for the desired table(s).

1. Click OData -> Tables -> Add Tables
2. Select the SFTP database
3. Select the table(s) you wish to work with and click Next
4. (Optional) Edit the resource to select specific fields and more
5. Save the settings

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in OData -> Settings.

• Enable cross-origin resource sharing (CORS): ON
• Allow all domains without '*': ON
• Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
• Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Connect to SFTP Data from Power Query

Follow the steps below to import tables that can be refreshed on demand:

1. Configure the Connect Server to use a version of the OData protocol that is recognized by Power Query. In the Connect Server administration console, click Settings -> Server and change the value of the Default Version property to 3.0.

2. From the ribbon in Excel, click Power Query -> From Other Data Sources -> From OData Feed, and enter the OData URL:

   https://your-server:8032/api.rsc

3. Next, define authentication credentials and set privacy levels. Select Basic authentication and enter the credentials for a user authorized to make requests. Specify the Username field and enter the user's authtoken in the Password field.

   To change the authentication scheme that Power Query will use, click Power Query -> Data Source Settings. Select the OData feed from the list and then click "Edit Permissions..." Select the privacy level from the menu.

4. You can now access SFTP data in Power Query. In the Navigator expand the node for the OData feed, right-click a table, and click Edit to open the Query Editor. This will display the table data.

Free Trial & More Information

If you are interested in connecting to your SFTP data (or data from any of our other supported data sources) from Power Query, sign up for a free trial of CData Connect Server today! For more information on Connect Server and to see what other data sources we support, refer to our CData Connect page.