Installing IBM WebSphere Business Integration Adapters, Version 2.4 Documentation

This document describes how to install the product documentation for IBM WebSphere Business Integration Adapters, Version 2.4. This information has been packaged as Eclipse document plug-ins, which you install with the documentation viewer. You will later need to move a small set of files to a specific product directory to enable context-sensitive help.

About the document plug-ins

The documentation is packaged as Eclipse document plug-ins and must be viewed using the IBM(R) WebSphere(R) Help System. The help system (or viewer) 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 the document plug-ins

To view IBM product documentation in the viewer, you must install new or updated document plug-ins into the eclipse\plugins folder of the IBM WebSphere Help System.  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. If you have existing IBM WebSphere Business Integration Adapter Version 2.4 document plug-ins installed on your system, you must delete the following plug-ins from the eclipse\plugins folder of the IBM WebSphere Help System before installing the new document plug-ins.
  4. Copy the document plug-in folders to the eclipse\plugins folder of the IBM WebSphere Help System. Keep in mind that this must be the eclipse\plugins folder of the IBM WebSphere Help system; you may have additional eclipse\plugins folders on your 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
  5. To see the newly added document plug-in, start the viewer (or shut it down and restart it if it was running).

Starting the viewer

To start the viewer:

  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 viewer

When you close the viewer by simply closing its window, its processes are still running in the background. This enables a much faster launch during subsequent sessions. However, you must shut down these processes when you install document plug-ins or update the help system with new plug-ins.  Shutting down the viewer 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 viewer:

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

Moving context-sensitive help plug-ins

Some of the Eclipse-based tools provided with the product use context-sensitive help that you can access by pressing the F1 key within the tool. This context-sensitive help is separate from the IBM WebSphere Help System and must be moved to a specific product location.

To install the context-sensitive help, move the following plug-in folders from your WebSphere Help System\eclipse\plugins folder to the \plugins folder in which you have installed the IBM WebSphere Business Integration toolset. This location may be in an installation of either IBM WebSphere Studio WorkBench or a version of IBM WebSphere Studio Application Developer, depending on the choices you made when you installed the IBM WebSphere Business Integration Adapters product. The plugin folders to move for the context-sensitive help system are:

You must choose the version of these folders that is appropriate for your broker. Select them as follows:

If your broker is WebSphere Application Server, select the com.ibm.btools.adaptermonitor.help and com.ibm.btools.csm.help folders from this directory:

contextplugins/was/

If your broker is one of the WebSphere message brokers (WebSphere MQ Integrator 2.1.0, WebSphere MQ Integrator Broker 2.1.0, or WebSphere Business Integration Message Broker), select the com.ibm.btools.adaptermonitor.help and com.ibm.btools.csm.help folders from this directory:

contextplugins/wmb/

If your broker is WebSphere InterChange Server, do not move these plug-in folders. Instead follow the installation instructions you receive when you download your WebSphere InterChange Server documentation.

The folders and files you are moving will overwrite folders of the same name that already exist in the destination location. For example, if you have installed the WebSphere Business Integration toolset into an installation of WebSphere Studio Application Developer Integration Edition, the location for the help files might look like this:

C:\ProgramFiles\IBM\WebSphereStudio\wstools\eclipse\plugins\com.ibm.btools.adaptermonitor.help C:\ProgramFiles\IBM\WebSphereStudio\wstools\eclipse\plugins\com.ibm.btools.csm.help

If you have difficulty locating the correct destination folder, do a search on one of the plugin folder names; for example, search on com.ibm.btools.csm.help. The files in the folders that you are moving must overwrite existing files within the existing product directory. For example, when you cut and paste the files, you will be overwriting an existing com.ibm.btools.csm.help plug-in with the new com.ibm.btools.csm.help plug-in that you have downloaded.

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