Ready to get started?

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

Download Now

Build FedEx-Connected Web Apps in Servoy

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

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

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live FedEx data. When you issue complex SQL queries to FedEx, the driver pushes supported SQL operations, like filters and aggregations, directly to FedEx 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 FedEx data using native data types.

Connect to FedEx in Servoy Developer

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

  1. Install the JDBC Driver.
  2. Copy the JDBC Driver JAR file. (cdata.jdbc.fedex.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:fedex:Server='https://gatewaybeta.fedex.com:443/xml';DeveloperKey='alsdkfjpqoewiru';Password='zxczxqqtyiuowkdlkn';AccountNumber='110371337';MeterNumber='240134349'; PrintLabelLocation='C:\users\username\documents\mylabels';CacheProvider='org.sqlite.JDBC';CacheConnection='jdbc:sqlite:C:\users\username\documents\fedexcache.db';

        Built-In Connection String Designer

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

        java -jar cdata.jdbc.fedex.jar

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

        There are five pieces of information needed in order to authenticate its actions with the FedEx service. This information is below.

        • Server: This controls the URL where the requests should be sent. Common testing options for this are: "https://gatewaybeta.fedex.com:443/xml", "https://wsbeta.fedex.com:443/xml", "https://gatewaybeta.fedex.com:443/web-service", and "https://wsbeta.fedex.com:443/web-service"
        • DeveloperKey: This is the identifier part of the authentication key for the sender's identity. This value will be provided to you by FedEx after registration.
        • Password: This is the secret part of the authentication key for the sender's identity. This value will be provided to you by FedEx after registration.
        • AccountNumber: This valid 9-digit FedEx account number is used for logging into the FedEx server.
        • MeterNumber: This value is used for submitting requests to FedEx. This value will be provided to you by FedEx after registration.
        • 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.

        The Cache Database

        Many of the useful tasks available from FedEx require a lot of data. To ensure this data is easy to input and recall later, utilizes a cache database to make these requests. You must set the cache connection properties:

        • CacheProvider: The specific database you are using to cache with. For example, org.sqlite.JDBC.
        • CacheConnection: The connection string to be passed to the cache provider. For example, jdbc:sqlite:C:\users\username\documents\fedexcache.db
      • Select the Driver class you just copied, for example, cdata.jdbc.fedex.FedExDriver

Build a FedEx-Connected Web App

Once you have configured the connection to FedEx in the Servoy Developer resources, you are ready to build apps with access to live FedEx 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 FedEx "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 FedEx and start building FedEx-connected apps with Servoy. Reach out to our Support Team if you have any questions.