Excel Spreadsheet Automation with the QUERY Formula

The CData Excel Add-In for FTP provides formulas that can edit, save, and delete FTP data. The following three steps show how you can automate the following task: Search FTP data for a user-specified value and then organize the results into an Excel spreadsheet.

The syntax of the CDATAQUERY formula is the following: =CDATAQUERY(Query, [Connection], [Parameters], [ResultLocation]);

This formula requires three inputs:

• Query: The declaration of the FTP data records you want to retrieve or the modifications to be made, written in standard SQL.

• Connection: Either the connection name, such as FTPConnection1, or a connection string. The connection string consists of the required properties for connecting to FTP data, separated by semicolons.

  To connect to FTP or SFTP servers, specify at least RemoteHost and FileProtocol. Specify the port with RemotePort.

  Set User and Password to perform Basic authentication. Set SSHAuthMode to use SSH authentication. See the Getting Started section of the data provider help documentation for more information on authenticating via SSH.

  Set SSLMode and SSLServerCert to secure connections with SSL.

  The data provider lists the tables based on the available folders in your FTP server. 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 folders to list as views.
  • FileRetrievalDepth: Set this to retrieve and list files recursively from the root table.

  Stored Procedures are available to download files, upload files, and send protocol commands. See the Data Model chapter of the FTP data provider documentation for more information.

• ResultLocation: The cell that the output of results should start from.

Pass Spreadsheet Cells as Inputs to the Query

The procedure below results in a spreadsheet that organizes all the formula inputs in the first column.

1. Define cells for the formula inputs. In addition to the connection inputs, add another input to define a criterion for a filter to be used to search FTP data, such as FilePath.
2. In another cell, write the formula, referencing the cell values from the user input cells defined above. Single quotes are used to enclose values such as addresses that may contain spaces.
=CDATAQUERY("SELECT * FROM MyDirectory WHERE FilePath = '"&B2&"'","RemoteHost="&B1&";Provider=FTP",B3)
3. Change the filter to change the data.