Using IBM Lotus Expeditor Toolkit V6.1 with IBM Lotus Notes V8 and IBM Lotus Sametime

Get started using IBM Lotus Expeditor Toolkit for development of applications for IBM Lotus Notes V8 and IBM Lotus Sametime. Learn which installation options to select, how to configure the toolkit, and how to launch a sample application on your target environment.

Share:

Pierre Carlson (mpcarl@us.ibm.com), Developer, IBM, Software Group

Pierre Carlson has worked in various development and leadership roles in systems and application development for IBM Austin since 1998. As the Lotus Expeditor Toolkit Architect, he is leading the design and planning work for future releases of this product. Prior to this, Pierre led the IBM WebSphere Everyplace Client Toolkit and the IBM WebSphere Everyplace Deployment JSR-172 Web services runtime and tools team, led the development team for the IBM Interactive Solutions Marketplace, and worked on operating systems, print drivers, and other systems. When not working for IBM, Pierre spends his free time working on a Master's degree in Computer Science.



14 February 2008 (First published 30 October 2007)

Also available in Chinese

As you know, IBM Lotus Notes V8 and IBM Lotus Sametime are built on the IBM Lotus Expeditor V6.1 platform. Because of this, many of the same applications can run on all these platforms. For the Java, J2EE, and Eclipse RCP developer, this means that you can use the same tools and skills that you already have to build applications for Lotus Notes, Lotus Sametime, and Lotus Expeditor using Lotus Expeditor Toolkit. In this article, you learn how to use Lotus Expeditor Toolkit in conjunction with the Eclipse Integrated Development Environment (IDE) or IBM Rational Application Developer for WebSphere Software to build and test Java and J2EE applications for use with Lotus Notes and Lotus Sametime. For a more general overview of the Lotus Expeditor Toolkit and development for Lotus Expeditor platform, see the developerWorks article, "Getting started with the IBM Lotus Expeditor Toolkit V6.1."

Who should use the toolkit?

Lotus Expeditor Toolkit is intended for use by Java, Eclipse RCP, and J2EE developers. Using the provided tools, you can reuse your existing skills and resources to deploy existing applications or to build new applications for your target runtime environment. Although the environment is very different from that of IBM Lotus Domino Designer, Lotus Domino developers can use the toolkit to write Java applications that can interface with existing NSF-based applications. Lotus Sametime developers can continue to use their existing projects with Lotus Expeditor Toolkit and take advantage of the simplified configuration and launch provided with the toolkit.


Download

A free version of Lotus Expeditor Toolkit V6.1 is available for download from the developerWorks Lotus Toolkits page. The downloaded file contains an update site that can be installed into an existing IDE based on Eclipse 3.2.2 or later, such as IBM Rational Application Developer for WebSphere Software V7.0.0.2. Lotus Sametime 7.5 and 8.0 developers should use the 6.1.1 release of the Lotus Expeditor Toolkit. Lotus Notes 8.0.x developers should use the 6.1.2 release.


Prerequisites

At a minimum, Lotus Expeditor Toolkit requires Eclipse 3.2.2. For most functions, including the sample used in this article, you should also install the Eclipse Web Tools Platform (WTP) 1.5.4. This can be installed from the predefined Callisto Discovery site available in Eclipse. If you do not already have a version of Eclipse and the Eclipse Web Tools Platform installed, you can download and install the Java EE project bundle of Eclipse from the IBM Callisto Simultaneous Release project page. The Java EE project bundle and Lotus Expeditor Toolkit together provide everything you need to develop Java, Web, and Web services applications for Lotus Expeditor. Most application types can be created using just Eclipse Callisto (3.2.2), WTP, and the toolkit. If you create embedded transaction applications or portlet applications, you need to install Rational Application Developer V7.0. If you are not already a Rational Application Developer user, you can download and install an evaluation version of the software. Prior to installing Lotus Expeditor Toolkit in Rational Application Developer, be sure to install to the latest fix pack of the Rational software. See table 1.

Table 1. Required software
Application type or required functionMinimum prerequisite software for Lotus Expeditor Toolkit
Standard Java and Eclipse RCP and eRCP Eclipse 3.2.2
Web application Java, JSP, servletEclipse 3.2.2 and Eclipse Web Tools Platform 1.5.4
Web Application Portlet embedded transaction container Rational Application Developer V7.0.0.2 or IBM Rational Software Architect V7.0.0.2

Lotus Notes V8 developer

In this section, we discuss the configuration and launch when targeting Lotus Notes. If you are developing only for Lotus Sametime, you can skip to the later section, "Lotus Sametime developer." The Lotus Expeditor Toolkit 6.1.1 can be used with Lotus Notes V8.0. The Lotus Expeditor Toolkit V6.1.2 can be used with either Lotus Notes V8.0 or Lotus Notes V8.0.1.

Configuring the Lotus Notes JRE

Before you install Lotus Expeditor Toolkit, configure the Lotus Notes V8 JRE for use with the toolkit. Start the IDE environment (Eclipse, Rational Application Developer, and so on) you plan to use with the toolkit and follow these steps:

  1. Choose Window – Preferences – Java – Installed JREs.
  2. Click Add.
  3. In the Add JRE window, do the following:
    • Set the JRE Type to Standard VM.
    • Enter the JRE Name as Notes 8 VM.
    • Click the Browse button, navigate to and select the jre directory located at <Notes_Install>\framework\rcp\eclipse\plugins\
      com.ibm.rcp.j2se.win32.x86_1.5.0.SR4-200707311521\jre, and then click OK. (NOTE: The versions will be different when using Lotus Notes V8.0.1.)
  4. Click OK, and then click OK again.

Prior to step 4, the completed configuration should look like the screenshot shown in figure 1.

Figure 1. Edit JRE dialog box
Edit JRE dialog box

You are now ready to install the toolkit.

Installing the toolkit

After you download the Lotus Expeditor Toolkit ZIP file, unzip the file to a temporary location. To access the toolkit installation instructions, release notes, and other documentation, open the autorun.html file in your browser of choice.

Lotus Expeditor Toolkit is divided into four features in two categories as shown in figure 2. The desktop category includes Lotus Expeditor Toolkit 6.1.1.20070731, Lotus Expeditor Development Runtimes VM 6.1.1.200707311521, and Lotus Expeditor Development Runtimes 6.1.1.200707311521. The device category includes Lotus Expeditor Tooling for Devices 6.1.1.0-20070626. When developing for Lotus Notes V8, you need to install only the Lotus Expeditor Toolkit 6.1.1.20070731 feature. NOTE: If using Lotus Expeditor Toolkit V6.1.2, the version numbers will be slightly different.

Figure 2. Features to install window
Features to install window

When the installation process is complete, you are prompted to restart the platform. Click OK.

Configurating the toolkit

After you restart the IDE platform, you are presented with the toolkit configuration dialog box. You can configure the IDE environment by following these steps. See figure 3 for the final settings.

  1. Select Lotus Notes 8 in the test environment drop-down box.
  2. Click Browse, and then select the <Notes_Install>\framework\eclipse directory and click OK.
  3. Select Notes 8 VM in the VM Name drop-down box.
  4. Click OK.

It is also recommended that you select the option "Attempt to configure the toolkit the first time a workspace opens" in the Auto-Configuration Preference dialog box. This selection causes the configuration dialog box to be presented only the first time the toolkit is used in a workspace. You can change this preference later, if needed, by choosing Window – Preference – Client Services. When you click OK, the IDE is reconfigured for development against Lotus Expeditor Client for Desktop.

Figure 3. Lotus Expeditor Toolkit Configuration window
Lotus Expeditor Toolkit Configuration window

You are now ready to begin developing Lotus Expeditor and J2EE applications and components that you can run in Lotus Notes V8.

Importing a sample

Lotus Expeditor Toolkit provides many samples that work in both Lotus Expeditor and Lotus Notes V8 environments. When you use Rational Application Developer, you can import the samples using the Samples Gallery. To start the Samples Gallery from Rational Application Developer, choose Help - Samples Gallery. The Samples Gallery is displayed in a new window. Lotus Expeditor samples appear under the Showcase samples, Application samples, and Technology samples sections of the Samples Gallery.

For our purposes, we show you how to import the samples if you are using only the Eclipse IDE. The samples are installed when you install the toolkit and need to be imported into your workspace. Follow these steps to import the property broker sample in your IDE workspace.

  1. Choose File – Import – General – Existing Projects into Workspace, and then click Next.
  2. Select the Select archive file option, and then click Browse.
  3. Use the browse dialog box to select the property broker sample. The sample archive is located at <toolkit_install>\plugins\
    com.ibm.rcp.tools.samplegallery2_6.1.1.20070731\archive\propertybroker.jar. (Versions will be slightly different in the 6.1.2 version of the toolkit.)
  4. Click Open, and then click Finish.

The property broker sample is imported into your workspace as shown in figure 4.

Figure 4. The property broker sample
The property broker sample

Launching the toolkit

Lotus Expeditor Toolkit provides a custom preconfigured launcher that can be used to launch Lotus Notes without the need for additional configuration settings. You can access the launcher, named Client Services, by choosing Run - Run from the IDE menu. Select the Client Services launcher in the left pane, and then click the New button. This creates a new instance of the Client Services launcher as shown in figure 5.

Figure 5. Creating a new instance of the Client Services launcher
Creating a new instance of the Client Services launcher

If you select the Target tab (see figure 6) of the launch configuration, you see that the Lotus Notes V8 target has been selected already. Because there can be only one Lotus Notes instance running at any time, shut down Lotus Notes before launching from the IDE. Clicking the Run button launches the Lotus Notes V8 platform. If runniing with Lotus Notes V8.0.1, select that in the dropdown list., You can make Lotus Notes V8.0.1 the default selection by changing the Default Target Selection on the Window - Preferences - Client Services - Development preference page.

Figure 6. The Target tab of the launch configuration window
The Target tab of the launch configuration window

After you log into Lotus Notes, you see your normal Lotus Notes workspace.

If you imported the property broker sample as shown earlier, you can now start the sample from the Lotus Notes Open menu. Choose Open – Property Broker Color Sample. After the sample is open, double-click a color name on the left to update the right views to that color. The communication between the views is done using the property broker component, which is part of the Lotus Expeditor platform and therefore available in Lotus Notes V8. See figure 7.

Figure 7. The Color List View Sample application view
The Color List View Sample application view

Lotus Sametime developer

In this section, we discuss the configuration and launch when targeting Lotus Sametime.

Installing the toolkit

After you download the toolkit ZIP file, unzip the file in a temporary location. To access the toolkit installation instructions, release notes, and other documentation, open the autorun.html file in your browser of choice.

Lotus Expeditor Toolkit is divided into four features in two categories as shown in figure 8. The desktop category includes Lotus Expeditor Toolkit 6.1.1.20070731, Lotus Expeditor Development Runtimes VM 6.1.1.200707311521, and Lotus Expeditor Development Runtimes 6.1.1.200707311521. The device category includes Lotus Expeditor Tooling for Devices 6.1.1.0-20070626. When developing for Lotus Sametime, install the Lotus Expeditor Toolkit 6.1.1.20070731 feature and the Lotus Expeditor Development Runtimes VM 6.1.1.200707311521 feature. This installs the toolkit and the virtual machine required to run Lotus Sametime.

Lotus Sametime V8.0 customers can also use the Lotus Expeditor Toolkit V6.1.1 for development. The Lotus Sametime SDK 8.0 contains an update for the Lotus Expeditor Toolkit 6.1.1 that enables development for Lotus Sametime V8.0. After installing the Lotus Expeditor Toolkit V6.1.1, Lotus Sametime V8 developers should install the update from the st80sdk\client\connect\stXpdToolkitProfile directory of the SDK. More details can be found in the Lotus Sametime V8.0 Integration Guide.

Figure 8. Features to install window
Features to install window

When the installation process is complete, you are prompted to restart the platform. Click OK.

Configuring the toolkit

After you restart the IDE platform, you are presented with the toolkit configuration dialog box. You can configure the IDE environment by following these steps. See figure 9 for the final settings.

  1. Select Lotus Sametime in the Test Environment drop-down box.
  2. Click Browse, and then select the IBM Lotus Sametime Connect installation directory (that is, C:\Program Files\IBM\Sametime Connect) in the Target Location field and click OK.
  3. Select jclDesktop Win32 x86 in the VM Name drop-down box (or jclDesktop Linux x86 if you are running Linux).
  4. Click OK.

It is also recommended that you select the option "Attempt to configure the toolkit the first time a workspace opens" in the Auto-Configuration Preference dialog box. This selection causes the configuration dialog box to be presented only the first time the toolkit is used in a workspace. You can change this preference later in any workspace by choosing Windows – Preferences – Client Services. When you click OK, the IDE is reconfigured for development against Lotus Expeditor Client for Desktop.

Figure 9. Lotus Expeditor Toolkit Configuration window
Lotus Expeditor Toolkit Configuration window

Importing a sample

Although Lotus Expeditor Toolkit provides many samples that work with Lotus Sametime, let’s use the Recent Buddies sample from the Lotus Sametime V7.5.1 SDK. If you do not already have the Lotus Sametime V7.5.1 SDK, you can download it from the developerWorks Lotus Toolkits page. Download the SDK, and unzip it on your local file system (c:\st571sdk).

To import the sample, do the following:

  1. Choose File – Import – General – Existing Projects into Workspace, and then click Next.
  2. Select the Select archive file option.
  3. Click Browse.
  4. Browse to and select the com.ibm.collaboration.realtime.sample.recentbuddies_7.5.1.jar file located in the <SDK>\ client\connect\samples directory.
  5. Click Finish (see figure 10).
Figure 10. Import window
Project Import window

Launching the toolkit

Lotus Expeditor Toolkit provides a custom launcher that you can use to launch Lotus Sametime without the need for additional configuration settings. You can access the launcher, named Client Services, by choosing Run - Run from the IDE menu. Select the Client Services launcher in the left pane, and then click the New button to create a new instance of the Client Services launcher as shown in figure 5. If you select the Target tab of the launch configuration, you see that the Lotus Sametime target has been selected already. Clicking the Run button launches the Lotus Sametime platform with the sample application as shown in figure 11.

Figure 11. Launching Lotus Sametime
Launching Lotus Sametime

Moving components between Lotus Sametime, Lotus Notes, and Lotus Expeditor

Because many components and applications built using Lotus Expeditor Toolkit can be deployed to any of the Lotus Expeditor-based platforms (that is, Lotus Notes V8, Lotus Sametime, and Lotus Expeditor V6.1), the toolkit supports moving among the environments. If you want to change the configuration of the toolkit later, you can access the configuration preference by choosing Window - Preferences - Client Services. On this page, you can reconfigure the environment to any of the other supported environments. Click the Configure button, and then modify the IDE using the same dialog box as presented at startup. After you save your changes in the dialog box, Eclipse is updated with your new selections. Figure 12 shows the Lotus Sametime Recent Buddies sample running in the Lotus Notes V8 sidebar with embedded Lotus Sametime.

Figure 12. The Getting Started window in Lotus Notes V8
The Getting Started window in Lotus Notes V8

Conclusion

This article reviewed the process for installing and configuring Lotus Expeditor Toolkit for use with Lotus Notes V8 and Lotus Sametime. It showed how to configure the environment, import a sample application, and launch the application using your target runtime environment. For more information on the project types and advanced features of Lotus Expeditor Toolkit, please see the developerWorks article,"Getting started with the IBM Lotus Expeditor Toolkit V6.1."

Resources

Learn

Get products and technologies

Discuss

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into IBM collaboration and social software on developerWorks


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Lotus, WebSphere
ArticleID=265428
ArticleTitle=Using IBM Lotus Expeditor Toolkit V6.1 with IBM Lotus Notes V8 and IBM Lotus Sametime
publish-date=02142008