Configuring IBM WebSphere

In this section:

This section explains how to set up IBM WebSphere Application Server for use with WebFOCUS and ReportCaster. It is assumed that WebSphere components are installed and configured. For additional information, see the WebSphere documentation. In WebFOCUS 8, you can easily use WebSphere Application Server without the external IBM HTTP Server by deploying the approot.war file.


Top of page

x
Java Version Requirement

How to:

As of WebFOCUS 8, Java Version 6 is the minimum version required on the system that is hosting the application server where the WebFOCUS Reporting Server and ReportCaster Distribution Server are deployed.

Important: For IBM WebSphere Application Server Version 7.0, apply the IBM WebSphere Application Server feature pack for OSGI applications and Java persistence API 2.0.



x
Procedure: How to Apply the IBM APAR

To apply the IBM APAR:

  1. In the administrative console, expand the Servers node and select Application Servers.
  2. Click the server to which the custom property is to be applied.
  3. Under Configuration and Container settings, expand the Web Container Settings node and select Web Container.
  4. Under Configuration and Additional Properties, click Custom Properties.

    The Custom Properties page opens.

  5. Click New.
  6. Enter the following in the Name field exactly as shown.
    com.ibm.ws.jsp.jdkSourceLevel
  7. Enter the following in the Value field exactly as shown:
    16
  8. Click Apply or OK.

    The Messages dialog box opens.

  9. Click Save.

Top of page

x
Java Memory Requirement

Depending on your IBM WebSphere Application Server default settings, you may need to adjust the Java VM memory options if you run into performance issues.

The most common Java VM options you need to set involve the size of the Java heap and stack, which determine memory availability for Java programs and the Java VM. Errors can occur if not enough memory is available, and the heap size impacts performance, since it determines how often garbage collection occurs.

The following are the most common Java VM options related to memory settings. Replace the #### with the size you wish to set:

-Xmx####M

Sets the maximum Java heap size. It is common to make this 1/4 of the system RAM, but it should be at least 1536 MB (1.5 GB).

-Xms####M

Sets the initial Java heap size. It is common to make this 1/8 of the system RAM, but it should be at least 1536 MB (1.5 GB).

-Xss####M

Sets the Java thread stack size. You do not need to set this unless you are fine tuning your environment.

The size is normally set in Megabytes. For example:

-Xms1536M
-Xmx2048M

To view your current Java VM memory settings, access the WebFOCUS Administration Console. In the left pane of the console, expand the Diagnostics node and click JVM Property Info, as shown in the following image.

The Java VM memory settings for your environment are displayed in the right pane, as shown in the following image.

Optimum sizes vary depending on your total memory, the needs of your application, how many other processes require memory, the type of Java VM, and other considerations. A good starting place is to set the minimum to 1/8 of the total RAM and set the maximum to 1/4 of total RAM.

Where to set these and other Java VM options, depend on your application server.


Top of page

x
Updating jackson-all-1.9.11.jar

How to:

If you are using WebSphere Application Server Version 8.0 or 8.5, you must upgrade the version of jackson-all-1.9.11.jar that is included with WebSphere, then redeploy the WebFOCUS web application.



x
Procedure: How to Update jackson-all-1.9.11.jar

WebFOCUS 8 is packaged with a newer version of the jackson-all-1.9.11.jar file, which includes updated classes. To avoid conflicts with the current version of the jackson-all-1.9.11.jar that is included and used by WebSphere Application Server Version 8.0 and 8.5, perform the following steps. These steps describe how to define a container-wide shared library that can be used by deployed WebFOCUS applications.

  1. Locate the httpclient*.jar, httpcore*.jar, and jackson-all-1.9.11.jar files that are packaged with WebFOCUS 8. By default, these files are located in the following directory:
    ibi\WebFOCUS81\webapps\webfocus\WEB-INF\lib
  2. Create an empty directory on your system and copy the httpclient*.jar, httpcore*.jar, and jackson-all-1.9.11.jar files to this new directory. For example:
    \appsrv1\IBM\shared
  3. Sign in to the WebSphere Integrated Solutions Console.
  4. In the left pane, expand Environment and select Shared libraries, as shown in the following image.

    Environment menu - Select shared libraries

    The Shared Libraries pane opens, as shown in the following image.

    Shared Libraries pane

  5. Select a scope from the drop-down list, which specifies the level at which the resource definition is visible, and click New.

    The Shared Libraries > New pane opens, as shown in the following image.

    Shared Libraries > New pane

  6. In the Name field, enter a name for the new shared library that is being created (for example, IBI Jackson 1.9).
  7. Provide a description (optional).
  8. In the Classpath field, enter the path to the folder on your system where you copied the updated jackson-all-1.9.11.jar file (packaged with WebFOCUS 8).
  9. In the Class Loading area, select the Use an isolated class loader for this shared library check box.
  10. Click OK, then click Apply.


x
Procedure: How to Update the webfocus.war file for the WebFOCUS Web Application

This procedure describes how to define a container-wide shared library that can be used by deployed WebFOCUS applications.

Note: Only the webfocus.war file for the WebFOCUS web application requires this change. The ibi_help.war, approot.war, and ibi_html.war files do not require the changes described in this procedure.

  1. In the WebSphere Integrated Solutions Console, expand Applications, and select WebSphere enterprise applications.

    The Enterprise Applications pane opens, as shown in the following image.

    Enterprise Applications pane

  2. Click the name of the webfocus.war file for the WebFOCUS web application (for example, 15215webfocus_war).
  3. In the References area, click Shared library references, as shown in the following image.

    Enterprise Applications - References area

    The Shared library references pane opens, as shown in the following image.

    Note: The WebFOCUS Application being used in this example is called 15215webfocus_war and the Module is called WebFOCUS 8.1.

  4. Select the check box to the left of the WebFOCUS Application and click Reference shared libraries.

    The Shared Library Mapping pane opens, as shown in the following image.

    Shared Library mapping pane

  5. In the Available area, select the IBI Jackson 1.9 shared library, and then click the right arrow icon.

    The IBI Jackson 1.9 shared library is now listed in the Selected area.

  6. Click OK.
  7. Repeat steps 4 to 5 for the Module (for example, WebFOCUS 8.1) that is listed in the Shared library references pane.

    Ensure that the IBI Jackson 1.9 shared library for the Module is moved to the Selected area.

  8. Click OK.

    You are returned to the Shared library references pane, as shown in the following image.

    Shared library references pane

    Notice that the new shared library (IBI Jackson 1.9) is now listed in the Shared Libraries column for the Application and Module.

  9. Click OK.
  10. Restart your IBM WebSphere Application Server if it is already running.

    Note: Restarting only the WebFOCUS application will not be sufficient.


Top of page

x
Preparing WebSphere for ReportCaster

How to:

To prepare WebSphere for ReportCaster, you should set the CLASSPATH variable to include your JDBC driver.

Note: If you are using InfoAssist, you may need to increase the default Java memory options, as explained in Java Memory Issues. This can be done at a later time if needed, but it is done from the same area of the WebSphere Administrative Console as setting CLASSPATH.



x
Procedure: How to Set CLASSPATH for WebSphere

If you are not using ReportCaster, proceed to Deploying Web Applications.

  1. Start WebSphere, if it is not already running.
  2. Sign in to the WebSphere Administrative Console through a browser.
  3. On the left, expand Servers.
  4. On the left, click Application Servers.
  5. Click the server where you will deploy ReportCaster.
  6. Under Server Infrastructure, click Java and Process Management.
  7. Click Process Definition.
  8. Under Additional Properties, click Java Virtual Machine.
  9. In the Classpath field, provide the path to your JDBC driver.

    You must include the file in the path. Providing a directory is not sufficient. If multiple files are needed for the JDBC driver, provide the path to each file separating paths by semicolons. Spaces can occur in directory names, but not between the paths and the semicolons. For example:

    drive:\Program Files\Microsoft SQL Server 2008 Driver for JDBC\
    lib\sqljdbc4.jar

    For more information about JDBC drivers, see JDBC Overview.

  10. Click OK.
  11. On the top of the page, click Save.
  12. On the page that appears, click Save to save the master configuration.
  13. Restart the application server.

Top of page

x
Deploying Web Applications

How to:

Use the WebSphere Administrative Console, to deploy (install) the WebFOCUS and ReportCaster web applications. The number of web applications you deploy depends on your configuration. Repeat this procedure for each web application you need to deploy.

The web applications are located in the following directory:

drive:\ibi\WebFOCUS81\webapps

For WebSphere, you deploy the WAR files.

You can use the default WebSphere instance or create a new instance using the WebSphere Administrative Console. If you want to create new instances or virtual hosts, see the IBM documentation.

Note:



x
Procedure: How to Deploy (Install) a Web Application With WebSphere 7.0
  1. If it is not started, start WebSphere Application Server. If you set CLASSPATH, ensure the server was restarted.
  2. If it is not open, access the WebSphere Administrative Console through a browser. For example:
    http://hostname:9060/ibm/console
  3. On the left, expand Applications.

    Caution: If previous instances of the WebFOCUS or ReportCaster applications have been installed, you must stop and uninstall them before installing the new applications. To determine if previous instances have been installed, click Enterprise Applications on the left. If applications appear, check their boxes and click Stop. After they are stopped, click Uninstall.

  4. On the left, click [Install] New Application.
  5. On the right, select New Enterprise Application.
  6. Select the Remote file system radio button. In the full path field, type in the name of your application with its full path. Click Next. For example:
    drive:\ibi\WebFOCUS81\webapps\webfocus.war

    Note: In WebFOCUS 8, there is one web application in the WebFOCUS81\webapps directory, which contains the WebFOCUS Client and ReportCaster (ibi_apps).

    drive:\ibi\WebFOCUS81\webapps\ibi_help.war and
    drive:\ibi\WebFOCUS81\webapps\approot.war
  7. Select Detailed and then click Next.
  8. Click Continue.
  9. On the Select Installation Options screen, change the application name to something unique in the Application name field. For example, prefix the application name with the name of the cluster or app server. Click Next.
  10. On the Map Modules to Servers screen, select the application listed on the bottom (for example, WebFOCUS). Then, while holding the Ctrl key, select the cluster or application server to which you will deploy and any web servers you will be using. Click Apply and then click Next.
  11. For steps 3 to 6, accept the default values and click Next. For step 7, Map virtual hosts for Web Modules, select the application and the virtual host you defined earlier and click Next.
  12. Set the context root for the web application. For this example, set it to /ibi_apps. Click Next.
  13. Review the summary screen and then click Finish to deploy.

    When the application deployment is complete, click Save directly to the master configuration.


Top of page

x
Verifying the WebFOCUS Configuration With IBM WebSphere

How to:

After configuring WebSphere components, verify operability.



x
Procedure: How to Verify the WebFOCUS Configuration
  1. If they are not started, start the following:
    • WebFOCUS Reporting Server
    • IBM HTTP and WebSphere Application Servers
  2. Open the following page to confirm the WebFOCUS web application is properly deployed to WebSphere Application Server:
    http://hostname:port/ibi_apps/diagnostics/about.jsp

    where:

    hostname:port

    Is the host name of the Websphere Application Server and its associated HTTP port. For the default_host, the default HTTP port is 9060. For other hosts, look in the WebSphere Administrative console under Environment, Virtual Hosts, host_name, and Host Aliases.

    A page should appear displaying information about the current build.

    If you receive an error, try restarting WebSphere.

  3. Type the following case-sensitive URL to access the WebFOCUS Welcome page that provides links to all WebFOCUS features:
    http://hostname:port/ibi_apps

    You may wish to bookmark this page for future use. This page is also referred to as the WebFOCUS home page.

Be aware that you may need to increase your Java memory settings if you use InfoAssist. You can do this later, as explained in Java Memory Issues.


WebFOCUS