Process & Analyze JotForm Data in Databricks (AWS)

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live JotForm data. This article explains how to host the CData JDBC Driver in AWS, as well as connect to and process live JotForm data in Databricks.

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

Install the CData JDBC Driver in Databricks

To work with live JotForm data in Databricks, install the driver on your Databricks cluster.

1. Navigate to your Databricks administration screen and select the target cluster.
2. On the Libraries tab, click "Install New."
3. Select "Upload" as the Library Source and "Jar" as the Library Type.
4. Upload the JDBC JAR file (cdata.jdbc.api.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

👁 Loading the JDBC JAR File into AWS

Access JotForm Data in your Notebook: Python

With the JAR file installed, we are ready to work with live JotForm data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query JotForm, and create a basic report.

Configure the Connection to JotForm

Connect to JotForm by referencing the JDBC Driver class and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

Step 1: Connection Information

driver = "cdata.jdbc.api.APIDriver"
url = "jdbc:api:RTK=5246...;Profile=C:\profiles\JotForm.apip;ProfileSettings='APIKey=my_api_key;Domain=my_custom_domain';"

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the JotForm 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.

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

JotForm API Profile Settings

Find your JotForm API Key in order to authenticate. To obtain an API Key, go to 'My Account' > 'API Section' > 'Create a New API Key'. Once you've created your new API Key, you can set it in the ProfileSettings connection property.

Custom Enterprise API Domains

Enterprise customers of JotForm are given custom API domains to connect to, rather than the default 'api.jotform.com' domain. If you are an enterprise JotForm customer, then set Domain to you custom API hostname, such as 'your-domain.com' or 'subdomain.jotform.com', inside the ProfileSettings connection property. Conversely, if you do not have a custom domain and still need to connect to 'api.jotform.com', then leave Domain undefined and set only APIKey.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Load JotForm Data

Once you configure the connection, you can load JotForm data as a dataframe using the CData JDBC Driver and the connection information.

Step 2: Reading the data

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Forms") \
	.load ()

Display JotForm Data

Check the loaded JotForm data by calling the display function.

Step 3: Checking the result

display (remote_table.select ("Id"))

👁 Displaying JotForm Data

Analyze JotForm Data in Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

Step 4: Create a view or table

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

With the Temp View created, you can use SparkSQL to retrieve the JotForm data for reporting, visualization, and analysis.

% sql

SELECT Id, Title FROM SAMPLE_VIEW ORDER BY Title DESC LIMIT 5

👁 Displaying JotForm Data

The data from JotForm is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live JotForm data in Databricks. Reach out to our Support Team if you have any questions.