Provide OData Services of PingOne Data from a WCF Application

The CData ADO.NET Provider for PingOne enables you to rapidly develop service-oriented applications using the Windows Communication Foundation (WCF) framework, providing PingOne 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 PingOne 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.PingOne" type="System.Data.CData.PingOne.PingOneProviderServices, System.Data.CData.PingOne.Entities.EF6" />
       </providers>
      </entityFramework>
      </configuration>

   2. Add a reference to System.Data.CData.PingOne.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 PingOne Data Source and enter the necessary credentials.

   A typical connection string is below:

   AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;

   To connect to PingOne, configure these properties:

   • : The region where the data for your PingOne organization is being hosted.
   • : The type of authentication to use when connecting to PingOne.
   • Either (required when using the default PingOne domain) or , configured as described below.

   Configuring WorkerAppEnvironmentId

   is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.

   First, find the value for this property:

   1. From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
   2. Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
   3. In the environment's home page navigation sidebar, click Applications.
   4. Find your OAuth or Worker application details in the list.
   5. Copy the value in the Environment ID field. It should look similar to:
      

      WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

   Now set to the value of the Environment ID field.

   Configuring AuthorizationServerURL

   is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.

   Authenticating to PingOne with OAuth

   PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:

   • Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
   • To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
   • Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.

   OAuth (Authorization Code grant)

   Set to OAuth.

   Desktop Applications

   Get and Refresh the OAuth Access Token

   After setting the following, you are ready to connect:

   • : GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the each time you connect, use .
   • : The Client ID you obtained when you created your custom OAuth application.
   • : The Client Secret you obtained when you created your custom OAuth application.
   • : The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333

   When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

   1. The driver obtains an access token from PingOne and uses it to request data.
   2. The OAuth values are saved in the location specified in , to be persisted across connections.

   The driver refreshes the access token automatically when it expires.

   For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.

   👁 Required connection properties, specified in the Add Connection dialog. (Salesforce is shown.)
   
9. Select PingOne tables and views that you want OData clients to access. 👁 Available tables in the Entity Data Model Wizard. (Salesforce is shown.)
   
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 PingOneService{
     public class PingOneDataService : DataService<PingOneEntities> {
     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: 👁 The raw OData feed. (Salesforce is shown.)
    

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/PingOneDataService.svc/. 👁 The OData URL for PingOne.
   
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. 👁 Available tables in the Table Import Wizard. (Salesforce is shown.)
   
6. Click Close to import the data in Power Pivot. 👁 The table loaded in Power Pivot. (Salesforce is shown.)