Ready to get started?

Download a free trial of the HCL Domino ODBC Driver to get started:

 Download Now

Learn more:

HCL Domino Icon HCL Domino ODBC Driver

The HCL Domino ODBC Driver is a powerful tool that allows you to connect with live data from HCL Domino, directly from any applications that support ODBC connectivity.

Access HCL Domino data like you would a database - read, write, and update HCL Domino FALSE, etc. through a standard ODBC Driver interface.

Analyze HCL Domino Data with Power Pivot



This article walks you through the process of using the CData ODBC Driver for HCL Domino from Power Pivot. You will use the Table Import Wizard to load HCL Domino data. You can visually build the import query or use any SQL supported by the driver.

The ODBC protocol is used by a wide variety of Business Intelligence (BI) and reporting tools to get access to different databases. The CData ODBC Driver for HCL Domino brings the same power and ease of use to HCL Domino data. This article uses the driver to import HCL Domino data into Power Pivot.

Connect to HCL Domino as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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 Azure Active Directory 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.

AzureAD

This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. You need to create a custom OAuth application in Azure Active Directory 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 "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 Azure Active Directory > Properties page.

Connect from Power Pivot

Follow the steps below to connect to the DSN in Power Pivot.

  1. In Excel, click the Power Pivot Window icon on the Power Pivot tab to open Power Pivot.
  2. Launch the Table Import Wizard: Click the Get External Data from Other Data Sources button.
  3. Select the OLEDB/ODBC source option.
  4. Click Build to open the Data Link Properties dialog.
  5. In the Provider tab, select the Microsoft OLEDB Provider for ODBC Drivers option.
  6. In the Connection tab, select the Use Data Source Name option and then select the HCL Domino DSN in the menu.

Select and Filter Tables and Views

Follow the steps below to use the wizard to import HCL Domino tables. As you use the wizard to select, filter, and sort columns of HCL Domino tables, Power Pivot generates the query to be executed.

  1. After selecting the DSN in the Table Import Wizard, select the option to select from a list of tables.

  2. Click Preview & Filter to select specific columns, sort data, and visually build filters. To include or exclude columns, select and clear the option next to the column name.

    To filter based on column values, click the down arrow button next to the column name. In the resulting dialog, select or clear the column values you want to filter. Alternatively, click Number Filters or Text Filters and then select a comparison operator. In the resulting dialog, build the filter criteria.

  3. Return to the Select Tables and Views page of the wizard. You can access filters by clicking the Applied Filters link in the Filter Details column.

Import and Filter with SQL

You can also import with an SQL query. The driver supports the standard SQL, allowing Excel to communicate with HCL Domino APIs.

  1. After selecting the DSN in the Table Import Wizard, select the option to write a query.
  2. In the SQL Statement box, enter the query. Click Validate to check that the syntax of the query is valid. Click Design to preview the results and adjust the query before import.

  3. Finish the wizard to import the data for your chosen query.

Refresh On Demand

Connectivity to HCL Domino APIs enables real-time analysis. To immediately update your workbook with any changes, click Refresh.