Ready to get started?

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

Download Now

Query UPS Data in ColdFusion

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

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

Create a JDBC Data Source for UPS 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:ups: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      The driver uses five pieces of information in order to authenticate its actions with the UPS service.

      • Server: This controls the URL where the requests should be sent. Common testing options for this are: https://wwwcie.ups.com/ups.app/xml and https://wwwcie.ups.com/webservices
      • AccessKey: This is an identifier that is required to connect to a UPS Server. This value will be provided to you by UPS after registration.
      • UserId: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
      • Password: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
      • AccountNumber: This is a valid 6-digit or 10-digit UPS account number.
      • PrintLabelLocation: This property is required if one intends to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.ups.jar

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

      A typical JDBC URL is below:

      jdbc:ups:Server=https://wwwcie.ups.com/ups.app/xml;AccessKey=myAccessKey;Password=myPassword;AccountNumber=myAccountNumber;UserId=myUserIdInitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.ups.UPSDriver.
    • 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 UPS data source in the Actions column. After reporting a status of OK, the UPS data source is ready for use.

Execute Queries

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

<cfquery name="UPSQuery" dataSource="CDataUPS"> SELECT * FROM Senders WHERE SenderID = <cfqueryparam value="#SenderID#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#UPSQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Senders WHERE SenderID = ?", 
  [
    { value="25", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataUPS" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?SenderID=25