Symphony API - Export Notes View to Spreadsheet

Abstract

ShowTable of Contents

HideTable of Contents

1 Available functionality
2 Access the API

The Symphony Add-on API of XPages2Eclipse builds a bridge between XPages applications and the Symphony application installed into the Lotus Notes Client.

Available functionality

The API contains almost the whole set of classes and methods from the Symphony SDK

that is available for Symphony version 3.

In short, it covers reading and writing data from/to Symphony Documents, Spreadsheets and Presentations. The full Javadoc for the supported classes is available here in this product wiki.

Please note that for Lotus Notes 8.5.2, the embedded Symphony has to be updated to version 3 first to make the XPages2Eclipse Symphony Add-on API work.
However, this is not required for Lotus Notes 8.5.3, which will already contain the newest Symphony release.

Access the API

You get access to the embedded Symphony application instance by calling the method com.x2e.SymphonyAPI.getApplication(conn) with a valid XPages2Eclipse connection object.

Afterwards you can use the available methods to work with the currently open content:

var app=com.x2e.SymphonyAPI.getApplication(conn);
var activeDoc=app.getActiveDocument();
var activeSpreadsheet=app.getActiveSpreadsheet();
var activePresentation=app.getActivePresentation();
var documents=app.getDocuments();
var spreadsheets=app.getSpreadsheets();
var presentations=app.getPresentations();