Build MVC Applications with Connectivity to SAP Ariba Source Data

In this article, we will guide you through the process of utilizing wizards within Visual Studio to seamlessly integrate the CData ADO.NET Provider for SAP Ariba Source into a basic 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 MvcSAPAribaSourceApp.

2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the SAP Ariba Source 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 SAPAribaSourceModel.
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 Ariba Source Data Source in the dialog that is displayed.

6. Specify the required connection string properties.

   In order to connect with SAP Ariba Source, set the following:

   • API: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role (possible values are SupplierDataAPIWithPaginationV4, SourcingProjectManagementAPIV2, or ContractAPIV1).
   • DataCenter: The data center where your account's data is hosted.
   • Realm: The name of the site you want to access.
   • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

   If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

   • User: Id of the user on whose behalf API calls are invoked.
   • PasswordAdapter: The password associated with the authenticating User.

   If you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

   Authenticating with OAuth

   After setting connection properties, you need to configure OAuth connectivity to authenticate.

   • Set AuthScheme to OAuthClient.
   • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

     For more information on creating an OAuth application, refer to the Help documentation.

   Automatic OAuth

   After setting the following, you are ready to connect:

   APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

   When you connect, the provider automatically completes the OAuth process:

   1. The provider obtains an access token from SAP Ariba and uses it to request data.
   2. The provider refreshes the access token automatically when it expires.
   3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

   A typical connection string is below:

   API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;

   👁 The connection for the model. (QuickBooks is shown.)
   

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 SAPAribaSourceEntities.

   👁 The completed connection step in the ADO.NET Entity Data Model wizard. (A QuickBooks connection is shown.)
   
8. Select the tables and views you need. In this example, Vendors is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.👁 Tables to be imported into the .edmx file. (QuickBooks is shown.)
   
9. Build your project to complete this step.

Scaffold the Controller and Views

Once you've established the model and completed the project build, you can employ ASP.NET Scaffolding wizards to generate both 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, Vendors.
   • Data context class: Select your context class.
3. Leave the default values for the other fields. 👁 Creating a new controller from an existing entity data model in the Add Controller dialog in MVC 5. (QuickBooks is shown.)
   

You can now access the list of Vendors records at http://MySite/Vendors. Next to each record are links to edit, delete, and see more information. You can also create new Vendors records. With every state change the site picks up any data changes. 👁 The live table. (QuickBooks is shown.)