Connect to Outlook Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Outlook into your processes in RapidMiner. This article uses the CData JDBC Driver for Outlook to transfer Outlook data to a process in RapidMiner.

Connect to Outlook in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Outlook:

1. Add a new database driver for Outlook: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   jdbc:api:
   

4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   cdata.jdbc.api.APIDriver
   

   
6. Create a new Outlook connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Outlook driver you configured previously.
9. Enter your connection string in the Host box.

   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 connection string is below:

   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;
   

10. Enter your username and password if necessary.

You can now use your Outlook connection with the various RapidMiner operators in your process. To retrieve Outlook data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Outlook data.