Connect to Outlook Data in Aqua Data Studio

The CData JDBC Driver for Outlook integrates Outlook data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Outlook data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Outlook data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Outlook.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection 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 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;

   

Query Outlook Data

You can now query the tables exposed.