Extend Google Sheets with SAP Netweaver Gateway Data

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

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 SalesOrderLineItems data and, as you make changes, executes updates to SAP Netweaver Gateway 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 Netweaver Gateway OData services:

Connect to SAP Netweaver Gateway

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

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

   SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts. In addition to authenticating, set the following connection properties to access SAP Gateway tables.

   • Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment URL would just be: https://sapes5.sapdevcenter.com.
   • Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full URL to the service is specified.
   • Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full URL is specified.

   Authenticate via Basic Authentication

   In basic authentication, you use your login credentials to connect. Set the following properties:

   • User: This is the username you use to log in to SAP Gateway.
   • Password: This is the password you use to log in to SAP Gateway.

   Authenticate via OAuth Authentication

   You can connect to SAP Gateway using the embedded OAuth connectivity (without setting any additional authentication connection properties). When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

   
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 Netweaver Gateway 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 Netweaver Gateway

Having created a user, you are ready to create API endpoints for the SAP Netweaver Gateway 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 Netweaver Gateway 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 Netweaver Gateway 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/SalesOrderLineItems?select=Id,ProductID,Quantity,Quantity";
  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 salesorderlineitems = JSON.parse(json).value;

  var cols = [["Id","ProductID","Quantity","Quantity"]]; 
  sheet.getRange(1,1,1,4).setValues(cols);

  row=2;
  for(var i in salesorderlineitems){
    for (var j in salesorderlineitems[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "ProductID":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "Quantity":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "Quantity":
          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 Netweaver Gateway 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/SalesOrderLineItems("+id+")";
  var putdata = "{\"@odata.type\" : \"CDataAPI.SalesOrderLineItems\",  \""+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 Netweaver Gateway data.