Ready to get started?

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

Download Now

ETL FreshBooks in Oracle Data Integrator

This article shows how to transfer FreshBooks data into a data warehouse using Oracle Data Integrator.

Leverage existing skills by using the JDBC standard to read and write to FreshBooks: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for FreshBooks connects real-time FreshBooks data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with FreshBooks just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the FreshBooks APIs in real time instead of working with flat files.

This article walks through a JDBC-based ETL -- FreshBooks to Oracle. After reverse engineering a data model of FreshBooks entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR and .lic file, located in the installation folder, into the ODI userlib directory:

On Unix: ~/.odi/oracledi/userlib On Windows: %APPDATA%\Roaming\odi\oracledi\userlib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of FreshBooks data. After reverse engineering, you can query real-time FreshBooks data and create mappings based on FreshBooks tables.

  1. In ODI, connect to your repository and click New -> Model and Topology Objects.
  2. On the Model screen of the resulting dialog, enter the following information:
    • Name: Enter FreshBooks.
    • Technology: Select Generic SQL.
    • Logical Schema: Enter FreshBooks.
    • Context: Select Global.
  3. On the Data Server screen of the resulting dialog, enter the following information:
    • Name: Enter FreshBooks.
    • Driver List: Select Oracle JDBC Driver.
    • Driver: Enter cdata.jdbc.freshbooks.FreshBooksDriver
    • URL: Enter the JDBC URL containing the connection string.

      To connect to FreshBooks, you can set the CompanyName and Token connection properties. Alternatively, you can use the OAuth authentication standard.

      OAuth can be used to enable other users to access their own company data. To authenticate using OAuth, you will need to obtain the OAuthClientId and OAuthClientSecret by registering an app. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.freshbooks.jar

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

      Below is a typical connection string:

      jdbc:freshbooks:CompanyName=CData;Token=token;
  4. On the Physical Schema screen, enter the following information:
    • Schema (Schema): Enter FreshBooks.
    • Schema (Work Schema): Enter FreshBooks.
  5. In the opened model click Reverse Engineer to retrieve the metadata for FreshBooks tables.

Edit and Save FreshBooks Data

After reverse engineering you can now work with FreshBooks data in ODI. To edit and save FreshBooks data, expand the Models accordion in the Designer navigator, right-click a table, and click Data. Click Refresh to pick up any changes to the data. Click Save Changes when you are finished making changes.

Create an ETL Project

Follow the steps below to create an ETL from FreshBooks. You will load Clients entities into the sample data warehouse included in the ODI Getting Started VM.

  1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

    Alternatively you can use SQLPlus. From a command prompt enter the following:

    sqlplus / as sysdba
  2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the Clients table in FreshBooks: CREATE TABLE ODI_DEMO.TRG_CLIENTS (CREDIT NUMBER(20,0),Username VARCHAR2(255));
  3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
  4. Click Reverse Engineer. The TRG_CLIENTS table is added to the model.
  5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
  6. Drag the TRG_CLIENTS table from the Sales Administration model onto the mapping.
  7. Drag the Clients table from the FreshBooks model onto the mapping.
  8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
  9. Open the Physical tab of the Mapping Editor and click CLIENTS_AP in TARGET_GROUP.
  10. In the CLIENTS_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load FreshBooks data into Oracle.