Viewing CleverPush Data in RAD Studio Data Explorer

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
How to view CleverPush data in RAD Studio Data Explorer using the CData ODBC Driver for CleverPush.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for CleverPush, you gain access to live CleverPush data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve CleverPush data. This article will walk through connecting to CleverPush using the Data Explorer.

Configure a Connection to CleverPush

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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

Cleverpush API Profile Settings

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your CleverPush private API key.

Optional Connection Properties

  • ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Connecting to CleverPush Data Using Data Explorer

You can create a simple application for displaying CleverPush data by utilizing the CData FireDAC Components for CleverPush and a new VCL Forms Application:

  1. Open the Data Explorer in RAD Studio and expand FireDAC.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection. Adding a New Connection. (Salesforce is shown.)
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for CleverPush. Setting the Connection Parameters. (Salesforce is shown.)
  6. Back in the Data Explorer, expand the views for the connection.
  7. Create a new VCL Forms application and drag a view (for example: Segments) onto the form.

    Placing the View on the Form. (Salesforce is shown.)
  8. Select the SegmentsView object on the form and set the Active property to true.
  9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

    Visually Binding the View. (Salesforce is shown.)
  10. Arrange the TStringGrid on the form and run the application to see the Segments data.

    The View data on a Form. (Salesforce is shown.)

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

Ready to get started?

Connect to live data from CleverPush with the API Driver

Connect to CleverPush