Provide OData Services of Sage 50 UK Data from a WCF Application



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

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

    A typical connection string is below:

    URL=http://your-server:5493/sdata/accounts50/GCRM/your-address;User=Manager;

    Note: Only Sage 50 UK 2012 and above are supported.

    The User and Password properties, under the Connection section, must be set to valid Sage 50 UK user credentials. These values will be the same used to log in to the Sage 50 UK software.

    Additionally, the URL property, under the Connection section, will need to be set to the address of the company dataset desired. To obtain the address, do the following:

    1. If you have not already done so, open the Sage 50 UK software.
    2. Click Tools -> Internet Options.
    3. Select the SData Settings tab.
    4. Click the Details button next to Sage 50 Accounts. A window is displayed containing a list of company names along with the address to their corresponding datasets.
    5. Set the URL property to the value in the address field next to the company desired.

  9. Select Sage 50 UK 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 Sage50UKService{ public class Sage50UKDataService : DataService<Sage50UKEntities> { 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/Sage50UKDataService.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 Sage UK Data Provider to get started:

 Download Now

Learn more:

Sage 50 UK Icon Sage UK ADO.NET Provider

Complete read-write access to Sage 50 UK enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any .NET application.