Use the CData ODBC Driver for HCL Domino from SharePoint Excel Services

The CData ODBC Driver for HCL Domino can be accessed using the built-in data access tools in Excel. This article demonstrates how to use the CData ODBC Driver for HCL Domino to connect to HCL Domino data from Excel spreadsheets in on-premises editions of SharePoint.

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.

Configure Excel Services

Once the ODBC DSN is configured, you can configure Excel Services to use the DSN to connect. To do this, you will need to set up the OLE DB provider as a trusted data source. You will also want to decide if you want to use a Secure Store Service to enable single sign-on functionality with the ODBC driver. If you prefer, you can use the Excel Services Unattended account and skip to step 3 below.

1. First, set up a secure store application to use single sign-on. In SharePoint Central Administration, go to Application Management -> Manage Service Applications. Select your secure store service application or create a new one. Click Manage on the Edit menu to begin editing the application.
2. Create a new target application. You will be able to set the list of users who have access to this application. After the application is created, you will need to set the credentials on the application so that you can use this later for single sign-on.
3. Navigate to Application Management -> Manage Service Applications in SharePoint Central Administration. Select the Excel Services application used by your organization or create one if it does not already exist. Click Manage. If you create a new app, check the option to add the service application's proxy to the farm's default proxy list.
4. Click on Trusted Data Providers and add a new trusted provider. Set 'MSDASQL.1' for the Provider ID and leave the type as 'OLE DB'. Click OK to add this new provider to the list of trusted providers.

Connect to and Import HCL Domino Data in Excel

After you have enabled and secured access to the DSN, you can access the data source from the ribbon in Excel.

1. In an Excel spreadsheet, open the Data tab and click From Other Sources -> From Data Connection Wizard.
2. Select 'Other/Advanced' for the type and on the next screen, select the 'Microsoft OLE DB Provider for ODBC Drivers'. On the Connection tab, select CData Domino Sys, the system DSN. The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from SharePoint.
3. Select the table you would like to connect to.
4. On the last step of the wizard, click the 'Authentication Settings' button. Select the 'Use a stored account' and enter the name of the secure store target application you created earlier. Or, if you want to use the Unattended Service Account, select None.
5. After you finish the wizard, the data is imported into the spreadsheet. You can now update and save HCL Domino data directly in SharePoint.