Ready to get started?

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

Download Now

Build USPS-Connected Web Apps in Servoy

Use Servoy Developer to easily connect to USPS data and build web apps with connectivity to live USPS data.

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for USPS, users can build USPS-connected apps that work with live USPS data. This article describes how to connect to USPS from Servoy and build a simple web app to display and search USPS data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live USPS data. When you issue complex SQL queries to USPS, the driver pushes supported SQL operations, like filters and aggregations, directly to USPS and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with USPS data using native data types.

Connect to USPS in Servoy Developer

To build USPS-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for USPS.

  1. Install the JDBC Driver.
  2. Copy the JDBC Driver JAR file. (cdata.jdbc.usps.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
  3. Open Servoy Developer.
  4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
    1. Name the server.
    2. Click to show the advanced server settings.
      • Set the URL, for example: jdbc:usps:PostageProvider=ENDICIA; RequestId=12345; Password='abcdefghijklmnopqr'; AccountNumber='12A3B4C'

        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.

        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.

      • Select the Driver class you just copied, for example, cdata.jdbc.usps.USPSDriver

Build a USPS-Connected Web App

Once you have configured the connection to USPS in the Servoy Developer resources, you are ready to build apps with access to live USPS data.

Create a New Solution

  1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
  2. Name the solution.
  3. Select the checkbox to include the "search" module.
  4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

  1. Name the form.
  2. Select a Datasource.
  3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

  1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.
  2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the USPS "table" (e.g., FirstName from the Senders table).

    Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

  1. Drag a Text Field component onto the Form.
  2. Right-click the Form and select "Open in Script Editor."
  3. Create a new variable (JavaScript) to hold the search value:
    var searchText = '';
    
  4. Back on the Form, in the Text Field properties:
    1. Set the "dataprovider" property to the Form variable you just created.
    2. Double-click to add a method for the onAction event.
    3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
    4. Click "OK & Show."
  5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:
    var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
    search.setSearchAllColumns();
    search.loadRecords(foundset);
    

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for USPS and start building USPS-connected apps with Servoy. Reach out to our Support Team if you have any questions.