In this section: |
This section explains how to manually configure Apache Tomcat for use with WebFOCUS and ReportCaster. The WebFOCUS installation provided the option to install and configure Apache Tomcat for you. If you chose this option and the verification tool ran successfully, you do not need to manually configure Tomcat. However, if you are new to Tomcat or receive errors, you should review this section to understand the configuration process.
There are two configurations available when using Apache Tomcat:
Microsoft IIS can be used as the web server and Tomcat can be used as the application server. This requires configuring two servers and their communications. Processing is then split between Tomcat and IIS.
Note: To use IIS to only forward requests to Tomcat through a firewall, configure a Tomcat standalone configuration, as explained in this section and then manually configure the Tomcat Connector, as explained in Configuring IIS to Use the Tomcat Connector (Plug-In).
Depending on your Apache Tomcat application server default settings, you may need to adjust the Java VM memory options if you run into performance issues. If the WebFOCUS installation configured Apache Tomcat for you, this is done automatically.
Open the Tomcat Configuration Utility and select the Java tab, as shown in the following image.
In the Java Options section, ensure that the following line is added:
-XX:MaxPermSize=256M
Ensure that the Initial memory pool size is at least 256MB and that the Maximum memory pool size is at least 512MB.
How to: Reference: |
It is assumed that Tomcat is installed at this time. If Tomcat is not installed, you can install it from the WebFOCUS Client installation CD or by downloading the installation utility from:
If you chose to have WebFOCUS configure Tomcat for you, the following steps were performed:
The following steps can be performed to further configure Tomcat:
For your convenience, we provide a shortcut to the Apache Tomcat Properties window.
The JDBC driver location must be in the Tomcat CLASSPATH. Tomcat runs as a Windows service, so CLASSPATH is set in the registry. If you chose to configure Tomcat when you installed WebFOCUS, the install should have set this for you.
To manually set Java Classpath or troubleshoot, check your CLASSPATH field and be sure to include the JDBC driver.
Note: If the driver does not appear, add a semicolon to the end of the Java Classpath field. Then add the absolute path to the JDBC driver for your repository. If more than one file is needed, separate each path with a semicolon. Spaces can occur in directory names, but not between the paths and the semicolons. Be sure to include the file name and not just the directory containing the file. For example:
C:\ibi\tomcat\bin\bootstrap.jar;C:\drivers\sqljdbc.jar
For information on JDBC drivers, see Additional WebFOCUS Repository Topics and Tasks.
By default, Tomcat uses the three TCP ports listed below.
Default Port |
Name |
Use |
---|---|---|
8080 |
HTTP Listener Port |
You access Tomcat in a web browser using this port. For example: http://hostname:8080 |
8009 |
Connector Port |
Web servers route requests to Tomcat on this port. The Tomcat connector (plug-in) for IIS uses this port. If you change this port and use the connector, change the port in the workers.properties file of the connector. |
8005 |
Shutdown Port |
Tomcat uses this port for internal operations and for stopping. |
You normally do not need to change these ports. However, if these ports are not available or you want to change them, do the following:
C:\ibi\tomcat\conf\server.xml
If you change defaults, substitute accordingly in procedures and examples.
In this section:
How to: Reference: |
Configuring Tomcat mainly requires telling Tomcat where WebFOCUS files are located and the context roots in which to use them. For example, you must tell Tomcat to serve files from the WebFOCUS web application:
drive:\ibi\WebFOCUS80\webapps\webfocus
when it receives a request for the WebFOCUS context root:
http://hostname:8080/ibi_apps/
By creating this context, you deploy the WebFOCUS web application.
Tomcat can also serve files outside of a web application after it knows their location and context. Therefore, Tomcat can be used as both a web server and application server. On a traditional web server, you create aliases. With Tomcat, an alias is treated like a context root, even when serving files outside of a web application.
Context (path) | Directory (DocumentBase) |
---|---|
/ibi_apps | drive:\ibi\WebFOCUS80\webapps\webfocus.war |
/ibi_help | drive:\ibi\WebFOCUS80\webapps\ibi_help.war |
/approot | drive:\ibi\WebFOCUS80\webapps\approot.war |
Context (path) | Directory (DocumentBase) |
---|---|
/ibi_apps | drive:\ibi\WebFOCUS80\webapps\webfocus.war |
/ibi_help | drive:\ibi\WebFOCUS80\webapps\ibi_help.war |
The approot contexts is then created as an alias (Virtual Directories) on IIS. IIS is then configure to send requests for ibi_apps to Tomcat.
C:\ibi\tomcat\conf\Catalina\localhost
Note: If you have an existing version of Tomcat, not installed by a 8.x version of WebFOCUS, the directory will be under:
C:\Program Files\Apache Software Foundation\Tomcat X.X\conf\Catalina\localhost
This directory can contain XML files that define contexts. If the WebFOCUS installation installed and configured Tomcat for you, the following file should appear to define the ibi_apps context that deploys the WebFOCUS directory:
ibi_apps.xml
ibi_help.xml
If you are using Tomcat standalone, the following should appear as well:
approot.xml
The XML files are named for the context root you would use to access the web application and should have the following syntax:
<?xml version='1.0' encoding='utf-8'?> <Context docBase="path_To_WebApplication" path="/contextRoot"> </Context>
where:
Is the absolute path to the WAR file or directory you are deploying.
Is the context root.
Note: They can optionally contain additional information, as explained in the Tomcat documentation.
You can create or edit the files in a text editor, such as Notepad.
<?xml version='1.0' encoding='utf-8'?> <Context docBase="C:\ibi\WebFOCUS80\webapps\webfocus" path="/ibi_apps" useHttpOnly="true"> </Context>
Be sure to specify the correct directory on your machine and change the context root if you are not using the default (ibi_apps).
<?xml version='1.0' encoding='utf-8'?> <Context docBase="C:\ibi\apps" path="/approot"> </Context>
Be sure to specify the correct directory on your machine.
This is not a consideration if you just installed WebFOCUS for the first time, but you should be aware of it for when you install a service pack or new release. When you upgrade WebFOCUS or install a service pack, Tomcat must use the new web applications rather than cached copies of the old version.
\tomcat_home\work\Catalina\localhost\ibi_apps
\tomcat_home\work\Catalina\localhost\ibi_help
\tomcat_home\work\Catalina\localhost\approot (if previously deployed)
C:\ibi\tomcat\conf\Catalina\localhost\ibi_apps.xml
C:\ibi\tomcat\work\Catalina\localhost\ibi_apps
C:\ibi\tomcat\work\Catalina\localhost\ibi_help
C:\ibi\tomcat\webapps\ibi_apps
Note: When you deploy WAR files, Tomcat expands them into its own directory structure and does not always know the original location.
For your convenience, you can access the Apache Tomcat Properties window by selecting Programs, Information Builders, Tomcat, and then Tomcat Configuration Utility. The following image shows the Apache Tomcat 7.0.33 for WebFOCUS Properties window.
To change Java memory settings, click the Java tab, as shown in the following image.
This is where you can modify the Java memory settings after installation according to your requirements.
The Tomcat Manager application is packaged with Apache Tomcat. It provides basic functionality to manage web applications that are deployed to Apache Tomcat. It can be used to troubleshoot issues with the deployment or to manually deploy .war files if required. As of WebFOCUS 8, the Tomcat Manager application is not deployed automatically.
How to: |
After finishing the configuration, run test calls to verify operability.
http://hostname:port/ibi_apps
where:
Are the host name and port of the web server. However, if you use an application server only configuration, then these are the host name and HTTP port of the application server. For Tomcat standalone configurations, the default port is 8080. If you require SSL, use https instead of http.
The WebFOCUS Sign In page opens, as shown in the following image.
The WebFOCUS Business Intelligence Portal Welcome page opens in your web browser.
The WebFOCUS Administration Console opens.
The following page opens, which lists your WebFOCUS Reporting Server instance if it is available.
When Test Existing Procedure is selected and the WebFOCUS Reporting Server is not running or is running with Security enabled (ON), you are prompted for WebFOCUS Reporting Server credentials.
When credentials are entered and the WebFOCUS Reporting Server is not running, an error message is displayed.
If the WebFOCUS Reporting Server is running with Security disabled (OFF), then the Run a Stored Procedure page opens, as shown in the following image.
A procedure is normally launched using the WebFOCUS Servlet and a sample report should display. You can manually use a servlet to run a procedure, such as carinst.fex, using:
http://host:[port]/ibi_apps/WFServlet?IBIF_ex=carinst
WebFOCUS |