Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Build a Simple VCL Application for Avalara AvaTax Data
How to build a simple VCL Application to view Avalara AvaTax data in RAD Studio using the CData ODBC Driver for Avalara AvaTax.
Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Avalara AvaTax, you gain access to live Avalara AvaTax data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve and update Avalara AvaTax data. This article will walk through connecting to Avalara AvaTax and creating a simple VCL application with the Form Designer.
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 data.
- In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
- Right-click the ODBC Data Source node in the Data Explorer.
- Click Add New Connection.
- Enter a name for the connection.
- 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 executing queries to Avalara AvaTax data from a simple VCL application that displays the results of a query in a grid.
-
Drop a TFDConnection component onto the form and set the following properties:
- ConnectionDefName: Select the FireDAC connection to Avalara AvaTax data.
- Connected: Select True from the menu and, in the dialog that appears, enter your credentials.
-
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.
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.
-
Drop a TDBGrid control onto the form and set the following property:
- DataSource: Select the name of the TDataSource.
- Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.
You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.
Related Articles
Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.