VOOZH about

URL: https://www.cdata.com/kb/tech/freshbooks-odbc-rad-vcl-app.rst

⇱ Build a Simple VCL Application for FreshBooks Data


Build a Simple VCL Application for FreshBooks Data

👁 Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
How to build a simple VCL Application to view FreshBooks data in RAD Studio using the CData ODBC Driver for FreshBooks.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for FreshBooks, you gain access to live FreshBooks data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve FreshBooks data. This article will walk through connecting to FreshBooks and creating a simple VCL application with the Form Designer.

Create a Connection to FreshBooks 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.

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

FreshBooks API Profile Settings

Register an OAuth application in your FreshBooks Developer Dashboard to obtain a Client ID and Client Secret, and configure the redirect URI to match your application's callback URL.

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

  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 FreshBooks.
👁 A FireDAC connection to the ODBC data source. (Salesforce is shown.)

Create VCL Applications with Connectivity to FreshBooks Data

Follow the procedure below to start executing queries to FreshBooks 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 FreshBooks data.
    • 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 Id, InvoiceNumber FROM Invoices WHERE AccountId = 'your_account_id'
      
    • 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.)

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.

👁 The Data Displayed in 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.