Extend Google Sheets with SAP Ariba Source Data

Interact with SAP Ariba Source data from Google Sheets through macros, custom functions, and add-ons. The CData API Server enables connectivity to SAP Ariba Source data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for SAP Ariba Source.

Google Apps Script can consume these OData services in the JSON format. This article shows how to create a simple add-on that populates a Google Spreadsheet with Vendors data and, as you make changes, executes updates to SAP Ariba Source data.

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure SAP Ariba Source OData services:

Connect to SAP Ariba Source

To work with SAP Ariba Source data from Google Sheets, we start by creating and configuring a SAP Ariba Source connection. Follow the steps below to configure the API Server to connect to SAP Ariba Source data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the SAP Ariba Source connection.
3. Enter the necessary authentication properties to connect to SAP Ariba Source.

   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.
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your SAP Ariba Source data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User.
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:

Creating API Endpoints for SAP Ariba Source

Having created a user, you are ready to create API endpoints for the SAP Ariba Source tables:

1. First, navigate to the API page and then click Add Table .
2. Select the connection you wish to access and click Next.
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm.

Gather the OData Url

Having configured a connection to SAP Ariba Source data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

Retrieve SAP Ariba Source Data

Open the Script Editor from your spreadsheet by clicking Tools -> Script Editor. In the Script Editor, add the following function to populate a spreadsheet with the results of an OData query:

function retrieve(){
  var url = "https://MyUrl/api.rsc/Vendors?select=Id,SMVendorID,Category,Region";
  var response = UrlFetchApp.fetch(url,{
    headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
  }); 
  var json = response.getContentText();
  var sheet = SpreadsheetApp.getActiveSheet();
  var a1 = sheet.getRange('a1');
  var index=1;
  var vendors = JSON.parse(json).value;

  var cols = [["Id","SMVendorID","Category","Region"]]; 
  sheet.getRange(1,1,1,4).setValues(cols);

  row=2;
  for(var i in vendors){
    for (var j in vendors[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "SMVendorID":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "Category":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "Region":
          a1.offset(row,3).setValue(account[i][j]);
          break;
      }      
    }
    row++;
  }
}

Follow the steps below to add an installable trigger to populate the spreadsheet when opened:

1. Click Resources -> Current Project's Triggers -> Add a New Trigger.
2. Select retrieve in the Run menu.
3. Select From Spreadsheet.
4. Select On open.

After closing the dialog, you are prompted to allow access to the application.

Post Changes to SAP Ariba Source Data

Add the following function to post changes to cells back to the API Server:

function buildReq(e){
  var sheet = SpreadsheetApp.getActiveSheet();
  var changes = e.range;
  var id = sheet.getRange(changes.getRow(),1).getValue();
  var col = sheet.getRange(1,changes.getColumn()).getValue();
  
  var url = "http://MyServer/api.rsc/Vendors("+id+")";
  var putdata = "{\"@odata.type\" : \"CDataAPI.Vendors\",  \""+col+"\": \""+changes.getValue()+"\"}";;
  UrlFetchApp.fetch(url,{
    method: "put",
    contentType: "application/json",
    payload: putdata,
    headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
  });

}

Follow the steps below to add the update trigger:

1. Click Resources -> Current Project's Triggers.
2. Select buildReq in the Run menu.
3. Select From Spreadsheet.
4. Select On edit.

You can test the script by clicking Publish -> Test as Add-On. Select the version, installation type, and spreadsheet to create a test configuration. You can then select and run the test configuration.

As you make changes to cells, the API Server executes updates to SAP Ariba Source data.