Analyze Outlook Data in Infragistics Reveal
Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Outlook data. The CData API Server generates an OData API for Outlook, which is natively consumable in Reveal. In this article, we walk through connecting to Outlook in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to Outlook from API Server
CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.
- Open API Server and click Settings -> Connection -> Add Connection
- Select "Outlook"
- Enter the necessary authentication properties to connect to Outlook.
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;
Add Outlook Resource Definitions in API Server
After connecting to Outlook, create Resources, which represent API endpoints for Outlook data.
- Click Settings -> Resources -> Add Resource
- Select the Outlook connection
- Select the table you wish to retrieve and click Next
- (Optional) Edit the resource to select specific fields and more
- Save the settings
Add an API Server User
Create a User to connect to Outlook from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the Outlook Connection and Resource(s)
(Optional) Configure Cross-Origin Resource Sharing (CORS)
When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.
- Enable cross-origin resource sharing (CORS): ON
- Allow all domains without '*': ON
- Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
- Access-Control-Allow-Headers: Authorization
Save the changes to the settings.
Create a Dashboard in Reveal
With the API Server configured, we can visualize Outlook data in Reveal.
- Log into Reveal and click Dashboards -> New
- Click Data Source -> OData Feed
- Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
- Select Generic Credentials and specify the API Server username and authentication token
- Select the entity you wish to visualize
- Select fields and choose a chart type
More Information & Free Trial
At this point, you have created a simple dashboard from live Outlook data. For more information on creating OData feeds from Outlook (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Outlook data in tools that consume OData APIs.