Query Wave Financial Data in ColdFusion

The CData JDBC driver for Wave Financial seamlessly integrates connectivity to Wave Financial data with the rapid development tools in ColdFusion. This article shows how to connect to Wave Financial data in ColdFusion and query Wave Financial tables.

Create a JDBC Data Source for Wave Financial in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   👁 Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:wavefinancial: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     Connect using the API Token

     You can connect to Wave Financial by specifying the APIToken You can obtain an API Token using the following steps:

     1. Log in to your Wave account and navigate to "Manage Applications" in the left pane.
     2. Select the application that you would like to create a token for. You may need to create an application first.
     3. Click the "Create token" button to generate an APIToken.

     Connect using OAuth

     If you wish, you can connect using the embedded OAuth credentials. See the Help documentation for more information.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.wavefinancial.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:wavefinancial:InitiateOAuth=GETANDREFRESH;

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.wavefinancial.WaveFinancialDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Wave Financial data source in the Actions column. After reporting a status of OK, the Wave Financial data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Wave Financial, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="WaveFinancialQuery" dataSource="CDataWaveFinancial">
 SELECT * FROM Invoices WHERE Status = <cfqueryparam value="#Status#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#WaveFinancialQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
 "SELECT * FROM Invoices WHERE Status = ?", 
 [
 { value="SENT", cfsqltype="cf_sql_varchar" }
 ],
 { datasource="CDataWaveFinancial" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Status=SENT