Provide OData Services of Dynamics CRM Data from a WCF Application

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Dynamics CRM ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Microsoft Dynamics CRM account data including Leads, Contacts, Opportunities, Accounts, and more!



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

The CData ADO.NET Provider for Dynamics CRM enables you to use the Windows Communication Foundation (WCF) framework to rapidly develop service-oriented applications that provide Dynamics CRM data to OData consumers. This article shows how to create an entity data model to provide the underlying connectivity to the Dynamics CRM 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 Dynamics CRM 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.DynamicsCRM" type="System.Data.CData.DynamicsCRM.DynamicsCRMProviderServices, System.Data.CData.DynamicsCRM.Entities.EF6" /> </providers> </entityFramework> </configuration>
    2. Add a reference to System.Data.CData.DynamicsCRM.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 Dynamics CRM Data Source and enter the necessary credentials.

    A typical connection string is below:

    User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;

    The connection string options meet the authentication and connection requirements of different Dynamics CRM instances. To connect to your instance, set the User and Password properties, under the Authentication section, to valid Dynamics CRM user credentials and set the Url to a valid Dynamics CRM server organization root. Additionally, set the CRMVersion property to 'CRM2011+' or 'CRMOnline'. IFD configurations are supported as well; set InternetFacingDeployment to true.

    Additionally, you can provide the security token service (STS) or AD FS endpoint in the STSURL property. This value can be retrieved with the GetSTSUrl stored procedure. Office 365 users can connect to the default STS URL by simply setting CRMVersion.

  9. Select Dynamics CRM 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 DynamicsCRMService{ public class DynamicsCRMDataService : DataService<DynamicsCRMEntities> { 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/DynamicsCRMDataService.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.