WebFOCUS Client and ReportCaster Installation

In this section:

A single installation program is provided to install the WebFOCUS Client and ReportCaster.
Top of page
x
Removal of the ibi_html WebFOCUS Alias

How to:

As of WebFOCUS Release 8.0 Version 01, the ibi_html alias has been removed from WebFOCUS packaging. If you are upgrading, this section describes how to configure your web and application server settings (for example, Apache Tomcat) if ibi_html references exist in your earlier applications as custom aliases.
x
Procedure: How to Configure Apache Tomcat to Use the ibi_html Soft Alias
  1. Stop Apache Tomcat.
  2. Make a copy of the approot.xml file, which is located in the following directory 
    <tomcat_home>conf/Catalina/localhost

    where:

    <tomcat_home>

    Is the root location where Apache Tomcat is installed.

  3. Rename the copy of approot.xml to ibi_html.xml or according to your custom alias (for example, ibi_html8.xml).
  4. Edit the ibi_html.xml file and change the value specified by the <Context docBase> element to the full path to the ibi_html.war file. In addition, change the path value from /approot to /ibi_html.

    For example:

    <?xml version='1.0' encoding='utf-8'?>
<Context docBase="../ibi/WebFOCUS80/webapps/ibi_html.war" path="/ibi_html">
</Context>

    Note: Do not replace /ibi_html with your custom alias (for example, ibi_html8).

  5. Start Apache Tomcat.

    You can now use your ibi_html alias.
Top of page
x
Pre-Installation Requirements

Review the following requirements before installing the WebFOCUS Client and ReportCaster.

  1. Review WebFOCUS and ReportCaster Installation Requirements, and fill out the installation worksheet. If you are not sure of any parameters, contact your system administrator before beginning the installation.
  2. Ensure that the WebFOCUS Reporting Server has been installed, configured, and is running. For more information, see Installing the WebFOCUS Reporting Server.
Top of page
x
Running the Installation Utility

How to:

This section describes how to install the WebFOCUS Client on IBM i using the console installation mode. For demonstration purposes, the first procedure describes the steps for a typical install. In this typical install, a DB2 database is used for the WebFOCUS repository. The web and application server being used is Apache Tomcat Version 7.0.19, which is packaged with the installation. The second procedure describes the steps for a custom install.

Note: When entering values, use full values and names. Do not use shorthand, aliases or environment variables.

Tip: At anytime during the install, you may type QUIT to exit, or BACK to return to the previous section.
x
Procedure: How to Install a Typical Version of the WebFOCUS Client

In a typical install, the following default values are used and you are not prompted to enter new values:

If you are required to use different values, you must run a custom WebFOCUS installation.

  1. Download the WebFOCUS 8.0 installation file for IBM i.
  2. FTP the installWebFOCUS8001.jar file to a working folder on the IBM i machine.
  3. Login to the machine from which the installation will be invoked.
  4. Enter the shell command environment: 
    qsh
  5. Navigate to the location of the installation file.
  6. From qsh, change the permissions of the installation file (installWebFOCUS8001.jar) to read and execute using the following chmod command: 
    chmod 755 installWebFOCUS8001.jar
  7. Set JAVA_HOME to a 1.6 level or higher version. For example: 
    export JAVA_HOME=/QOpenSys/QIBM/ProdData/JavaVM/jdk626/32bit

    Note: In many cases, this may be set in your system or user profile. You may verify the Java version by entering java -version at the qsh prompt.

  8. Execute the installation file: 
    java -jar installWebFOCUS8001.jar -i console

    Tip: If you would like to record the installation values for future playback, add the following to the end of the above command: 

    -r /home/username/propertyfilename.properties

    To later run the install using this silent properties file, use: 

    java -jar installWebFOCUS8001.jar -i silent -f /path/propertyfilename.properties

    The Welcome to WebFOCUS 80 message displays.

  9. Press Enter to continue.

    The WebFOCUS License Agreement displays over several screens. Press Enter after reading each page of the license agreement. Press PageUp and PageDown to review the contents of each page.

  10. Press Y at the License Acceptance prompt and then press Enter.

    The Choose Install Type prompt displays.

  11. Press 2 for a full install, then press Enter.

    The License Code prompt displays.

  12. Enter your WebFOCUS license code and site code and press Enter.

    The Choose Install Set prompt displays.

  13. Type 1 for a typical install and press Enter.

    The Choose Destination Locations prompt displays.

  14. Specify the path to a destination folder.

    If you accept the default value, press Enter. Otherwise, enter a specific path according to your requirements.

    Note: The path must include the string /ibi/WebFOCUS80. Spaces are not allowed in any destination folder. If this string is not found in the path entered, the installation program will append it to the end of the entered value. You may enter trailing values after the /ibi/WebFOCUS80 string (for example, /ibi/WebFOCUS80test).

    When prompted for a directory or device, type the full path name. Do not use environment variables such as $HOME, or shorthand such as pwd.

    The Select Components to install prompt displays.

  15. Type Y to install WebFOCUS and press Enter.

    The WebFOCUS applications destination folder prompt displays.

  16. Type a destination folder for WebFOCUS applications and press Enter.

    A series of prompts for additional components are displayed.

  17. Type the mail server host name and press Enter.
  18. Type Y to install ReportCaster Distribution Server and press Enter.
  19. Type Y to install and configure Apache Tomcat and press Enter.

    Tip: Java 1.6 or higher is required to install Apache Tomcat. If the Java version detected is less than 1.6, the installation program will not prompt to install Apache Tomcat.

  20. Enter the Apache Tomcat installation folder without spaces and press Enter.
  21. Type N at the Install Derby prompt, and press Enter.

  22. Type 2 to select DB2 as the WebFOCUS repository type and press Enter.

    Note: This database library should have been created or confirmed, as described in WebFOCUS and ReportCaster Installation Requirements.

  23. Type Y to create the WebFOCUS repository and press Enter.

    The Database Configuration for DB2 prompt displays.

  24. Type N for ZOS Platform and press Enter.
  25. Type the DB2 library and press Enter.
  26. Type the machine name on which the DB2 library resides and press Enter.

    If your DB2 library is on the local machine, you may enter localhost.

    Note: The WebFOCUS repository can exist on a remote machine.

  27. Accept the default port value and press Enter.

    Note: DB2 connectivity on IBM i does not require a port number.

  28. For User Id, type the owner of the database library chosen in step 25, and press Enter.
  29. Type the password for the database owner and press Enter.

    Note: This value will not be displayed on the screen.

  30. Type com.ibm.as400.access.AS400JDBCDriver for the JDBC driver.

    Note: For this typical install, the IBM® Toolbox for Java JDBC driver is being used.

  31. Type the following path to the JDBC driver file: 
    /QIBM/ProdData/HTTP/Public/jt400/lib/jt400.jar

    Note: Your file may be found in a different folder. Your system administrator can confirm its location.

  32. When finished, press Enter again. The file name entered must exist.

    A pre-installation summary is displayed. You can type BACK to reenter values or type QUIT to exit the installation.

    While the installation files are being copied and configured, a progress indicator is displayed and updated on the screen.

    ==========================================================Installing...
------------- [==================|==================|==================|===========
[------------------|------------------|-----------

    After all of the files have been copied and configured, the installation program will attempt to start the services that were installed. This may include the Apache Tomcat application server and the WebFOCUS Distribution Server. The installation program will attempt to start each service for two minutes and status messages are displayed as attempts are being made.

    In the following example, the HTTP port for Apache Tomcat (8080) was successfully started.

    If any of the ports were not started, see Troubleshooting WebFOCUS and ReportCaster. One reason a service may not start is that the system may be experiencing some delays.

  33. After the installation program is finished, press Enter to return to the shell ready prompt. 
    Installation Complete
----------------------------------------------------------------
Congratulations. WebFOCUS 80 has been successfully installed to:
/home/ibi/webfocus
PRESS <ENTER> TO EXIT THE INSTALLER:

    The WebFOCUS install log is named:

    WebFOCUS80_Install_mm_dd_yyyy_hh_mm_ss.log

    The InstallAnywhere log file is named:

    WebFOCUS80_yyyy_mm_yyThh_mm_ss_sss.log

    These log files are placed in the home folder of the user ID that ran the installation program. You may need to refer to these files if there are any install issues.
x
Procedure: How to Install a Custom Version of the WebFOCUS Client

This section describes how to install the WebFOCUS Client on IBM i using the custom prompts. During a custom installation, you can enter custom values for:

During this custom install, the WebFOCUS Client and Derby are installed. The WebFOCUS Distribution Server is installed on a different host machine. The application server will be an existing preconfigured IBM WebSphere instance.

Note: When entering values, use full values and names. Do not use shorthand, aliases or environment variables.

Tip: At anytime during the install, you may type QUIT to exit, or BACK to return to the previous section.

  1. Download the WebFOCUS 8.0 installation file for IBM i.
  2. FTP the installWebFOCUS8001.jar file to a working folder on the IBM i machine.
  3. Login to the machine from which the installation will be invoked.
  4. Enter the following shell command environment: 
    qsh
  5. Navigate to the location of the installation file.
  6. From qsh, change the permissions of the installation file (installWebFOCUS8001.jar) to read and execute using the following chmod command: 
    chmod 755 installWebFOCUS8001.jar
  7. Set JAVA_HOME to a 1.6 level or higher version. For example: 
    export JAVA_HOME=/QOpenSys/QIBM/ProdData/JavaVM/jdk626/32bit

    Note: In many cases, this may be set in your system or user profile. You may verify the Java version by entering java -version at the qsh prompt.

  8. Execute the installation file: 
    java -jar installWebFOCUS8001.jar -i console

    Tip: If you would like to record the installation values for future playback, add the following to the end of the above command: 

    -r /home/username/propertyfilename.properties

    To later run the install using this silent properties file, use: 

    java -jar installWebFOCUS8001.jar -i silent -f /path/propertyfilename.properties

    The Welcome to WebFOCUS 80 message displays.

  9. Press Enter to continue.

    The WebFOCUS License Agreement displays over several screens. Press Enter after reading each page of the license agreement. Press PageUp and PageDown to review the contents of each page.

  10. Press Y at the License Acceptance prompt and then press Enter.

    The Choose Install Type prompt displays.

  11. Press 2 for a full install, then press Enter.

    The License Code prompt displays.

  12. Enter your WebFOCUS license code and site code and press Enter.

    The Choose Install Set prompt displays.

  13. Type 2 for a custom install and press Enter.

    The Choose Destination Locations prompt displays.

  14. Specify the path to a destination folder.

    If you accept the default value, press Enter. Otherwise, enter a new path.

    Note: The path must include the string /ibi/WebFOCUS80. Spaces are not allowed in any destination folder. If this string is not found in the path entered, the installation program will append it to the end of the entered value. You may enter trailing values after the /ibi/WebFOCUS80 string (for example, /ibi/WebFOCUS80test).

    When prompted for a directory or device, type the full path name. Do not use environment variables such as $HOME, or shorthand such as pwd.

    The Select Components to install prompt displays.

  15. Type Y to install WebFOCUS and press Enter.

    The WebFOCUS applications destination folder prompt displays.

  16. Type a destination folder for WebFOCUS applications and press Enter.

    The default value will append /apps to the WebFOCUS destination entered in step 14.

    A series of prompts for additional components are displayed.

  17. Type the mail server host name and press Enter.
  18. Type N at the Install ReportCaster Distribution Server prompt and press Enter.

    Note: For demonstration purposes during this custom install, the Distribution Server will be installed on a remote host.

  19. Type N at the Install and Configure Tomcat prompt and press Enter.

    Note: For demonstration purposes during this custom install, an existing instance of IBM WebSphere Application Server will be used. For more information on configuring IBM WebSphere Application Server, see Configuring Web and Application Servers.

    Tip: Java 1.6 or higher is required to install Apache Tomcat. If the Java version detected is less than 1.6, the installation program will not prompt to install Apache Tomcat.

  20. Type the HTTP port number for the web server.
  21. Type Y to install Derby and press Enter.

  22. Enter the destination folder that will be used for Derby.

    The default value will append /Derby to your WebFOCUS destination entered in step 14.

  23. Enter the desired user ID for the Derby repository.

    The default value is webfocus.

    Note: You will need to enter this value during the remote host installation of the Distribution Server.

  24. Enter the desired password for the Derby repository.

    The default value is webfocus.

    Note: You will need to enter this value during the remote host installation of the Distribution Server.

  25. Type Y to create the WebFOCUS repository and press Enter.

    Note: The following set of Advanced Configuration prompts appear only during custom installations.

  26. Enter a value for WebFOCUS Application Context. The default is ibi_apps.
  27. Enter a value for WebFOCUS Help Context. The default is ibi_help.
  28. Enter the host on which your WebFOCUS Reporting Server resides.

    Note: This prompt appears only when you are installing WebFOCUS.

  29. Enter the WebFOCUS Reporting Server port.
  30. Enter the Distribution Server Host

    For this custom install, we have chosen to install on a remote machine.

  31. Enter the Distribution Server Port number.
  32. Enter the Derby Database Name.

    Note: You will need this value when installing the Distribution Server on the remote machine. This must match the database name entered during the remote installation.

  33. Enter the Derby database port number.

    Note: You will need this value when installing the Distribution Server on the remote machine. If the port number that you enter is active at install time, the installation program will prompt you to enter a different port number.

    A pre-installation summary is displayed over several panels.

    Use the PgUp and PgDn keys to review all of the values. If you want to change any values, type BACK. To exit the installation type QUIT. To proceed with the installation, press Enter.

    While the installation files are being copied and configured, a progress indicator is displayed and updated on the screen.

    ==========================================================Installing...
------------- [==================|==================|==================|===========
[------------------|------------------|-----------

    The installation program will attempt to start the Derby service for up to two minutes. Messages are displayed showing the status of the port.

  34. After the installation program is finished, press Enter to return to the shell ready prompt. 
    Installation Complete
----------------------------------------------------------------
Congratulations. WebFOCUS 80 has been successfully installed to:
/home/custom/ibi/WebFOCUS80
PRESS <ENTER> TO EXIT THE INSTALLER:

    The WebFOCUS install log is named:

    WebFOCUS80_Install_mm_dd_yyyy_hh_mm_ss.log

    The InstallAnywhere log file is named:

    WebFOCUS80_yyyy_mm_yyThh_mm_ss_sss.log

    These log files are placed in the home folder of the user ID that ran the installation program. You may need to refer to these files if there are any install issues.

  35. Using a text editor, edit the derby.properties file in the Derby installation folder: 
    /home/custom/ibi/Derby
  36. Uncomment the following line: 
    #derby.drda.host=0.0.0.0
  37. Save your changes to the derby.properties file.
  38. Stop and restart your Derby instance by performing the following steps:
    1. Navigate to the following directory in qsh: 
      /home/custom/ibi/Derby/bin
    2. Enter sh stop.sh to stop the Derby instance.

      Wait for a message indicating that the service was stopped. For example:

      $ Wed Sep 12 11:35:00 EDT 2012 : Apache Derby Network Server - 10.8.1.2 - (1095077) shutdown
    3. Enter sh start.sh to start the Derby instance.

      Wait for a message indicating that the service was started. For example:

       Wed Sep 12 11:56:52 EDT 2012 : Apache Derby Network Server - 10.8.1.2 - (1095077) started and ready to accept connections on port 6527
  39. Navigate to the /lib subfolder in the Derby installation location. For example: 
    cd  /home/custom/ibi/Derby/lib
  40. Copy or FTP the derbyclient.jar file to the machine on which the Distribution Server will be installed.

    This file contains necessary components to communicate with the Derby database. You will need to enter the location of this file during the installation of the Distribution Server on the remote machine.

    1. If your application server runs under a different user ID from the one that was used to install WebFOCUS, you must provide the application server authority to WebFOCUS resources. Run the following command: 
      CHGAUT OBJ('.../ibi/WebFOCUS80/config/resource_templates') USER(QEJBSVR)  DTAAUT(*RWX) OBJAUT(*ALL)  SUBTREE(*ALL)

      where:

      ...

      Is the full path to your WebFOCUS installation.

    2. Run this same command for the following WebFOCUS file folders:
      • .../ibi/apps
      • ../ibi/WebFOCUS80/ibi_html/javaassist
      • .../ibi/WebFOCUS80/client/wfc/etc
      • .../ibi/WebFOCUS80/logs
      • .../ibi/WebFOCUS80/temp
      • .../ibi/WebFOCUS80/worp

      Note: If your IBM WebSphere Application Server runs under a user ID other than QEJBSVR, replace the USER value with the appropriate user name.

  41. Copy the installation program to the remote machine that will run the Distribution Server.
  42. Execute the installation file: 
    java -jar installWebFOCUS8001.jar -i console

    The Welcome to WebFOCUS 80 message displays.

  43. Press Enter to continue.

    The WebFOCUS License Agreement displays over several screens. Press Enter after reading each page of the license agreement. Press PageUp and PageDown to review the contents of each page.

  44. Type Y at the License Acceptance prompt and then press Enter.

    The Choose Install Type prompt displays.

  45. Type 2 for a full install and then press Enter.

    The License Code prompt displays.

  46. Enter your WebFOCUS license code and site code and press Enter.

    The Choose Install Set prompt displays.

  47. Type 2 for a custom install and press Enter.

    The Choose Destination Locations prompt displays.

  48. Specify the path to a destination folder.

    If you accept the default value, press Enter. Otherwise, enter a valid absolute path name.

    Note: The path must include the string /ibi/WebFOCUS80. If this string is not found in the path entered, the installation program will append it to the end of the entered value. You may enter trailing values after the /ibi/WebFOCUS80 string (for example, /ibi/WebFOCUS80test).

    When prompted for a directory or device, type the full path name. Do not use environment variables such as $HOME, or shorthand such as pwd.

    The Select Components to install prompt displays.

  49. Type N at the Install WebFOCUS prompt and press Enter.
  50. Type Y at the Install ReportCaster Distribution Server prompt, as shown in the following image.

    The database selection prompt displays, as shown in the following image.

  51. Type 1 to select Apache Derby.

    The Database Configuration pane for Apache Derby displays, as shown in the following image.

  52. Enter the name of the Apache Derby database.

    Note: This must match the value entered during the WebFOCUS component installation.

    The DB Server Node prompt displays, as shown in the following image.

  53. Enter the host name of the machine where the WebFOCUS and Derby components were installed.
  54. Enter the host port of the Derby database chosen during the WebFOCUS component installation.
    1. Enter the database owner user ID.
    2. Enter the database owner password.
  55. Enter the following JDBC driver for the Derby database: 
    org.apache.derby.jdbc.ClientDriver
  56. Enter the fully qualified path to the JDBC driver file (derbyclient.jar).

    This file should have been copied from the WebFOCUS installation folders as described in step 40 of the custom installation of WebFOCUS.

    Since the installation allows entry of more than one driver, enter a blank value to leave this prompt.

    The Advanced Configuration pane displays, as shown in the following image.

  57. Enter the host name for your Distribution Server machine. The default is the host name of the local machine.
  58. Enter the port number for your Distribution Server.

    Note: This must match the value entered during the WebFOCUS component installation.

  59. Select whether you want to start the Distribution Server.

    Note: In order to start the Distribution Server, the Derby database must be started on the remote host. Additionally, all credentials entered must be correct.

    A pre-installation summary is displayed over several panels.

    Use the PgUp and PgDn keys to review all of the values. If you want to change any values, type BACK. To exit the installation type QUIT. To proceed with the installation, press Enter.

    While the installation files are being copied and configured, a visual progress indicator is displayed and updated on the screen.

    ==========================================================Installing...
------------- [==================|==================|==================|===========
[------------------|------------------|-----------

    After the installation is finished, the Installation Complete pane displays, as shown in the following image.

    Two log files are created after the installation is finished. The WebFOCUS install log is named:

    WebFOCUS80_Install_mm_dd_yyyy_hh_mm_ss.log

    The InstallAnywhere log file is named:

    WebFOCUS80_yyyy_mm_yyThh_mm_ss_sss.log

    These log files are placed in the home folder of the user ID that ran the installation program. You may need to refer to these files if there are any install issues.

  60. Navigate to the following directory: 
    cd /home/custom/ibi/WebFOCUS80/ReportCaster/bin
  61. Enter sh schbkr & to start the Distribution Server.

    Wait for a message, which indicates that the Distribution Server was started. For example:

    $ Console ready
Console is listening on port: 8215
Reader ready
Dispatcher ready

    For more information on configuring web and application servers, see Configuring Web and Application Servers. For more information on post-installation configuration and verification, see Post-Installation Verification and Configuration.
Top of page
x
Installation Trace Files

Most files created by the installation are placed in the directories you specify and are used for WebFOCUS operations or configuration. However, you should be aware of the following files created for debugging or upgrading purposes:

install.cfg and install2.cfg

These appear in /installation_directory/ibi/WebFOCUS80/config. They display the parameters used for the installation. Editing these files normally has no effect on most operations, but do not delete them. If parameters are incorrect and you are unsure where they are set, uninstall and reinstall.

dserver.log

This appears in /installation_directory/ibi/WebFOCUS80/ReportCaster/log. This displays the parameters used for the installation. Editing this file has no effect on the operations but do not delete it.

Note: These files are only used when running a service pack upgrade. If you should update your database information after you installed WebFOCUS, you will need to manually update the install.cfg with the new repository information before you run a service pack update.

WebFOCUS