Provide OData Services of Cvent Data from a WCF Application



In this article, we will demonstrate the process of generating an OData feed for Cvent data by developing a WCF Service Application.

The CData ADO.NET Provider for Cvent enables you to rapidly develop service-oriented applications using the Windows Communication Foundation (WCF) framework, providing Cvent 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 Cvent 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.Cvent" type="System.Data.CData.Cvent.CventProviderServices, System.Data.CData.Cvent.Entities.EF6" /> </providers> </entityFramework> </configuration>
    2. Add a reference to System.Data.CData.Cvent.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 Cvent Data Source and enter the necessary credentials.

    A typical connection string is below:

    OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;InitiateOAuth=GETANDREFRESH

    Before you can authenticate to Cvent, you must create a workspace and an OAuth application.

    Creating a Workspace

    To create a workspace:

    1. Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) >> Admin.
    2. In the Admin menu, navigate to Integrations >> REST API.
    3. A new tab launches for Developer Management. Click on Manage API Access in the new tab.
    4. Create a Workspace and name it. Select the scopes you would like your developers to have access to. Scopes control what data domains the developer can access.
      • Choose All to allow developers to choose any scope, and any future scopes added to the REST API.
      • Choose Custom to limit the scopes developers can choose for their OAuth apps to selected scopes. To access all tables exposed by the driver, you need to set the following scopes:
        event/attendees:readevent/attendees:writeevent/contacts:read
        event/contacts:writeevent/custom-fields:readevent/custom-fields:write
        event/events:readevent/events:writeevent/sessions:delete
        event/sessions:readevent/sessions:writeevent/speakers:delete
        event/speakers:readevent/speakers:writebudget/budget-items:read
        budget/budget-items:writeexhibitor/exhibitors:readexhibitor/exhibitors:write
        survey/surveys:readsurvey/surveys:write

    Creating an OAuth Application

    After you have set up a Workspace and invited them, developers can sign up and create a custom OAuth app. See the Creating a Custom OAuth Application section in the Help documentation for more information.

    Connecting to Cvent

    After creating an OAuth application, set the following connection properties to connect to Cvent:

    • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
    • OAuthClientId: The Client ID associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.
    • OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.

  9. Select Cvent 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 CventService{ public class CventDataService : DataService<CventEntities> { 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/CventDataService.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.

Ready to get started?

Download a free trial of the Cvent Data Provider to get started:

 Download Now

Learn more:

Cvent Icon Cvent ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Cvent.