Connect to TaxJar Data in Aqua Data Studio

The CData JDBC Driver for TaxJar integrates TaxJar data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to TaxJar data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The TaxJar data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, TaxJar.
   • Driver Location: Click the Browse button and select the cdata.jdbc.taxjar.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.taxjar.TaxJarDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:taxjar: and is followed by a semicolon-separated list of connection properties.

     To authenticate to the TaxJar API, first obtain the API Key from the TaxJar UI.

     NOTE: the API is available only for Professional and Premium TaxJar plans.

     If you already have a Professional or Premium plan you can find the API Key by logging in the TaxJar UI and navigating to Account -> TaxJar API. After obtaining the API Key, you can set it in the APIKey connection property.

     Additional Notes

     • By default, the CData connector will retrieve data of the last 3 months in cases where the entity support date range filtering. You can set StartDate to specify the minimum creation date of the data retrieved.
     • If the API Key has been created for a sandbox API account please set UseSandbox to true, but not all endpoints will work as expected. For more information, refer to the TaxJar developer documentation.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the TaxJar JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.taxjar.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:taxjar:APIKey=3bb04218ef8t80efdf1739abf7257144;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query TaxJar Data

You can now query the tables exposed.