Build SFTP-Connected Web Apps in Servoy

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SFTP JDBC Driver

An easy-to-use database-like interface for Java based applications and reporting tools access to remote files and directories.



Use Servoy Developer to easily connect to SFTP data and build web apps with connectivity to live SFTP data.

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for SFTP, users can build SFTP-connected apps that work with live SFTP data. This article describes how to connect to SFTP from Servoy and build a simple web app to display and search SFTP data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SFTP data. When you issue complex SQL queries to SFTP, the driver pushes supported SQL operations, like filters and aggregations, directly to SFTP and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with SFTP data using native data types.

Connect to SFTP in Servoy Developer

To build SFTP-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for SFTP.

  1. Install the JDBC Driver.
  2. Copy the JDBC Driver JAR file. (cdata.jdbc.sftp.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
  3. Open Servoy Developer.
  4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
    1. Name the server.
    2. Click to show the advanced server settings.
      • Set the URL, for example: jdbc:sftp:RemoteHost=MyFTPServer;

        Built-In Connection String Designer

        For assistance in constructing the JDBC URL, use the connection string designer built into the SFTP JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

        java -jar cdata.jdbc.sftp.jar

        Fill in the connection properties and copy the connection string to the clipboard.

        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.

      • Select the Driver class you just copied, for example, cdata.jdbc.sftp.SFTPDriver

Build a SFTP-Connected Web App

Once you have configured the connection to SFTP in the Servoy Developer resources, you are ready to build apps with access to live SFTP data.

Create a New Solution

  1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
  2. Name the solution.
  3. Select the checkbox to include the "search" module.
  4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

  1. Name the form.
  2. Select a Datasource.
  3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

  1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.
  2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the SFTP "table" (e.g., Filesize from the MyDirectory table).

    Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

  1. Drag a Text Field component onto the Form.
  2. Right-click the Form and select "Open in Script Editor."
  3. Create a new variable (JavaScript) to hold the search value:
    var searchText = '';
    
  4. Back on the Form, in the Text Field properties:
    1. Set the "dataprovider" property to the Form variable you just created.
    2. Double-click to add a method for the onAction event.
    3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
    4. Click "OK & Show."
  5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:
    var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
    search.setSearchAllColumns();
    search.loadRecords(foundset);
    

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for SFTP and start building SFTP-connected apps with Servoy. Reach out to our Support Team if you have any questions.