If you are using IBM® WebSphere® Application Server,
most likely you are installing the help content on the same server
as the product. You can deploy the help system on the existing installation
of WebSphere Application Server.
Before you begin
Verify that these requirements are met:
- The server that you configure the help content on
must be available to your users behind the firewall.
- A help.war file is on your
server.
- If the product that you are configuring the help for is installed
on the server, a help.war file might be installed
already.
- Look in the installation_directory/help directory
for the help.war file.
- Look for a version of the file that includes the product abbreviation,
such as clmhelp.war or ramhelp.war
- Search your installation directory for *help.war.
- If the product is not installed on the server or the product did
not include a help.war file, download a version
of the help.war file.
- Install a Java™ Runtime
Environment (JRE) or Java Development
Kit (JDK). You can install one of the IBM developer kits.
- WebSphere Application Server is
installed and configured. For more information about installing and
configuring WebSphere Application Server for
your environment, see your product documentation or the documentation
for WebSphere Application Server.
- An environment variable with the path to the JRE or JDK must be
set:
- If you installed a JRE, verify that the JRE_HOME environment
variable value is set to the path of the directory where you installed
the JRE. For example:
- Windows: C:\Program
Files\Java70\jre
- linux: /usr/local/java70/jre
- If you installed the JDK, verify that the JAVA_HOME environment
variable value is set to the path of the directory where you installed
the JDK. For example:
- Windows: C:\Program
Files\Java70
- linux: /usr/local/java70/
- WebSphere Application Server is
started.
Procedure
To deploy the help.war file:
- Open the WebSphere Application Server administrative
console.
- Click .
- Select Local file system.
- Click Browse and select the help.war file
that you chose to use.
- Click Next to accept all of the
default options until you reach the "Map context roots
for web modules" page.
- In the "Map context roots for web modules" page,
set the Context Root to /help,
click Next, and then click Finish.
- Verify that the application was installed correctly and
then click Save directly to the master configuration.
- Click .
- Select the check box next to the help.war application
and then click Start.
Note: The
help system starts and stops when you manually start or stop the application.
- Verify that you can access the help system by adding context_root/index.jsp to
the end of your server application URL. For example: http://server:port/help/index.jsp.
Note: The help system might not contain help
content yet. Next, install the documentation into the help system.
What to do next
- Install the help content
on the server by completing one of the following tasks:
- If other users are accessing this help
content from the products that were installed on their computers with IBM Installation Manager,
provide them with the server, the port, and the path to the help system.
Ensure that the server you provide is not localhost.
Example:
http://server.ibm.com:63650/help-name/index.jsp- Server: server.ibm.com
- Port: 63650
- Path: /help-name