Windows DSN Configuration
Using the Microsoft ODBC Data Source Administrator
You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.
Complete the following steps to edit the DSN configuration:
- Select Start > Search, and enter ODBC Data Sources in the Search box.
- Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
- Click the System DSN tab.
- Select the system data source and click Configure.
- Edit the information on the Connection tab and click OK.
Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.
Ensuring Registry Access
The driver stores connection information in the Windows registry. To ensure that the driver can write to the registry, perform either of the following actions:
- Run the calling application as an administrator.
- Connect via a User DSN instead of a System 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 to Domino
Domino supports authenticating via either login credentials (OAuthPassword) or Microsoft Entra ID (AzureAD).
Login Credentials
Set these properties:- AuthScheme: OAuthPassword.
- User: The authenticating Domino user's login.
- Password: The authenticating Domino user's password.
The driver uses the login credentials to automatically perform an OAuth token exchange.
Microsoft Entra ID (Azure AD)
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
This authentication method uses Azure Active Directory as an identity provider (IdP) to obtain a JWT token. Before a user can authenticate via Azure AD, a user with admin privileges must create a custom Azure AD OAuth application in Azure Active Directory and configure it as an IdP, as described in Creating a Custom Entra ID (Azure AD) Application.
Once the custom Azure AD application has been completed, set these properties:
- AuthScheme: AzureAD.
- OAuthClientId: The Client ID that was obtained during custom Azure AD application creation.
- OAuthClientSecret: The Client Secret that was obtained during custom Azure AD application creation.
- CallbackURL : The redirect URI that was specified during custom Azure AD application registration. For example, https://localhost:33333.
- AzureTenant: The Microsoft Online tenant being used to access data.
Supply either the Tenant ID, or a value in the form companyname.microsoft.com.
(The Tenant ID is the same as the directory ID shown in the Azure Portal's Azure Active Directory > Properties page.)