IBM Lotus Expeditor 6.2 Toolkit Installation Guide

Product Overview

Lotus® Expeditor Toolkit supports Eclipse and the Rational® Development environment. When used with IBM® Rational Software Delivery Platform (RSDP) 7.5, or Eclipse this toolkit provides a complete, integrated development environment for application development on desktops, laptops, and servers, with application deployment to desktops, laptops, and devices.

Lotus Expeditor Toolkit is a complete development environment in a single IDE for developing applications for the Lotus Notes® 8, Lotus Sametime®, and Lotus Expeditor Client platforms. The toolkit includes support for building Eclipse plug-ins, OSGi bundles, Web Application bundles, Portlet bundles, and Web Services clients and providers with WS-Security support. Projects and client launches can be easily managed through selection from predefined configurations. Custom configurations of the client platform can be built using the Platform Builder. Multiple samples are included. There are samples that focus on individual client services as well as samples, such as Order Entry, that show how individual client services can be combined into an end to end application.

Prerequisites and supported hardware and software

Ensure that your system meets the minimum software requirements before you install the Toolkit. Refer to the System Requirements section of the Lotus Expeditor Information Center for a complete list of system requirements and prerequisites:

Refer to the following document for information about the latest maintenance patches and releases: Recommended Maintenance for IBM Lotus Expeditor

Limitations when using Lotus Expeditor Toolkit on Eclipse + WTP

The following list describes functionality of Lotus Expeditor Toolkit that are supported when Lotus Expeditor Toolkit is installed into RAD and RSA, but are not supported when Lotus Expeditor Toolkit is installed into Eclipse + WTP:

Installation

Installing Lotus Expeditor Toolkit using the update site:

To install Lotus Expeditor Toolkit into your IDE using an the update site on the installation media, follow these steps.

1. Review release notes for product information, such as software limitations at the time of this release.
2. Log on to your system with an administrator ID that has write permission to the installation location and start the Rational Software Delivery Platform or Eclipse + WTP.
3. From the main menu, click Help > Software Updates The Software Updates and Add-ons dialog is displayed.
4. Select the Available Software tab.
   
5. Select Add Site and browse to the drive and directory where the Lotus Expeditor Toolkit update site zip file is located and click OK.
   
6. On the Available Software tab, select the check box next to the site name and click Install.
   Note: If you want to install a subset of the tools, expand the "Uncategorized section and check all of the options you want to install.
   
7. Review and confirm that the checked features are the features you want to install. Select Next.
8. Read the licensing information for each feature that you are installing, and if you agree with the license, select to accept the license and click Finish to begin the installation.
9. When installation completes, restart your IDE for changes to take effect.
10. To confirm that the installation was successful, start the platform and do the following:
    • Click Help > Software Updates . The Software Updates and Add-ons window is displayed. On the Installed Software tab, verify that Lotus Expeditor Toolkit 6.2 or Lotus Expeditor Tooling for Devices 6.2 is installed in the list. You can also click the Properties button to view information about installed software.
      

Using the Lotus Expeditor Clients with the Toolkit

To develop and test applications using the Toolkit, you must install the desired Clients on your development system.

To install the Lotus Expeditor Client for Desktop or Lotus Expeditor Client for Devices, refer to the Lotus Expeditor 6.2 - Client for Desktop and Client for Devices Installation Guide and Quick Reference on the Client DVD, or online here: IBM Lotus Expeditor 6.2 Client for Desktop and Client for Devices Installation Guide and Quick Reference

If you are developing applications for Lotus Notes 8 or Lotus Sametime, refer to the following documentation:

• Using the Lotus Expeditor Toolkit with Lotus Sametime
• Using the Lotus Expeditor Toolkit with Lotus Notes 8.0 or 8.0.1

Installing the Lotus Expeditor Desktop Development Utilities

The Development Enablement Utilities is a collection of utilities that are required to develop Lotus Expeditor Client for Desktop applications with the Lotus Expeditor Toolkit. Users who are developing applications for Lotus Expeditor Client for Devices, Lotus Notes 8 or Lotus Sametime environments do not need to install this component.

1. Launch the Lotus Expeditor Client.
2. Select Application > Install. The Install/Update dialog is displayed.
3. Select Search for new features to install and click Next.
4. Select Add Folder Location. Browse to the platform update site on the Client CD (in the desktop/updates/platform directory) and click OK.
5. Expand the updates/platform location, select the Lotus Expeditor Desktop Development Utilities feature and then click Next.
6. Restart Lotus Expeditor Client for Desktop to complete the installation and then exit.

Configuring the environment

You must install the appropriate Client and the Lotus Expeditor Desktop Development Utilities (if required) before you attempt to configure the Toolkit.

When the IDE is restarted after Toolkit installation, you are prompted through a configuration dialog to set preferences for either Lotus Notes 8, Lotus Expeditor Client for Desktop, and Lotus Expeditor Client for Devices environments. Select the appropriate environment for your application type, this step is necessary to develop and deploy these types of applications. Make sure the Target Location field points to the selected environment's install location. Click OK to configure the selected environment, which will set your target platform and the appropriate JRE selected in the dialog.

Once configured, the target platform and the JRE are registered with the toolkit. This process takes approximately 1-2 minutes, depending on your system. If you choose not to configure at this time, you will be prompted to configure the next time you restart the Workbench unless you select the "Never display" option in the configuration dialog.

After configuration completes, you can begin to launch and test your applications for the configured target platform..

Follow the steps in Setup for device development to configure the Lotus Expeditor Toolkit to develop applications for the Lotus Expeditor Client for Devices.

Migrating your workspace from previous versions of Lotus Expeditor Toolkit

The Lotus Expeditor Toolkit provides assistance for you to migrate the workspaces and Client Services projects from previous releases (6.0.0, 6.1.0, 6.1.1, and 6.1.2). You can migrate workspaces using Rational Application Developer (RAD) 7.5, or Eclipse 3.4.

Refer to Migrating applications for more information.

Creating and launching your first application

These instructions assume that you are using the Lotus Expeditor Toolkit with Rational platform. You can also import samples using Eclipse. For information on using the samples in Eclipse refer to Using the samples

To create and launch a project, follow these steps:

1. Import a Lotus Expeditor Toolkit sample application:
   1. Select Help > Help Contents.
   2. In the navigation pane, select Samples.
   3. Select Technology samples > Lotus Expeditor> Web Application.
   4. Select Import the sample.
   5. Click Finish. If prompted to switch to the Web Perspective, click No. A new project named com.ibm.pvc.tools.samples.web.hello is created in the workspace.
2. Create a new launch configuration:
   1. Select Run > Run Configurations....
      Note: If you switched to the Web Perspective, you cannot view the Run menu. To switch to another perspective, click Window > Open Perspective and select a different perspective.
   2. Select Client Services and click the New button.
   3. Click the Target tab.
   4. Verify the selection in the Target drop-down box is Default Target.
   5. Click the Run button. After a few moments, the Lotus Expeditor Client is available
3. To verify the application, select Open > Hello. The Hello application is launched in the embedded Web browser of the Lotus Expeditor Client.

Lotus Expeditor Toolkit samples

The Lotus Expeditor Toolkit contains a wide variety of samples, including the Web Application sample that you just launched. Click Help > Help Contents from the main menu and select Samples from the navigation panel to set up and launch other sample applications, including:

Accounts sample

The Accounts sample creates a Client Services project to illustrate the basic elements of a rich client application that uses the Accounts API on Lotus Expeditor.

Branding sample

The Branding sample creates a Client Services project to illustrate how to brand elements of the Lotus Expeditor user interface.

Composite Application sample

The Composite Application sample creates Client Services projects to illustrate the basic elements of developing composite applications on Lotus Expeditor.

DB2® Everyplace® sample

This sample illustrates a use of the local DB2 Everyplace database.

Derby Sample

This sample illustrates the use of the local Cloudscape® database.

Echo sample

Creates a Web Service Echo Demo, which includes three projects: Echo Server, Echo Client, and Echo Marshal. These projects provide custom serialization and deserialization, also called custom marshalling. Demonstrates how to expose an OSGi service as a Web service, use custom marshalling, and access a Web service as a dynamic client.

Echo Secure sample

Creates a Web Service Echo Secure Demo, which includes three projects: Echo Server Secure, Echo Client Secure, and Register User. These projects provide user registration for Web Services security running in the Lotus Expeditor Client environment. Demonstrates how to register an OSGi service as a secure Web service and access the service from a dynamic client.

Eclipse Preferences sample

This sample demonstrates the use of the OSGi Preferences Service to save and retrieve preference information.

Embedded Browser sample

This sample creates a Client Services project to illustrate the basic elements of launching an embedded browser with Embedded Browser API’s in the Lotus Expeditor workbench.

eRCP E-mail sample

This sample shows you how to construct an embedded Rich Client Platform (eRCP) application.

eSWT Demo sample

This sample contains a number of showcase applications that show embedded Standard Widget Technology (eSWT) widgets, both alone, and combined to form some simple application functionality.

ISync sample

This sample demonstrates how to use the ISync APIs to synchronize relational data from a DB2 Everyplace Sync Server to a local DB2 Everyplace or Cloudscape database

JMS with Lotus Expeditor micro broker sample

This sample demonstrates the use of the Java™ Message Service (JMS) publish and subscribe messaging interfaces with the micro broker JMS provider.

JMS with MQe Provider sample

This sample demonstrates the use of the Java Message Service (JMS) point-to-point messaging interfaces with the MQ Everyplace provider

JNDI

This sample demonstrates the use of JNDI APIs and declarative JNDI.

Mobile Adjuster sample

This sample demonstrates how an enterprise can extend their Web applications to mobile employees by implementing a services-oriented architecture using IBM Lotus Expeditor.

MQ Everyplace sample

This technology sample demonstrates the use of IBM WebSphere® MQ Everyplace (MQe).

Network Status/Fault sample

This sample creates a Client Services project to illustrate the basic elements of a rich client application that uses the Network Layer API on Lotus Expeditor.

Order Entry sample

Order Entry is a three-tier, sample application that demonstrates the following components and capabilities: Web container, Java Servlet 2.3, OSGi Preferences, MQe, JDBC, DB2e, RCP views, and preference pages.

OSGi Preferences Service sample

This sample demonstrates the use of the OSGi Preferences Service to save and retrieve preference information.

Pizza JSP sample

This sample demonstrates the usage of Java™ Server Pages (JSPs) within a web application intended for deployment on the Web Container. The sample application is a pizza-ordering web application.

Portlet Communication sample

This sample demonstrates two JSR168 portlets exchanging data.

Rich Application sample

This sample creates a Client Services project to illustrate the basic elements of a rich application.

Rich Text Editor sample

This sample demonstrates how to include the Rich Text Editor within an Eclipse view.

Secured Web Application sample

This sample demonstrates a local, secured Web application intended for deployment on the local Web container.

Service Tracker sample

This sample creates two Client Services project to demonstrate how to use OSGi service trackers.

Simple Portlet sample

This sample demonstrates a local JSR168 portlet enabled for local portlet container.

Simple Portlet Viewer sample

This sample demonstrates the use of the Portlet Viewer, a predefined view enabling display or JSR168 and WSRP portlets. This sample demonstrates the viewing of JSR168 portlets only.

Portlet Aggregation Web Page sample

This sample demonstrates the use of a Web page aggregation of portlets.

Property Broker sample

This sample creates a Client Services project to illustrate the basic elements of a rich client application that uses the Property Broker API on Lotus Expeditor.

Web Application Log sample

This sample demonstrates the usage of Java Server Pages (JSPs) within a web application intended for deployment on the local Web Container. The sample application displays log contents obtained from the OSGi LogReader service.

Web Application sample

This sample demonstrates the usage of Java Server Pages (JSPs) within a Web application intended for deployment on the local Web Container. The sample application is a Hello World application.

XML Parser sample

This sample creates a Client Services project to demonstrate how to use a Simple API for XML (SAX) parser to get information stored in XML files.

More information

Resources available on the Web

• Lotus Expeditor Web site: http://www.ibm.com/software/sw-lotus/lotus_expeditor - Contains technical resources and best practices for Lotus Expeditor.
• Lotus Software Web site: http://www.ibm.com/software/lotus/ - Provides information about Lotus products, solutions, and tools.
• IBM Education Assistant Web site: http://www.ibm.com/software/info/education/assistant/ - Provides narrated presentations, flash simulations, tutorials, and resource links to help you use IBM software products more successfully and effectively.
• Lotus Expeditor Support Web site: http://www.ibm.com/software/lotus/expeditor/support - Contains information on issues and workarounds, and instructions on how to contact IBM Support.

IBM Lotus Expeditor Licensed Materials - Property of IBM. (C) Copyright IBM Corp. 2006, 2008. All Rights Reserved. U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, Cloudscape, Lotus, Rational, and WebSphere are trademarks of International Business Machines Corporation in the United States, other countries, or both. Linux® is a registered trademark of Linus Torvalds in the United States, other countries, or both. Microsoft® and Windows®are registered trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others.