Ready to get started?

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

Download Now

Connect to USPS Data in DBVisualizer

Integrate USPS data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for USPS implements JDBC standards to provide connectivity to USPS data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to USPS data in DBVisualizer and use the table editor to edit and save USPS data.

Create a New JDBC Data Source for USPS Data

Follow the steps below to use the Driver Manager to provide connectivity to USPS data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
  2. Enter a name for the data source.
  3. Enter the following in the URL Format box: jdbc:usps:
    The DBVisualizer Driver Manager.
  4. In the User Specified tab, click the Open File button and select the cdata.jdbc.usps.jar file, located in the lib subfolder of the installation directory.
  5. In the Driver Class menu, select the USPSDriver class, cdata.jdbc.usps.USPSDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

  1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.
  2. In the Connection section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:usps: 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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:usps:PostageProvider=ENDICIA; RequestId=12345; Password='abcdefghijklmnopqr'; AccountNumber='12A3B4C'
    • Database UserId: The username to use to authenticate to USPS.
    • Database Password: The password to use to authenticate to USPS.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the USPS JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.