Ready to get started?

Learn more about the CData JDBC Driver for DocuSign or download a free trial:

Download Now

Query DocuSign Data in ColdFusion

Write standard ColdFusion data access code to connect to DocuSign data.

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

Create a JDBC Data Source for DocuSign 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.

  3. Populate the driver properties:

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

      To connect to DocuSign, set the following connection properties:

      • UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
      • AccountId (optional): set it in the connection string if you have access to multiple Account Ids

      Authenticating to DocuSign

      DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.docusign.jar

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

      A typical JDBC URL is below:

      jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333; InitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.docusign.DocuSignDriver.
    • 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 DocuSign data source in the Actions column. After reporting a status of OK, the DocuSign data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to DocuSign. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="DocuSignQuery" dataSource="CDataDocuSign"> SELECT * FROM Documents WHERE DocumentName = <cfqueryparam value="#DocumentName#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#DocuSignQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Documents WHERE DocumentName = ?", 
  [
    { value="TPSReport", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataDocuSign" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?DocumentName=TPSReport