DataBind Wijmo Grid to Drift Data

The API Server, when paired with the ADO.NET Provider for Drift (or any of 200+ other ADO.NET Providers), provides Drift data as Web services, which enable connectivity to live data. This article shows how to consume JSONP-formatted Drift data from a Wijmo Grid.

Set Up the API Server

Follow the steps below to begin producing secure Drift OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Drift

After you deploy the API Server and the ADO.NET Provider for Drift, provide authentication values and other connection properties needed to connect to Drift by clicking Settings -> Connections and adding a new connection in the API Server administration console.

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.

You can then choose the Drift entities you want to allow the API Server to access by clicking Settings -> Resources. This article uses Contacts as an example.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Create a Real-Time Grid

Follow the steps below to consume Drift data from the Wijmo JavaScript controls:

1. Load the required Wijmo, jQuery, and Knockout libraries:

   
   <script src="http://code.jquery.com/jquery-1.11.1.min.js"></script>
   <script src="http://code.jquery.com/ui/1.11.0/jquery-ui.min.js"></script>
     
   <!--Theme-->
   <link href="http://cdn.wijmo.com/themes/aristo/jquery-wijmo.css" rel="stylesheet" type="text/css">
     
   <!--Wijmo Widgets CSS-->
   <link href="http://cdn.wijmo.com/jquery.wijmo-pro.all.3.20161.90.min.css" rel="stylesheet" type="text/css">
     
   <!--Wijmo Widgets JavaScript-->
   <script src="http://cdn.wijmo.com/jquery.wijmo-open.all.3.20161.90.min.js"></script>
   <script src="http://cdn.wijmo.com/jquery.wijmo-pro.all.3.20161.90.min.js"></script>
   <script src="http://cdn.wijmo.com/interop/wijmo.data.ajax.3.20161.90.js"></script>
    
   <!--Knockout JS Library-->
   <!-- Both of the links below can work -->
   <script src="http://cdn.wijmo.com/wijmo/external/knockout-2.2.0.js"></script> 
   <!--<script src="http://cdn.wijmo.com/amd-js/3.20161.90/knockout-3.1.0.js"></script>--> 
   
   <!--Wijmo Knockout Integration Library-->
   <script src="http://cdn.wijmo.com/interop/knockout.wijmo.3.20161.90.js"></script>
   

2. Create a ViewModel and connect to it using the ODataView. You will need to replace the placeholder values for the URL of the API Server, an API Server user, and the authtoken for that user.

   
   <script id="scriptInit">
   $.support.cors = true;
   var viewModel;
   
   function ViewModel() {
     var contactsView = new wijmo.data.ODataView("http://MyServer:MyPort/api.rsc/Contacts", {
     ajax: {
       dataType: "jsonp", 
       username: "MyUser",
       password: "MyAuthtoken",
       data: { "$inlinecount": null }
     },
     pageSize: 10
   });
     contactsView.refresh();
     contactsView.nextPage();
     this.contacts = contactsView;
     this.prevPage = function () {contactsView.prevPage();};
     this.nextPage = function () {contactsView.nextPage();};
   }
   
   $(document).ready(function () {
      viewModel = new ViewModel();
      ko.applyBindings(viewModel, $(".container").get(0));
   });
   </script>
   

3. DataBind: Below is a simple table with some paging buttons, which you can paste into the body section of your markup.

   
   <h2>Connect to Live Drift Data in Real Time</h2>
   
   <h3>Contacts</h3>
   <div>
     <button title="previous page" class="pagebuttons" data-bind="click: prevPage, button: {}"><span class="ui-icon ui-icon-seek-prev" /></button>
     <button title="next page" class="pagebuttons" data-bind="click: nextPage, button: {}"><span class="ui-icon ui-icon-seek-next" /></button>
   </div>
   <table id="demo-grid" data-bind="wijgrid: { 
     data: contacts, 
     showFilter: true, 
     allowPaging: true,
     pagerSettings: { position: 'none'},
     columnsAutogenerationMode: 'append',
   }" >
   </table>   
   

Below is the resulting grid. You can filter and sort through pages of Drift data.