Build Drift-Connected Web Apps in Servoy

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

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Drift data. When you issue complex SQL queries to Drift, the driver pushes supported SQL operations, like filters and aggregations, directly to Drift 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 Drift data using native data types.

Connect to Drift in Servoy Developer

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

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.api.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:api:Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH

        Built-In Connection String Designer

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

        java -jar cdata.jdbc.api.jar

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

        Start by setting the Profile connection property to the location of the Drift Profile on disk (e.g. C:\profiles\Drift.apip). Next, set the ProfileSettings connection property to the connection string for Drift (see below).

        Drift API Profile Settings

        Drift uses OAuth-based authentication.

        You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

        After setting the following options in the ProfileSettings connection property, you are ready to connect:

        • AuthScheme: Set this to OAuth.
        • OAuthClientId: Set this to the Client Id that is specified in your app settings.
        • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
        • CallbackURL: Set this to the Redirect URI you specified in your app settings.
        • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
      • Select the Driver class you just copied, for example, cdata.jdbc.api.APIDriver

Build a Drift-Connected Web App

Once you have configured the connection to Drift in the Servoy Developer resources, you are ready to build apps with access to live Drift 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 Drift "table" (e.g., Id from the Contacts 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 API Driver for JDBC and start building Drift-connected apps with Servoy. Reach out to our Support Team if you have any questions.