Build Charts with HCL Domino Data in Clear Analytics

The CData ODBC driver for HCL Domino enables access to live data from HCL Domino under the ODBC standard, allowing you work with HCL Domino data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to use Clear Analytics, a Microsoft Excel Add-In, to connect to HCL Domino as an ODBC source and create queries, tables, and charts (including PivotTables) based on HCL Domino data.

Connect to HCL Domino Data

Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Connecting to Domino

To connect to Domino data, set the following properties:

• URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
• DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

Authenticating with Domino

Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

Login Credentials

To authenticate with login credentials, set the following properties:

• AuthScheme: Set this to "OAuthPassword"
• User: The username of the authenticating Domino user
• Password: The password associated with the authenticating Domino user

The driver uses the login credentials to automatically perform an OAuth token exchange.

EntraID (formerly AzureAD)

This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

• AuthScheme: Set this to "EntraID (formerly AzureAD)"
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
• OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
• AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

  The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

When you configure the DSN, 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.

Configure the Data Source in Clear Analytics

1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
2. Select Database as the data source.
3. In the Set Connection section, click the option to create a new database.
4. Select Microsoft ODBC Data Source as the data source and click OK.
5. Select the DSN you already configured from the drop-down menu. 👁 Selecting the DSN.
   
6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics. 👁 Selecting data tables (called Domains in Clear Analytics).
   
8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
10. In the Domain Relations section, add any relational information between tables.
11. In the Domain Tree section, create groups for your data and add the available items to the groups. 👁 Adding Domains (tables) to Groups in the Domain Tree.
    
12. Review the summary of your data and click Finish.

Create a Chart with HCL Domino Data

You are now ready to create a chart with HCL Domino data.

Create a New Query

1. Click Repository in the CLEAR ANALYTICS ribbon.
2. Create a new query.
3. Select the columns you wish to retrieve.
4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
5. Set filters and formulas by dragging columns to the lower window.
6. Name your query and click Save. 👁 Creating a New Query.
   

Build a Chart Based on a Query Report

With the query created, you are now ready to execute a report and display a chart.

1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
3. Select the query you just created.
4. Name the report and click 'Save and Execute'. 👁 Creating and Executing a Report.
   
5. Click the Results tab within the Report Explorer
6. Expand your report and drag the chart to the Excel spreadsheet.
7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows. 👁 Building a PivotChart.
   

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of HCL Domino data. With the ODBC Driver for HCL Domino and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from HCL Domino.