Typeform Reporting in OBIEE with the Typeform JDBC Driver

The CData JDBC Driver for Typeform is a standard database driver that can integrate real-time access to Typeform 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 Typeform 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.

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

Create a JDBC Data Source for Typeform

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.api.APIDriver.
   • Connection String: Enter the JDBC URL.

     Start by setting the Profile connection property to the location of the TypeForm Profile on disk (e.g. C:\profiles\TypeForm.apip). Next, set the ProfileSettings connection property to the connection string for TypeForm (see below).

     TypeForm API Profile Settings

     Authentication to TypeForm uses the OAuth standard.

     To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

     Note that there are several different use scenarios which all require different redirect URIs:

     • CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
     • CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect Cloud at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
     • Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
     • Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to OAuth.
     • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
     • OAuthClientId: Set this to the Client Id that is specified in your app settings.
     • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
     • CallbackURL: Set this to the Redirect URI you specified in your app settings.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.api.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:api:Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
   • Username: Enter the username.
   • Password: Enter the password.
4. In the Security section, select the allowed user roles.

Create Real-Time Typeform Reports

You can now create reports and analyses based on real-time Typeform data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to Typeform 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 Typeform JDBC data source you created.
4. Select standard SQL and enter a query like the following: SELECT Id, Title FROM Tags WHERE SettingsIsPublic = 'true'
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 Title 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 Typeform data.