Provide OData Services of SAP SuccessFactors Data from a WCF Application

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

   A typical connection string is below:

   User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;

   You can authenticate to SAP Success Factors using Basic authentication or OAuth with SAML assertion.

   Basic Authentication

   You must provide values for the following properties to successfully authenticate to SAP Success Factors. Note that the provider will reuse the session opened by SAP Success Factors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP Success Factors will be used for authentication.

   • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
   • User: set this to the username of your account.
   • Password: set this to the password of your account.
   • CompanyId: set this to the unique identifier of your company.

   OAuth Authentication

   You must provide values for the following properties, which will be used to get the access token.

   • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
   • User: set this to the username of your account.
   • CompanyId: set this to the unique identifier of your company.
   • OAuthClientId: set this to the API Key that was generated in API Center.
   • OAuthClientSecret: the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
   • InitiateOAuth: set this to GETANDREFRESH.

9. Select SAP SuccessFactors 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 SAPSuccessFactorsService{ public class SAPSuccessFactorsDataService : DataService<SAPSuccessFactorsEntities> { 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/SAPSuccessFactorsDataService.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.