How to load DocuSign data into Elasticsearch via Logstash



Introducing a simple method to load DocuSign data using the ETL module Logstash of the full-text search service Elasticsearch and the CData JDBC driver.

Elasticsearch is a popular distributed full-text search engine. By centrally storing data, you can perform ultra-fast searches, fine-tuning relevance, and powerful analytics with ease. Elasticsearch has a pipeline tool for loading data called "Logstash". You can use CData JDBC Drivers to easily import data from any data source into Elasticsearch for search and analysis.

This article explains how to use the CData JDBC Driver for DocuSign to load data from DocuSign into Elasticsearch via Logstash.

Using CData JDBC Driver for DocuSign with Elasticsearch Logstash

  • Install the CData JDBC Driver for DocuSign on the machine where Logstash is running.
  • The JDBC Driver will be installed at the following path (the year part, e.g. 20XX, will vary depending on the product version you are using). You will use this path later. Place this .jar file (and the .lic file if it's a licensed version) in Logstash.
    C:\Program Files\CData\CData JDBC Driver for DocuSign 20XX\lib\cdata.jdbc.docusign.jar
  • Next, install the JDBC Input Plugin, which connects Logstash to the CData JDBC driver. The JDBC Plugin comes by default with the latest version of Logstash, but depending on the version, you may need to add it.
    https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
  • Move the CData JDBC Driver’s .jar file and .lic file to Logstash's "/logstash-core/lib/jars/".

Sending DocuSign data to Elasticsearch with Logstash

Now, let's create a configuration file for Logstash to transfer DocuSign data to Elasticsearch.

  • Write the process to retrieve DocuSign data in the logstash.conf file, which defines data processing in Logstash. The input will be JDBC, and the output will be Elasticsearch. The data loading job is set to run at 30-second intervals.
  • Set the CData JDBC Driver's .jar file as the JDBC driver library, configure the class name, and set the connection properties to DocuSign in the form of a JDBC URL. The JDBC URL allows detailed configuration, so please refer to the product documentation for more specifics.
  • 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.

Executing data movement with Logstash

Now let's run Logstash using the created "logstash.conf" file.

logstash-7.8.0\bin\logstash -f logstash.conf

A log indicating success will appear. This means the DocuSign data has been loaded into Elasticsearch.

For example, let's view the data transferred to Elasticsearch in Kibana.

    GET docusign_table/_search
    {
        "query": {
            "match_all": {}
        }
    }
Querying the DocuSign data loaded into Elasticsearch

We have confirmed that the data is stored in Elasticsearch.

Confirming the DocuSign data loaded into Elasticsearch

By using the CData JDBC Driver for DocuSign with Logstash, it functions as a DocuSign connector, making it easy to load data into Elasticsearch. Please try the 30-day free trial.

Ready to get started?

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

 Download Now

Learn more:

DocuSign Icon DocuSign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with DocuSign data including Accounts, Envelopes, Folders, and more!