Getting started

Abstract

ShowTable of Contents

HideTable of Contents

1 XPages2Eclipse control in DDE
2 API access from server-side JavaScript (SSJS)
3 API access from Java

XPages2Eclipse control in DDE

After you have successfully installed the XPages2Eclipse product in your Lotus Notes/Domino environment, a new control shows up in the control palette of the XPages editor in Domino Designer (DDE):

XPages2Eclipse control in control palette

To use XPages2Eclipse functionality in an XPages of your application, simply drag this control to the XPage. The first time you do this, you will see this prompt that you need to confirm:

API access from server-side JavaScript (SSJS)

To open a connection to the API and call a test method, add this code snippet to server-side JavaScript code, e.g. in the onClick event of a button:

var conn=X2E.createConnection();

var platformUI=x2e.PlatformUIAPI.getUI(conn);
platformUI.logToStatusBar("Hello World!");

The method createConnection creates a new API connection that is only valid for the current XPages page request. The connection is automatically disposed and it is the entry point for any API method calls.

Line 2 of our snippet accesses the first API that we will get to know: PlatformUI. This API corresponds to the Eclipse API class with the same name, with some functionality modified, added and removed to make it compatible with usable from an XPages application.

logToStatusBar is not actually part of the Eclipse version of PlatformUI, but was added to quickly write some status and debug information to the Notes Client status bar (which would be much more difficult when using Eclipse API directly).