Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Provide OData Services of Sage 300 Data from a WCF Application
In this article, we will demonstrate the process of generating an OData feed for Sage 300 data by developing a WCF Service Application.
The CData ADO.NET Provider for Sage 300 enables you to rapidly develop service-oriented applications using the Windows Communication Foundation (WCF) framework, providing Sage 300 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 300 data via OData.
- Open Visual Studio and create a new project. Select the WCF Service Application template.
- Delete the autogenerated IService.cs and Service1.svc.
- 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
- Register the Entity Framework provider:
- 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.Sage300" type="System.Data.CData.Sage300.Sage300ProviderServices, System.Data.CData.Sage300.Entities.EF6" /> </providers> </entityFramework> </configuration>
- Add a reference to System.Data.CData.Sage300.Entities.dll, located in lib/4.0 in the installation directory.
- Build the project to complete the setup for using EF6.
- 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.
- Click Project -> Add New Item -> ADO.NET Entity Data Model.
- In the Entity Data Model wizard that is displayed, select the 'EF Designer from Database' option.
- In the resulting Choose Your Connection dialog, click New Connection.
In the Connection properties dialog, select the CData Sage 300 Data Source and enter the necessary credentials.
A typical connection string is below:
User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;
Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.
- Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the
option under Security Groups (per each module required). - Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
- Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.
Authenticate to Sage 300 using Basic authentication.
Connect Using Basic Authentication
You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.
- Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
- User: Set this to the username of your account.
- Password: Set this to the password of your account.
- Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the
- Select Sage 300 tables and views that you want OData clients to access.
- Click Project -> Add New Item -> WCF Data Service.
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 Sage300Service{ public class Sage300DataService : DataService<Sage300Entities> { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("*", EntitySetRights.All); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3; } } }
- 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.
- Open Excel and click on the Power Pivot Window button.
- A new pop-up will appear. Select the option From Data Feeds.
- In the resulting Table Import Wizard, enter the OData URL. For example, http://localhost:12449/Sage300DataService.svc/.
- After connecting to the OData service, click the Next button at the bottom of the window.
- 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.
- Click Close to import the data in Power Pivot.