Installing the documentation

You can install a local copy of the WebSphere Process Server Information Center on your computer.

About the document plug-ins

The documentation is packaged as Eclipse document plug-ins and must be viewed using the IBM WebSphere Help System. The help system (or viewer) and document plug-in format are based on an open source approach developed by the Eclipse Project.

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:

Install the IBM WebSphere Help System, which can be found on the CD labeled WebSphere Process Server CD 2. This component is in the \IEHS directory.
Obtain the document plug-ins from the IBM product Web page http://www.ibm.com/software/integration/wps/library/infocenter/.
Copy the document plug-in folders to the eclipse\plugins folder of the help system. For example, if you installed the help system to C:\ibm_help (the default), you copy the document plug-in folders to C:\ibm_help\eclipse\plugins. Keep in mind that this must be the eclipse\plugins folder of the IBM WebSphere Help system; you might have additional eclipse\plugins folders on your system.
To see the newly added document plug-in, start the viewer by following the instructions in Starting the viewer (or shut it down by following the instructions in Shutting down the viewer, and then restart it if it was running).

Starting the viewer

To start the viewer:

Open the WebSphere Help System folder (C:\ibm_help by default).
Double-click the 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:

Open the WebSphere Help System folder (C:\ibm_help by default).
Double-click the help_end.bat file.

Viewing information in different languages

To view information in a different language, change the regional settings of your operating system to the locale and language of your choice.

Important: The system will display the translated documentation that has been provided by the product owner. If the product owner has not provided the documentation in your chosen language but has provided the English version, the system will display the English version by default, even if the browser language option is set to another language.

Upgrading document plug-ins

To upgrade document plug-ins to a new release, patch, or refresh version, complete the following steps:

Obtain the new document plug-ins from the IBM product Web page http://www.ibm.com/software/integration/wps/library/infocenter/.
Copy the document plug-in folders to the eclipse\plugins folder of the help system. For example, if you installed the help system to C:\ibm_help (the default), you copy the document plug-in folders to C:\ibm_help\eclipse\plugins. Keep in mind that this must be the eclipse\plugins folder of the IBM WebSphere Help system; you might have additional eclipse\plugins folders on your system. Select OK if message panels ask to overwrite existing files.
To see the newly added document plug-ins, start the viewer by following the instructions in Starting the viewer (or shut it down by following the instructions in Shutting down the viewer, and then restart it if it was running).

The most recent version of the plug-ins will be displayed in the viewer.

Deleting older versions of document plug-ins

All document plug-ins except the base plug-in (com.ibm.wsps.doc) are versioned (for instance, com.ibm.wsps.ins.doc_6.0.1.1, com.ibm.wsps.ins.doc_6.0.1.2, etc.). You can delete older versions of the document plug-ins if you no longer need them. To delete an older version, do the following:

Go to the eclipse\plugins folder of the help system (by default, C:\ibm_help\eclipse\plugins).
Delete the plug-ins of the same base name but with the older version extension. For instance, if you have plug-ins called com.ibm.wsps.ins.doc_6.0.1.1 and com.ibm.wsps.ins.doc_6.0.1.2, you delete the plug-in com.ibm.wsps.ins.doc_6.0.1.1.
CAUTION:
Never remove the plug-in com.ibm.wsps.doc (with no version extension).