Bridge SharePoint Connectivity with Apache NiFi

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SharePoint JDBC Driver

Provides Java developers with the power to easily connect their Web, Desktop, and Mobile applications to data in SharePoint Server Lists, Contacts, Calendar, Links, Tasks, and more!



Access and process SharePoint data in Apache NiFi using the CData JDBC Driver.

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for SharePoint, NiFi can work with live SharePoint data. This article describes how to connect to and query SharePoint data from an Apache NiFi Flow.

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

Connecting to SharePoint Data in Apache NiFi

  1. Download the CData JDBC Driver for SharePoint installer, unzip the package, and run the JAR file to install the driver.
  2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.sharepoint.jar (and cdata.jdbc.sharepoint.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

    On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for SharePoint.

  3. Start Apache NiFi. For example:

    cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
    run-nifi.bat
    
  4. Navigate to the Apache NiFi UI in your web browser: typically http://localhost:8080/nifi
  5. Click the (Configuration) button from the Operate sidebar.
  6. In the NiFi Flow Configuration page, navigate to the Controller Services tab.
  7. Click the button to create a new controller service.
  8. In the Add Controller Service page, select DBCPConnection Pool, and then click Add.
  9. Click the gear button to configure the new DBCPConnection Pool.
  10. In the Configure Controller Service page, navigate to the Properties tab. Fill in the properties:

    PropertyValue
    Database Connection URLjdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;
    Database Driver Class Namecdata.jdbc.sharepoint.SharePointDriver

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.sharepoint.jar

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

    Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

    The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

    If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

  11. Click the button to enable the new DBCPConnection Pool.

Your SharePoint data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor.

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