Setting Up Enterprise Help IBM Corporation

Size: px

Start display at page:

Download "Setting Up Enterprise Help IBM Corporation"

Teresa Preston
6 years ago
Views:

1 Setting Up Enterprise Help

2 Setting up a Tomcat Application Server and the Enterprise Help System on your local network Prerequisites Download and extract the following software components. Apache Tomcat 6.0 This setup documentation is based on using a 32-bit version of Tomcat on a 64-bit version of Windows. Tomcat is available on many different platforms and there are 32- bit and 64-bit versions. A compatible JRE (1.5 or 1.6) [we use 1.6 in this example] The Enterprise Help system (help.war file) A help content update site Make sure you have access to a browser (Internet Explorer or FireFox on the server) for the Help System configuration.

3 Where to get the files Apache Tomcat For Windows 6/v6.0.32/bin/apache-tomcat zip Oracle Java JRE Enterprise Help System (approximately 35 MB) Rational (Content) Update Site packages (these vary in size) tes/ The file name for an Update Site package uses the following format: prod_coden.n_updatesite.zip, where prod_code is the product code and n.n is the version number.

4 Enterrprise Help setup checklist Complete the following tasks to set up Enterprise help using the supporting information provided in this presentation. Create a startup macro (start_tomcat.bat) Create a shutdown macro (stop_tomcat.bat) Copy the help system (help.war) into the webapps folder Start Tomcat Install a content update Verify that the content can be used

5 Supporting information Setting up Tomcat Install as Windows service: Install on a Linux system: Deploying a WAR Managing the Tomcat Application Server Installing the Help System on Tomcat doc/topics/t_setup_intrnet_help_content.htm Installing an update site into your help system

6 Troubleshooting Log locations [Apache Tomcat location]\logs\ [Apache Tomcat location]\work\catalina\localhost\help\eclipse\workspace\.metadata\ Common Issues JRE incompatibility Tomcat uses environment variables and paths to find your JRE. If you have multiple JREs installed on your system, the JRE_HOME or JAVA_HOME environment variables must be set correctly. Memory issues Tomcat comes in 32-bit and 64-bit versions. See table below Manipulating memory is done the same way it is done for any JRE: Startup.bat xmx500m xms500m Tomcat 32 bit OS 32 bit Max Memory 2 GB 32 bit 64 bit 3.7 GB 64 bit 64 bit Very high theoretically, 4 PB

7 Troubleshooting Most help configuration errors result from incorrectly specified server port and path information: You can use the server name and IP address interchangeably. The port is displayed in the Tomcat console; 8080 is the default port. Specify the path to the help system, also called the context root, as: /help. Do not add a forward slash (/) after the directory name. If you specify /help/, the path is invalid. The Apache Tomcat FAQ: The Apache Tomcat Troubleshooting page:

8 Security The Help system is Read Only and packaged in plugin.jar files. By default, only someone with access to the computer can update the help system. You can open the help system from a browser on another machine, but you cannot administer the help system from this access point.

9 Thank You

Oracle Endeca Information Discovery Integrator

Oracle Endeca Information Discovery Integrator Integrator Version 3.0.0 Rev. A May 2013 Copyright and disclaimer Copyright 2003, 2013, Oracle and/or its affiliates. All rights reserved. Oracle and Java