Learn more
 

DataBind Controls to Avalara AvaTax Data in C++Builder


DataBind to Avalara AvaTax data in C++Builder with standard components and controls.

The CData ODBC driver for Avalara AvaTax makes it easy to integrate connectivity to live Avalara AvaTax 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 Avalara AvaTax 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 Avalara AvaTax 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.

The primary method for performing basic authentication is to provide your login credentials, as follows:

  • User: Set this to your username.
  • Password: Set this to your password.

Optionally, if you are making use of a sandbox environment, set the following:

  • UseSandbox: Set this to true if you are authenticating with a sandbox account.

Authenticating Using Account Number and License Key

Alternatively, you can authenticate using your account number and license key. Connect to data using the following:

  • AccountId: Set this to your Account Id. The Account Id is listed in the upper right hand corner of the admin console.
  • LicenseKey: Set this to your Avalara Avatax license key. You can generate a license key by logging into Avalara Avatax as an account administrator and navigating to Settings -> Reset License Key.

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

  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 Avalara AvaTax.

Create VCL Applications with Connectivity to Avalara AvaTax Data

Follow the procedure below to start querying Avalara AvaTax 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 Avalara AvaTax.
    • 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, TotalTax FROM Transactions WHERE Code = '051349'
    • 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.

Execute Commands to Avalara AvaTax with FireDAC Components

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

Connect to Avalara AvaTax 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 Avalara AvaTax ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to Avalara AvaTax 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 Transactions where code = :Code"; FDQuery1->ParamByName("code")->AsString = "051349"; 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 Transactions where code = :Code"; FDQuery1->ParamByName("code")->AsString = "051349"; FDQuery1->Open();

To execute a query that does not return a result set, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows use the TFD.RowsAffected property.

FDQuery1->SQL->Text = "delete from Transactions where Id = :Id"; FDQuery1->Params->Items[0]->AsString = "x12345"; FDQuery1->ExecSQL(); AnsiString i = FDQuery1->RowsAffected; ShowMessage("Rows affected: " + i);

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?

Download a free trial of the Avalara ODBC Driver to get started:

 Download Now

Learn more:

Avalara AvaTax Icon Avalara ODBC Driver

The AvaTax ODBC Driver is a powerful tool that allows you to connect with live data from AvaTax, directly from any applications that support ODBC connectivity.

Access AvaTax data like you would a database - read, write, and update AvaTax Accounts, Customers, TaxCodes, Transactions, etc. through a standard ODBC Driver interface.

In this article

Related articles