Build AI/ML Models with Live Outlook Data using Dataiku

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Connect Outlook Data with Dataiku using the CData API Driver for JDBC.

Dataiku is a data science and machine learning platform used for data preparation, analysis, visualization, and AI/ML model deployment, enabling collaborative and efficient data-driven decision-making. When paired with the CData API Driver for JDBC, Dataiku enhances data integration, preparation, real-time analysis, and reliable model deployment for Outlook data.

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

This article shows how you can easily integrate to Outlook using CData API Driver for JDBC in Dataiku DSS (Data Science Studio) platform, allowing you to prepare the data and build custom AI/ML models.

Preparing the Dataiku DSS environment

In this section, we will explore how to set up Dataiku, as previously introduced, with Outlook data. Be sure to install Dataiku DSS (On-Prem version) for your preferred operating system, beforehand.

Install the CData API Driver for JDBC

First, install the CData API Driver for JDBC on the same machine as Dataiku. The JDBC Driver will be installed in the following path:

C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar

Connecting the JDBC Driver in Dataiku DSS

To use the CData JDBC driver in Dataiku, you must create a new SQL database connection and add the JDBC Driver JAR file in the DSS connection settings.

  1. Log into Dataiku DSS platform. It should open locally in your browser (e.g. localhost:11200)
  2. Click on Navigate to other sections of Dataiku menu on the top right section of the platform and select Administration.
  3. Select the Connections tab.
  4. In Connections, click on New Connections button.
  5. Now, scroll down and select Other SQL databases.
  6. Generate a JDBC URL for connecting to Outlook, beginning with jdbc:api: followed by a series of semicolon-separated connection string properties.

    Using OAuth Authentication

    Microsoft Graph API uses OAuth 2.0 for authentication. You must register an application in the Microsoft Azure Portal to obtain OAuth credentials (Client ID and Client Secret).

    Obtaining OAuth Credentials

    1. Log in to the Azure Portal.
    2. Navigate to Azure Active Directory > App registrations.
    3. Click New registration to create a new application.
    4. Enter an application name and select the appropriate account types.
    5. Set the Redirect URI to your application's callback URL (e.g., http://localhost:33333 for desktop apps).
    6. Click Register to create the application.
    7. On the application overview page, copy the Application (client) ID - this is your OAuthClientId.
    8. Navigate to Certificates & secrets and create a new client secret.
    9. Copy the client secret value - this is your OAuthClientSecret.
    10. Navigate to API permissions and add the required Microsoft Graph API permissions:
      • Mail.Read - For accessing email messages
      • Contacts.Read - For accessing contacts
      • Calendars.Read - For accessing calendar events
      • Tasks.Read - For accessing To Do tasks
      • offline_access - For obtaining refresh tokens
    11. Click Grant admin consent to grant these permissions.

    Connecting with OAuth

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

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Outlook will automatically walk through the OAuth process in order to obtain the access token.
    • OAuthClientId: Set this to the Application (client) ID from Azure Portal.
    • OAuthClientSecret: Set this to the client secret value from Azure Portal.
    • TenantId: Set this to your Azure AD tenant identifier (GUID or domain name like 'contoso.onmicrosoft.com').
    • CallbackURL: Set this to the Redirect URI you specified in your app registration (e.g., http://localhost:33333 for desktop apps).

    Example connection string

    Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;
    

    Built-in Connection String Designer

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

    A typical JDBC URL is given below:

    jdbc:api:Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;
    
  7. On the New SQL database (JDBC) connection screen, enter a name in the New connection name field and specify the basic parameters:
    • JDBC Driver Class: cdata.jdbc.api.APIDriver
    • JDBC URL: JDBC connection URL obtained in the previous step
    • Driver jars directory: the folder path where the JAR file is installed on your system

    Next, select the SQL dialect of your choice. Here, we have selected 'SQL Server' as the preferred dialect. Click on Create. If the connection is successful, a prompt will display, saying 'Connection OK'.

  8. The Data Catalog window will appear. Select the desired connection, catalog, and schema from the Connection to browse, Restrict to catalog, and Restrict to schema dropdowns, then click on List Tables. The Dataiku platform will list all the required tables.
  9. Select any table from the list and click Preview to view the table data. Click Close to exit the window.

Creating a new project

To prepare data flows, create dashboards, analyze the Outlook data, and build AI and ML models in the Dataiku DSS platform, you need to first create a new project.

  1. Select Projects from the Navigate to other sections of Dataiku menu.
  2. In the Projects screen, click New Project and select + Blank Project.
  3. In the New Project window, assign a Name and Project Key. Click Create. The new project dashboard opens up.
  4. Select Notebooks from the menu at the top of the project screen.
  5. Click on + Create Your First Notebook dropdown menu and select Write your own option.
  6. In the New Notebook window, select SQL.
  7. Now, select the required connection from the Connection dropdown and enter a name in the Notebook Name field.

Testing the connection

To test the Outlook connection and analyze the Outlook data, write a query in the query compiler and click Run. The queried/filtered Outlook data results will then appear on the screen.

Get Started Today

Download a free, 30-day trial of the CData API Driver for JDBC to integrate with Dataiku, and effortlessly build custom AI/ML models from Outlook data.

Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Outlook with the API Driver

Connect to Outlook