Ready to get started?

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

Download Now

Query USPS Data in ColdFusion

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

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

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

      To authenticate with USPS, set the following connection properties.

      • PostageProvider: The postage provider to use to process requests. Available options are ENDICIA and STAMPS. If unspecified, this property will default to ENDICIA.
      • UseSandbox: This controls whether live or test requests are sent to the production or sandbox servers. If set to true, the Password, AccountNumber, and StampsUserId properties are ignored.
      • StampsUserId: This value is used for logging into authentication to the Stamps servers. This value is not applicable for Endicia and is optional if UseSandbox is true.
      • Password: This value is used for logging into Endicia and Stamps servers. If the postage provider is Endicia, this will be the pass phrase associated with your postage account. It is optional if UseSandbox is true.
      • AccountNumber: The shipper's account number. It is optional if UseSandbox is true.
      • PrintLabelLocation: This property is required to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

      The Cache Database

      Many of the useful task available from USPS require a lot of data. To ensure this data is easy to input and recall later, utilize a cache database to make requests. Set the cache connection properties in order to use the cache:

      • CacheLocation: The path to the cache location, for which a connection will be configured with the default cache provider. For example, C:\users\username\documents\uspscache

      As an alternative to CacheLocation, set the combination of CacheConnection and CacheProvider to configure a cache connection using a provider separate from the default.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.usps.jar

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

      A typical JDBC URL is below:

      jdbc:usps:PostageProvider=ENDICIA; RequestId=12345; Password='abcdefghijklmnopqr'; AccountNumber='12A3B4C'
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.usps.USPSDriver.
    • 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 USPS data source in the Actions column. After reporting a status of OK, the USPS data source is ready for use.

Execute Queries

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

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

Below is the equivalent in CFScript:


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

writeDump( var= result );
</cfscript> 

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

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