VOOZH about

URL: https://www.cdata.com/kb/tech/discourse-odbc-rad-data-explorer.rst

โ‡ฑ Viewing Discourse Data in RAD Studio Data Explorer


Viewing Discourse Data in RAD Studio Data Explorer

๐Ÿ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
How to view Discourse data in RAD Studio Data Explorer using the CData ODBC Driver for Discourse.

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

Configure a Connection to Discourse

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.

The Discourse API uses API Key authentication.

Using API Key Authentication

Discourse requires API Key and Username for authentication. API Keys are generated in the Discourse Admin panel under the API section. You can create user-specific API keys or all-users API keys. Once you have obtained the API Key, set it along with the Domain and Username in the ProfileSettings connection property.

Example Connection string

Profile=C:\profiles\Discourse.apip;ProfileSettings='Domain=forum.example.com;APIKey=your_api_key;Username=your_username;'AuthScheme=APIKey;

Connecting to Discourse Data Using Data Explorer

You can create a simple application for displaying Discourse data by utilizing the CData FireDAC Components for Discourse 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 Discourse. ๐Ÿ‘ 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: Backups) onto the form.

    ๐Ÿ‘ Placing the View on the Form. (Salesforce is shown.)
  8. Select the BackupsView 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 Backups 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.