Integrate Outlook with External Services using SnapLogic
SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Outlook, in their SnapLogic workflows.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Outlook data. When platforms 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 lets you work with Outlook data using native data types.
Connect to Outlook in SnapLogic
To connect to Outlook data in SnapLogic, download and install the CData Outlook JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData API Driver for JDBC/lib by default).
Upload the Outlook JDBC Driver
After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.
Configure the Connection
Once the JDBC Driver is uploaded, we can create the connection to Outlook.
- Navigate to the Designer tab
- Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
- Click Add Account (or select an existing one) and click "Continue"
- In the next form, configure the JDBC connection properties:
- Under JDBC JARs, add the JAR file we previously uploaded
- Set JDBC Driver Class to cdata.jdbc.api.APIDriver
Set JDBC URL to a JDBC connection string for the Outlook JDBC Driver, for example:
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;RTK=XXXXXX;
NOTE: RTK is a trial or full key. Contact our Support team for more information.
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 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
- Log in to the Azure Portal.
- Navigate to Azure Active Directory > App registrations.
- Click New registration to create a new application.
- Enter an application name and select the appropriate account types.
- Set the Redirect URI to your application's callback URL (e.g., http://localhost:33333 for desktop apps).
- Click Register to create the application.
- On the application overview page, copy the Application (client) ID - this is your OAuthClientId.
- Navigate to Certificates & secrets and create a new client secret.
- Copy the client secret value - this is your OAuthClientSecret.
- 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
- 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;
- After entering the connection properties, click "Validate" and "Apply"
Read Outlook Data
In the form that opens after validating and applying the connection, configure your query.
- Set Schema name to "API"
- Set Table name to a table for Outlook using the schema name, for example: "API"."CalendarGroupCalendars" (use the drop-down to see the full list of available tables)
- Add Output fields for each item you wish to work with from the table
Save the Generic JDBC - Select snap.
With connection and query configured, click the end of the snap to preview the data (highlighted below).
Once you confirm the results are what you expect, you can add additional snaps to funnel your Outlook data to another endpoint.
Piping Outlook Data to External Services
For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.
- Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
- Add an account to connect to Google Sheets
- Configure the Worksheet Writer snap to write your Outlook data to a Google Spreadsheet
You can now execute the fully configured pipeline to extract data from Outlook and push it into a Google Spreadsheet.
More Information & Free Trial
Using the CData API Driver for JDBC you can create a pipeline in SnapLogic for integrating Outlook data with external services. For more information about connecting to Outlook, check at our CData API Driver for JDBC page. Download a free, 30 day trial of the CData API Driver for JDBC and get started today.