The documentation is packaged as Eclipse document plug-ins
and must be viewed using the help system. 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® ESB for z/OS® 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).
You can install and run a server copy of the WebSphere ESB for z/OS information
center on z/OS. Alternatively, you can install and view
the information center on Linux® or Windows®.
Before you begin
A version of the help system is included on the Messaging Clients CD , which is included
with the WebSphere ESB for z/OS product.
For instructions on how to install the help system on Linux or Windows, see Installing the documentation in the distributed
platforms WebSphere ESB information
center.
Be aware of the following requirements and considerations
if you want to install and run a server copy of the
WebSphere ESB for z/OS information
center:
- Support for the information center on z/OS is
only offered in server mode for remote access using a browser.
- The information center uses a JRE. If you want to run an information
center on z/OS, you need to use the JRE provided with
the operating system.
- Make sure that your systems administrator has given your user
ID permission to work with files on the z/OS system.
- The first time you perform a search in the information center,
there is a delay where the pregenerated search indexes are extracted
and any additional files are indexed. In a server environment,
the indexing takes place once for every browser locale that performs
a search in the information center. For example, if a user has a browser
locale of en_gb and another user has a locale of en_us, both users
will create a search index.
- You can choose to download PDF versions of the documentation from
the WebSphere ESB for z/OS library
page as another option for working with the information offline.
Note: If you already have an IBM WebSphere ESB for z/OS help system,
you can opt to install only the WebSphere ESB for z/OS document plug-in
and view the documentation within that tool.
About this task
Installing the document plug-ins
Procedure
- Perform the following steps to install the help system:
- Change to the following directory: cd installation_file_system_root/zos.iehs/lib.
- Locate the file IBM-Help-zOS.tar.
- Create the directory into which you will extract IBM-Help-zOS.tar.
- Extract the file into a directory of your choosing by
using the command: tar -xvf IBM-Help-zOS.tar -C directory_name
- Download and install the document plug-ins using the help
system update functionality from the update server: http://publib.boulder.ibm.com/dmndhelp/downloads. For more detailed instructions on how to configure your help
system for updates and plug-in installation, see Installing the documentation in Eclipse-based viewers.
- Change the permissions on the IC_start.sh and IC_end.sh
scripts so that you have permission to edit and execute the files
that start and stop the information center.
- Edit the startup file IC_start.sh, that is provided in
the ibm_help directory, to point to the location of Java™. For example, you could add
the following statements to the file: export PATH=/usr/lpp/java142/J1.4/bin:$PATH,
where /java142/J1.4/bin:$PATH is the location of Java. Eclipse requires Java℁ 1.4.2 to run. This
version is provided with the information center on all platforms except z/OS.
- Optional: Change the -port parameter, if you do not want
to use the default value. The port number is specified in the file
IC_start.sh and the default value is 8888.
- Start the information center server:
- Run the file IC_start.sh. You can run the
information center as a background task. This means that even if you
log off the workstation or server, the information center will continue
to run. Use the following command: ./IC_start.sh &.
- To verify that the information center has started on
a remote computer, open a browser and enter a URL using the name of
the server and the port number that is specified in the file IC_start.sh. For example, you could specify: http://winmvs26.site.company.com:8888.
- To stop the information center (for example, to add or
remove documentation plug-ins):
- Run the file IC_end.sh.