Provide OData Services of HCL Domino Data from a WCF Application

The CData ADO.NET Provider for HCL Domino enables you to rapidly develop service-oriented applications using the Windows Communication Foundation (WCF) framework, providing HCL Domino data data to OData consumers. This article guides you through creating an entity data model for connectivity and a WCF Data Service to expose OData services. You can then consume the feed with various OData clients, such as Power Pivot or applications using the CData ADO.NET Provider for OData.

Create the OData Service

Follow the steps below to create a WCF service application that will provide connectivity to HCL Domino data via OData.

1. Open Visual Studio and create a new project. Select the WCF Service Application template.
2. Delete the autogenerated IService.cs and Service1.svc.
3. Install Entity Framework 6:

   Use the Package Manager Console in Visual Studio to install the latest version of Entity Framework. Run the following command to download and install Entity Framework automatically: Install-Package EntityFramework

4. Register the Entity Framework provider:
   1. Add the following provider entry in the "providers" section of your App.config or Web.config file. This section should already exist if the Entity Framework installation was successful. <configuration> ... <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Domino" type="System.Data.CData.Domino.DominoProviderServices, System.Data.CData.Domino.Entities.EF6" /> </providers> </entityFramework> </configuration>
   2. Add a reference to System.Data.CData.Domino.Entities.dll, located in lib/4.0 in the installation directory.
   3. Build the project to complete the setup for using EF6.
5. Click Project -> Add New Item -> ADO.NET Entity Data Model.
6. In the Entity Data Model wizard that is displayed, select the 'EF Designer from Database' option.
7. In the resulting Choose Your Connection dialog, click New Connection.

8. In the Connection properties dialog, select the CData HCL Domino Data Source and enter the necessary credentials.

   A typical connection string is below:

   Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*

   Prerequisites

   The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

   Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.

   Authenticating to Domino

   • Server: The name or IP address of the server running Domino with the Proton service.
   • Port: The port number that the Proton service is listening on.
   • Database: The name of the database file, including the .nsf extension.
   • SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
   • SSLClientCert: The path to the certificate file.
   • SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.

   Additional Server Configuration

   The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.

   Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.

9. Select HCL Domino tables and views that you want OData clients to access.
10. Click Project -> Add New Item -> WCF Data Service.

11. Specify the data source class and configure access to the new WCF Data Service. In the example below, the Access Rule for the entities is set to All. This means that any user will be able to read and modify data.

    using System; using System.Collections.Generic; using System.Data.Services; using System.Data.Services.Common; using System.Linq; using System.ServiceModel.Web; using System.Web; namespace DominoService{ public class DominoDataService : DataService<DominoEntities> { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("*", EntitySetRights.All); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3; } } }
12. Run the project. Applications that support OData can now access the Salesforce data and reflect any changes. You can access the feed in your browser. The feed will resemble the following:

Consume the OData Service from Power Pivot

You can now use the service from any OData client; for example, Excel Power Pivot.

1. Open Excel and click on the Power Pivot Window button.
2. A new pop-up will appear. Select the option From Data Feeds.
3. In the resulting Table Import Wizard, enter the OData URL. For example, http://localhost:12449/DominoDataService.svc/.
4. After connecting to the OData service, click the Next button at the bottom of the window.
5. A table listing of the available tables will appear in the next window of the wizard. Select which tables you want to import and click Finish.
6. Click Close to import the data in Power Pivot.