Ready to get started?

Learn more about the CData ADO.NET Provider for Microsoft CDS or download a free trial:

Download Now

Provide OData Services of Microsoft CDS Data from a WCF Application

This article shows how to publish an OData feed of Microsoft CDS data by creating a WCF Service Application.

The CData ADO.NET Provider for Microsoft CDS enables you to use the Windows Communication Foundation (WCF) framework to rapidly develop service-oriented applications that provide Microsoft CDS data to OData consumers. This article shows how to create an entity data model to provide the underlying connectivity to the Microsoft CDS data, as well as how to create a WCF Data Service to expose the OData service. You can then consume the feed with any OData client, for example, Power Pivot or an application that uses 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 Microsoft CDS 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. Click Project -> Add New Item -> ADO.NET Entity Data Model.
  4. In the Entity Data Model wizard that is displayed, select the 'EF Designer from Database' option.
  5. In the resulting Choose Your Connection dialog, click New Connection.
  6. In the Connection properties dialog, select the CData Microsoft CDS Data Source and enter the necessary credentials.

    A typical connection string is below:

    OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH

    You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
    • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
    • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

    When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

  7. Select Microsoft CDS tables and views that you want OData clients to access.
  8. Click Project -> Add New Item -> WCF Data Service.
  9. 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 CDSService{ public class CDSDataService : DataService<CDSEntities> { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("*", EntitySetRights.All); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3; } } }
  10. 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/CDSDataService.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.