Connect to Outlook Data in RazorSQL

The CData JDBC Driver for Outlook enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Outlook using wizards in RazorSQL.

Create a JDBC Data Source for Outlook Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     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 and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.