How to connect and process DocuSign Data from Azure Databricks

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 DocuSign data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live DocuSign data in Databricks.

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

Install the CData JDBC Driver in Azure

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

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

Connect to DocuSign from Databricks

With the JAR file installed, we are ready to work with live DocuSign data in Databricks. Start by creating a new notebook in your workspace. Name the workbook, make sure Python is selected as the language (which should be by default), click on Connect and under General Compute select the cluster where you installed the JDBC driver (should be selected by default).

Configure the Connection to DocuSign

Connect to DocuSign by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK 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.

driver = "cdata.jdbc.docusign.DocuSignDriver"
url = "jdbc:docusign:RTK=5246...;OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
CallbackURL=http://localhost:33333;
InitiateOAuth=GETANDREFRESH"

Built-in Connection String Designer

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

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

To connect to DocuSign, set the following connection properties:

• UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
• AccountId (optional): set it in the connection string if you have access to multiple Account Ids

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

Load DocuSign Data

Once the connection is configured, you can load DocuSign data as a dataframe using the CData JDBC Driver and the connection information.

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

Display DocuSign Data

Check the loaded DocuSign data by calling the display function.

display (remote_table.select ("DocumentId"))

Analyze DocuSign Data in Azure Databricks

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

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

The SparkSQL below retrieves the DocuSign data for analysis.

result = spark.sql("SELECT DocumentId, DocumentName FROM SAMPLE_VIEW WHERE DocumentName = 'TPSReport'")

The data from DocuSign 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 JDBC Driver for DocuSign and start working with your live DocuSign data in Azure Databricks. Reach out to our Support Team if you have any questions.