Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
Extend Google Sheets with EnterpriseDB Data
Make calls to the API Server from Google Apps Script.
Interact with EnterpriseDB data from Google Sheets through macros, custom functions, and add-ons. The CData API Server, when paired with the ADO.NET Provider for EnterpriseDB (or any of 200+ other ADO.NET Providers), enables connectivity to EnterpriseDB data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for EnterpriseDB and any source supported by the CData ADO.NET Providers.
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 Orders data and, as you make changes, executes updates to EnterpriseDB data.
Set Up the API Server
Follow the steps below to begin producing secure EnterpriseDB OData services:
Deploy
The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.
The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.
Connect to EnterpriseDB
After you deploy the API Server and the ADO.NET Provider for EnterpriseDB, provide authentication values and other connection properties needed to connect to EnterpriseDB by clicking Settings -> Connections and adding a new connection in the API Server administration console.
The following connection properties are required in order to connect to data.
- Server: The host name or IP of the server hosting the EnterpriseDB database.
- Port: The port of the server hosting the EnterpriseDB database.
You can also optionally set the following:
- Database: The default database to connect to when connecting to the EnterpriseDB Server. If this is not set, the user's default database will be used.
Connect Using Standard Authentication
To authenticate using standard authentication, set the following:
- User: The user which will be used to authenticate with the EnterpriseDB server.
- Password: The password which will be used to authenticate with the EnterpriseDB server.
Connect Using SSL Authentication
You can leverage SSL authentication to connect to EnterpriseDB data via a secure session. Configure the following connection properties to connect to data:
- SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
- SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
- SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
- SSLClientCertType: The certificate type of the client store.
- SSLServerCert: The certificate to be accepted from the server.
You can then choose the EnterpriseDB entities you want to allow the API Server to access by clicking Settings -> Resources.
Authorize API Server Users
After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address: Connections from all addresses except localhost are blocked by default, so you will need to allow connections from Google's servers for this article. You can authenticate as well as encrypt connections with SSL.
Retrieve EnterpriseDB 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/Orders?select=Id,ShipName,ShipCity,ShipCountry";
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 orders = JSON.parse(json).value;
var cols = [["Id","ShipName","ShipCity","ShipCountry"]];
sheet.getRange(1,1,1,4).setValues(cols);
row=2;
for(var i in orders){
for (var j in orders[i]) {
switch (j) {
case "Id":
a1.offset(row,0).setValue(account[i][j]);
break;
case "ShipName":
a1.offset(row,1).setValue(account[i][j]);
break;
case "ShipCity":
a1.offset(row,2).setValue(account[i][j]);
break;
case "ShipCountry":
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:
- Click Resources -> Current Project's Triggers -> Add a New Trigger.
- Select retrieve in the Run menu.
- Select From Spreadsheet.
- Select On open.
After closing the dialog, you are prompted to allow access to the application.
Post Changes to EnterpriseDB 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/Orders("+id+")";
var putdata = "{\"@odata.type\" : \"CDataAPI.Orders\", \""+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:
- Click Resources -> Current Project's Triggers.
- Select buildReq in the Run menu.
- Select From Spreadsheet.
- 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 EnterpriseDB data.
