Provide OData Services of FinancialForce Data from a WCF Application

Ready to get started?

Download for a free trial:

Download Now

Learn more:

FinancialForce ADO.NET Provider

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



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

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

    A typical connection string is below:

    User=myUser;Password=myPassword;Security Token=myToken;InitiateOAuth=GETANDREFRESH

    There are several authentication methods available for connecting to FinancialForce: login credentials, SSO, and OAuth.

    Authenticating with a Login and Token

    Set the User and Password to your login credentials. Additionally, set the SecurityToken. By default, the SecurityToken is required, but you can make it optional by allowing a range of trusted IP addresses.

    To disable the security token:

    1. Log in to FinancialForce and enter "Network Access" in the Quick Find box in the setup section.
    2. Add your IP address to the list of trusted IP addresses.

    To obtain the security token:

    1. Open the personal information page on FinancialForce.com.
    2. Click the link to reset your security token. The token will be emailed to you.
    3. Specify the security token in the SecurityToken connection property or append it to the Password.

    Authenticating with OAuth

    If you do not have access to the user name and password or do not want to require them, use the OAuth user consent flow. See the OAuth section in the Help for an authentication guide.

    Connecting to FinancialForce Sandbox Accounts

    Set UseSandbox to true (false by default) to use a FinancialForce sandbox account. Ensure that you specify a sandbox user name in User.

  9. Select FinancialForce 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 FinancialForceService{ public class FinancialForceDataService : DataService<FinancialForceEntities> { 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/FinancialForceDataService.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.