Integrate with Outlook Data in JReport Designer

Jerod Johnson
Director, Technology Evangelism

Create charts and reports based on Outlook data in JReport Designer.

The CData JDBC Driver for Outlook data enables access to live data from dashboards and reports as if Outlook were a relational database, allowing you to query Outlook data using familiar SQL queries. This article shows how to connect to Outlook data as a JDBC data source and create reports based on Outlook data in JReport Designer.

Connect to Outlook Data

Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Outlook 2016\lib\cdata.jdbc.api.jar;
...

Create a new data source by clicking File New Data Source.
In the resulting dialog, create a name for the data source (CData JDBC Driver for Outlook), select JDBC, and click OK.
In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
- Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:
```
cdata.jdbc.api.APIDriver
```
- URL: Enter the JDBC URL. This 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.
  👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  
  When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
  
  Below is a typical JDBC URL:
```
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;
```
- User: The username to authenticate with; typically left blank.
- Password: The password to authenticate with; typically left blank.
👁 Configuring the connection to the JDBC Driver (Salesforce is shown.)
In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.
👁 Adding Tables. (Salesforce is shown.)

Click Done once the dialog has completed loading the tables.
In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Outlook), right-click on Queries, and select Add Query. 👁 Adding a query for data to be used in the report. (Salesforce is shown.)
In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK. 👁 Selecting a table for the query. (Salesforce is shown.)
In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:
```
SELECT , FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'
```
👁 Editing the query. (Salesforce is shown.)

With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Outlook data to a new or existing report.

NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.