Working with HCL Domino Data in LINQPad

The CData ADO.NET Provider for HCL Domino enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with HCL Domino data. This article will demonstrate the process of establishing a connection from LINQPad and executing LINQ queries.

Create the Data Model

After downloading and installing both the provider and LINQPad, create a new class library project within Visual Studio.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

1. Right-click your project and click Add -> New Item -> ADO.NET Entity Data Model. In the resulting dialog, select Code First from database. Click New Connection and specify the connection string options in the resulting wizard.

   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.

   Below is a typical connection string:

   Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;

2. Select the desired tables and views and click Finish to create the data model.

3. Build the project. The generated files can be used to create the HCL Domino connection in LINQPad.

Connect to HCL Domino Data in LINQPad

After you have obtained the required connection properties and created the data model assembly, follow the steps below to start using the data model in LINQPad.

1. Open LINQPad and click Add Connection.

2. Select the "Use a typed data context from your own assembly" option.

3. Select Entity Framework DbContext.

4. Click Browse next to the Path to Custom Assembly box and browse to your project folder. Browse to the .dll or .exe under the bin folder.

5. Select the name of the DbContext.
6. If you saved your connection string in App.Config, specify the path to the App.config.

You can now query HCL Domino data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.