Airtable Reporting in OBIEE with the Airtable JDBC Driver



Deploy the Airtable JDBC driver on OBIEE to provide real-time reporting across the enterprise.

The CData JDBC Driver for Airtable is a standard database driver that can integrate real-time access to Airtable data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on Airtable data that reflect any changes.

Deploy the JDBC Driver

Follow the steps below to add the JDBC driver to WebLogic's classpath.

For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.airtable.jar;%PRE_CLASSPATH%

Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.

Create a JDBC Data Source for Airtable

After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.

  1. Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
  2. Click JDBC Connection -> Add Data Source.
  3. Enter the following information:
    • Data Source Name: Enter the name that users will create connections to in their reports.
    • Driver Type: Select Other.
    • Database DriverClass: Enter the driver class, cdata.jdbc.airtable.AirtableDriver.
    • Connection String: Enter the JDBC URL.

      APIKey, BaseId and TableNames parameters are required to connect to Airtable. ViewNames is an optional parameter where views of the tables may be specified.

      • APIKey : API Key of your account. To obtain this value, after logging in go to Account. In API section click Generate API key.
      • BaseId : Id of your base. To obtain this value, it is in the same section as the APIKey. Click on Airtable API, or navigate to https://airtable.com/api and select a base. In the introduction section you can find "The ID of this base is appxxN2ftedc0nEG7."
      • TableNames : A comma separated list of table names for the selected base. These are the same names of tables as found in the UI.
      • ViewNames : A comma separated list of views in the format of (table.view) names. These are the same names of the views as found in the UI.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.airtable.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 JDBC URL is below:

      jdbc:airtable:APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=Table1,...;ViewNames=Table1.View1,...;
    • Username: Enter the username.
    • Password: Enter the password.
  4. In the Security section, select the allowed user roles.

Create Real-Time Airtable Reports

You can now create reports and analyses based on real-time Airtable data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to Airtable data.

  1. On the global header, click New -> Data Model.
  2. On the Diagram tab, select SQL query in the menu.
  3. Enter a name for the query and in the Data Source menu select the Airtable JDBC data source you created.
  4. Select standard SQL and enter a query like the following: SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = 'SomeValue'
  5. Click View Data to generate the sample data to be used as you build your report.
  6. Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
  7. Click Create Report -> Use Data Model.
  8. Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
  9. Drop a numeric column like Column1 onto the Drop Value Here box on the y-axis. Drop a dimension column like Id onto the Drop Label Here box on the x-axis.
  10. Click Refresh to pick up any changes to the Airtable data.

Ready to get started?

Download a free trial of the Airtable Driver to get started:

 Download Now

Learn more:

Airtable Icon Airtable JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Airtable.