VOOZH about

URL: https://www.cdata.com/kb/tech/rootly-odbc-cppbuilder.rst

⇱ DataBind Controls to Rootly Data in C++Builder

DataBind Controls to Rootly Data in C++Builder

👁 Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
DataBind to Rootly data in C++Builder with standard components and controls.

The CData ODBC driver for Rootly makes it easy to integrate connectivity to live Rootly data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to Rootly data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

Create a Connection to Rootly Data

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.

Using API Key Authentication

To authenticate using an API key, you will need to obtain your API key from your Rootly account settings.

To get your API key:

  1. Log in to your Rootly account
  2. Navigate to Settings > API & Integrations
  3. Click on "API Tokens"
  4. Copy the generated token

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Rootly API token.

Example Connection String

Profile=Rootly.apip;Authscheme=APIKey;ProfileSettings="APIKey=your_apikey";

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Rootly.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  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 Rootly.
👁 A FireDAC connection to the ODBC data source. (Salesforce is shown.)

Create VCL Applications with Connectivity to Rootly Data

Follow the procedure below to start querying Rootly data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to Rootly.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.

    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT , FROM Incidents WHERE Status = 'started'
    • Active: Set this property to true.

  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.

  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.
👁 Components in FireDAC used to databind an editable grid to the data source. (Salesforce is shown.)

Execute Commands to Rootly with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to Rootly data. This section provides Rootly-specific examples of executing queries with the TFQuery component.

Connect to Rootly Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData Rootly ODBC Source";
FDConnection1->Connected = true;

To connect the TFDQuery component to Rootly data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below: 

FDQuery1->SQL->Text = "select * from Incidents where status = :Status";
FDQuery1->ParamByName("status")->AsString = "started";
FDQuery1->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text = "select * from Incidents where status = :Status";
FDQuery1->ParamByName("status")->AsString = "started";
FDQuery1->Open();

Related Articles

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