Ready to get started?

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

Download Now

Connect to UPS Data in Aqua Data Studio

Access UPS data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for UPS integrates UPS data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to UPS data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The UPS data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, UPS.
    • Driver Location: Click the Browse button and select the cdata.jdbc.ups.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.ups.UPSDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:ups: and is followed by a semicolon-separated list of connection properties.

      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

Query UPS Data

You can now query the tables exposed.