This topic outlines all necessary steps to setup the Eclipse IDE with the IBM Lotus Expeditor Toolkit for launching IBM Lotus Notes from Eclipse and for being able to develop Eclipse components to be used in composite applications in Notes.
The following products need to be installed:
- a Java Runtime Environment (JRE) used to launch Eclipse which will be replaced later with the JRE that comes with Notes
- IBM Lotus Notes 8.*
Download and install Eclipse version 3.2.2 which can be obtained from this location
Warning: Only Eclipse version 3.2.* is supported by the Expeditor toolkit. Currently, it won't work with Eclipse version 3.3. Thus, Eclipse 3.2.2 should be downloaded and installed from an Eclipse archive site as linked to above.
You just need to extract the ZIP archive and Eclipse is ready for usage.
Get the latest Expeditor toolkit from here and extract the downloaded ZIP archive to a temporary destination.
Then, follow these steps in order to set up Eclipse and the Expeditor toolkit to work with IBM Lotus Notes 8.*.
First, we have to change Eclipse's JRE to the one that comes with the Notes install.
1. Launch Eclipse and open the preferences dialog by choosing Window -> Preferences.
2. Expand "Java" and select "Installed JREs". Click the "Add..." button.
3. In the "Add JRE" window enter the following settings:
- For JRE type choose "Standard VM".
- For JRE name enter "Notes 8 VM".
- To select the JRE home directory, press "Browse..." and navigate to the JRE in the Notes installation folder. Check with the screen capture below to choose the proper directory (the path depends on your Notes installation and version):
" to close this dialog, make sure the new JRE is selected and press "OK
We are now ready to add the Expeditor toolkit to the Eclipse IDE.
Install the Expeditor toolkit
The Expeditor toolkit needs to be added to the Eclipse installation. To achieve this, follow these steps:
1. If not running yet, start Eclipse and launch the update manager by selecting Help -> Software Updates -> _Find and Install...
2. Make sure that the "Search for new features to install" button is selected and press "Next".
3. On the next page, press the "New Local Site..." button.
4. Browse to the temporary directory where you extracted the Expeditor toolkit download archive and select the folder named "Expeditor_Toolkit_install". Give the new local update site a suitable name, e.g. "XPD-Toolkit".
5. Make sure that the new local update site for the Expeditor toolkit is selected and press "Finish".
6. Expand the feature install list and select the "Lotus Expeditor Toolkit". Press "Next".
7. Accept the license agreement and press "Next". On the next page press "Finish". Now, the features of the Expeditor toolkit are loaded and analyzed. This can take a few moments.
8. In the upcoming feature verification dialog, press "Install All". Please allow some time for the actual installation of the toolkit into the Eclipse environment.
9. When asked to restart the Eclipse SDK, press "Yes" in the corresponding dialog.
10. When Eclipse relaunches, it will show an Expeditor toolkit configuration dialog. Enter settings equivalent to those depicted here and press "OK":
Now, the Expeditor toolkit has been installed into Eclipse and we are ready to go on with concluding configuration tasks.
Launching Notes from Eclipse
We create an Eclipse launcher for Notes (based on the Expeditor toolkit) in order to be able to develop, test and debug Eclipse components for Notes composite applications. First, in the Eclipse IDE, select Run -> Run....
In the launch configuration dialog, select "Client Services" on the left and press the button for creating a new launch configuration.
For the new configuration, add a new name (e.g. "Notes 8") and make sure that the Notes 8 JRE is selected. Press the "Apply" button to save this configuration.
In order to test the Notes launcher just created, press the "Run" button in the configuration dialog. Before, please shut down any other running Notes client because only one instance of Notes can be executed at a time.
There are two articles on IBM developerWorks that describe how to work with the Expeditor toolkit from a more general perspective: