Ready to get started?

Learn more about the CData ADO.NET Provider for SAP SuccessFactors or download a free trial:

Download Now

Build MVC Applications with Connectivity to SAP SuccessFactors Data

This article shows how to use only the Entity Framework and the CData ADO.NET provider to access SAP SuccessFactors from an ASP.NET MVC application.

This article shows how to use wizards in Visual Studio to drop the CData ADO.NET Provider for SAP SuccessFactors into a simple MVC (model, view, controller) project.

Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

  1. Create a new MVC project in Visual Studio. In this example, the project name is MvcSAPSuccessFactorsApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the SAP SuccessFactors Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

    Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.

  3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is SAPSuccessFactorsModel.
  4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  5. Click New Connection. Select CData SAP SuccessFactors Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    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.

    A typical connection string is below:

    User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
  7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as SAPSuccessFactorsEntities.

  8. Select the tables and views you need. In this example, ExtAddressInfo is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
  9. Build your project to complete this step.

Scaffold the Controller and Views

After creating the model and building the project, you can use ASP.NET Scaffolding wizards to create the controller and the views.

  1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
  2. In the Add Controller dialog that is then displayed, select the following options:

    • Model class: Select a table you imported; for example, ExtAddressInfo.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

You can now access the list of ExtAddressInfo records at http://MySite/ExtAddressInfo. Next to each record are links to edit, delete, and see more information. You can also create new ExtAddressInfo records. With every state change the site picks up any data changes.