Installing IBM WebSphere Business Integration Collaborations Documentation

This document describes how to install the product document plug-ins for IBM(R) WebSphere(R) Business Integration Collaborations.  This information has been packaged as Eclipse document plug-ins.

About the product documentation

The documentation is packaged as an Eclipse document plug-in and must be viewed using the IBM WebSphere Help System. The help system and document plug-in format are based on an open source approach developed by the Eclipse Project (www.eclipse.org).  IBM product document plug-ins are contained in folders that follow a consistent naming convention (com.ibm.xxx.doc).

Installing document plug-ins

To view IBM product documentation in the help system, you must install new or updated document plug-ins into the eclipse\plugins folder.  The help system works with any information that has been packaged as an Eclipse document plug-in, including IBM product document plug-ins.  IBM product plug-in folders are easily identified because they use a common naming convention (com.ibm.xxx.doc).

To install document plug-ins, complete the following steps:

  1. Ensure that you have already installed the IBM WebSphere Help System. For details, see downloading the IBM WebSphere Help System.
  2. Obtain the document plug-ins. For example, you might go to an IBM product Web page to download document plug-ins.
  3. Copy the document plug-in folders to the eclipse\plugins folder of help system.  For example, if you installed the help system to c:\WebSphere Help System, you would copy the document plug-in folders to: c:\WebSphere Help System\eclipse\plugins
  4. To see the newly added document plug-in, start the help system (or shut it down and restart it if it was running).

Starting the help system

To start the help system:

  1. Open the WebSphere Help System folder.
  2. Double-click the WebSphere help start.bat file.

Note: It might take a few minutes for the system to start and the document plug-ins to be displayed the first time you start it.

Shutting down the help system

When you close the help system by simply closing its window, the help system processes are still running in the background. This enables a much faster launch during subsequent sessions. However, you must shut down these help system processes when you install document plug-ins or update the help system with new plug-ins.  Shutting down the help system when not in use also frees up system memory.  When you shut down your machine, all help system processes shut down.

To shut down the help system:

  1. Open the WebSphere Help System folder.
  2. Double-click the WebSphere help end.bat file.

(C) Copyright IBM Corporation 2004. All Rights Reserved.