Upgrading In Place to Release 9.3.1

The following topic describes how to perform an upgrade in place of content from Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x to Release 9.3.1 while using the existing WebFOCUS Release 8207, WebFOCUS Release 9.0.x, WebFOCUS Release 9.1.x, or WebFOCUS Release 9.2.x installation directory.

Important: As of Release 9.0.0, the WebFOCUS system file configuration no longer includes the ibi_html directory, located at drive:\ibi\WebFOCUSrelease\WebFOCUS, where release is the number of your installed release. If you store customized stylesheet files or other files in the ibi_html directory, you must upload them from this directory to the WebFOCUS Repository before installing or upgrading to WebFOCUS Release 9.0.0 or later.

This release includes several updates to search capabilities in WebFOCUS.

  • For an upgrade installation from Release 9.0.1 or earlier, the repository must be reindexed to use these search capabilities.
  • For a new installation, the repository must be reindexed if you are using a pre-existing repository from a previous release.

For more information on how to reindex, see the Indexing Content and Data topic in the ibi™ WebFOCUS® User Guide or in the WebFOCUS Online Help system.

Prerequisites for Upgrading In Place

The following are prerequisites for upgrading in place from Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x to Release 9.3.1:

  • Ensure the database used for the WebFOCUS repository is backed up prior to proceeding with the upgrade installation.

    This is required as the installation program performs database changes and a restore may be required in case of failures.

  • For the installation that is upgraded, it is recommended to back up the existing installation folder and files on disk.

    The installation program backs up the entire directory prior to upgrading and restores all files in case there are failures that do not allow the installation to proceed. This is a safety measure in case there are installation failures.

  • Ensure the application server used by the installation meets the WebFOCUS Release 9.3.1 requirements:
    • WebFOCUS is configured for a supported version of Java.
    • Application server supports the servlet API 3.1 specifications.
    • If using Tomcat, it is recommended that you use the latest 9.0.x version. Tomcat 9.0.x is supported.
    • You are using a supported database.
  • Prior to running the upgrade installation, ensure the application server used by the existing WebFOCUS installation is stopped to ensure files are not locked and there is no product usage.

    If Tomcat is used, the installation program attempts to stop the Apache Tomcat service.

  • Ensure the ReportCaster service for the existing installation is stopped.

    The installation program attempts to stop the ReportCaster service.

  • To avoid files being locked, ensure files from the existing installation are not opened by File Explorer, CMD Window,UNIX Shell, or another application, such as an editor or browser.
  • Ensure the connection to the database hosting the WebFOCUS repository is running.

The following are tasks performed by the installation after selecting to upgrade an existing Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x to Release 9.3.1:

  1. Check for existence of a supported version of Java.
  2. Check for Tomcat and stop service.
  3. Check for ReportCaster service and attempt to stop it.
  4. Check database connection to run required database scripts.

    This is done based on connection information available in the install.cfg file.

  5. On successful connection, you are prompted to provide WebFOCUS administrator credentials to be used when the installation runs the update_repos script.
  6. User authentication and authorization are performed to ensure the provided WebFOCUS account is valid and has privileges to perform import of Change Management packages.
  7. For an upgrade from an earlier release, backup all files to the version folder of the earlier release. For example, for an upgrade from Release 9.2.x, backup the files to:
    ..\ibi\WebFOCUS92\backup_files\
    /install_directory/ibi/WebFOCUS92/backup_files/

    If the backup fails, for example, due to locked files, a message displays. The installation restores all backed up files and exits.

  8. The new Release 9.3.1 installation is performed in the same Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x folder and the installation properly applies required edits to configuration files, in addition to restoring files as specified in Step 9.

  9. For an upgrade from Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x, files updated by the installation get backed up in the version folder of the earlier release. For example, for upgrade from Release 9.2.x files are backed up to:
    ..\ibi\WebFOCUS92\update_files\
    /install_directory/ibi/WebFOCUS92/update_files/

    The following files are restored and updated during installation:

    • web.xml. Updated during installation, using default values.
    • odin.cfg. Restored from backup.
    • site.wfs. Restored from backup.
    • license.cfg. Restored from backup.
    • wflicense.key. Restored from backup.
    • olapdefaults.js. Restored from backup.
    • nls.txt. Restored from backup.
    • security_metadatasource.xml. Restored from backup.
    • multidrill.css. Restored from backup.
    • config/caster/ApplicationPreferences.xml. Restored from backup.
    • /config/was/. Restored from backup.
    • /config/web_resource/map/. Restored from backup.
    • nlscfg.err. Language and code page is updated, based on configuration of the existing installation. If the WebFOCUS Client code page in the installation was configured as 137 or 437, the code page gets changed to 1252.

  10. Migration of configuration files is performed.

    For an upgrade from Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x, files updated by the migration utility are backed up in the version folder of the earlier release. For example, for an upgrade from Release 9.2.x, the files are updated to:

    ..\ibi\WebFOCUS92\merge_files\
    /install_directory/ibi/WebFOCUS92/merge_files/
    • webconfig.xml and install.cfg

      The install.cfg file in Release 9.3.1 is updated. The following settings are added while moving entries from the install.cfg and webconfig.xml files from the earlier Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x installation:

      IBI_APPROOT_DIRECTORY
      
      IBI_WEBAPP_CONTEXT_DEFAULT
      
      IBI_WEBFOCUS_CONTEXT
      
      IBI_STATIC_CONTENT_CONTEXT
      
      IBI_HELP_CONTEXT
      
      IBI_REPORTCASTER_CONTEXT
      
      IBI_REPOS_DB_USER
      
      IBI_REPOS_DB_PASSWORD
      
      IBI_REPOS_DB_DRIVER
      
      IBI_REPOS_DB_URL

      Note:
      • Any additional updated settings found in the webconfig.xml file is moved to the webfocus.cfg file.
      • File types specified in the Administration Console for inclusion in the Change Management export packages are preserved during upgrades and an entry with these values is added to the webfocus.cfg file. By default, the following file types are supported for exports created by the change management feature: acx, bmp, css, fex, gif, htm, html, ico, jpe, jpeg, jpg, js, mas, mnt, png, sty, and svg. The file type list can be adjusted from the Administration Console.

      The configuration file migration utility does not move the following settings. The Release 9.3.1 defaults are used for the following:

      IBI_CSRF_ENFORCE
      
      IBI_CM_RETAIN_HANDLES
      
      IBI_CUSTOM_SECURITY_PARAMETER
      
      IBI_CUSTOM_SECURITY_DRIVER
      
      IBI_ENCRYPTION_PROVIDER
      
      IBI_MOVE_CONFIRMATION_MESSAGE
      
      IBI_REPOSITORY_SYNC_INTERVAL
      
      IBI_REST_METHOD_ENFORCE

      The IBI_WEBAPP_DEFAULT_URL setting is created in the install.cfg file and is used by the InfoSearch Dimension Index Loader. The default value is:

      http://<hostname>:80

      This can be configured through the Administration Console to provide the proper WebFOCUS protocol, host name, and port.

    • mime.wfs. Entries in this file for earlier releases Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x is combined with the entries in the Release 9.3.1 version of the file.
    • Security files:
      • securitysettings.xml
      • securitysettings-mobile.xml
      • securitysettings-portlet.xml
      • securitysettings-zone.xml

      These security files are copied from the earlier releases Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x to Release 9.3.1.

    • languages.xml. Entries in this file for earlier releases Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x, are combined with the entries in the Release 9.3.1 version of the file.
    • cgivars.wfs. Settings stored in the ..\client\wfc\etc\cgivars.wfs file, such as Default Server Node, OLAP, and Parameter Prompting settings are not maintained during the migration process. These settings should be reapplied through the Administration Console. Changes to settings applied through the Administration Console are written to the ..\config\webfocus.cfg file.
    • cgivars.wfs. Settings stored in /client/wfc/etc/cgivars.wfs file, such as Default Server Node, OLAP, and Parameter Prompting settings are not maintained during the migration process. These settings should be reapplied through the Administration Console. Settings changed through the Administration Console are written to the /config/webfocus.cfg file.
  11. Check database collation.
  12. If the database is Microsoft SQL Server or MySQL and collation is CI, the installation program changes the database collation to the best matched CS collation.

  13. The upgrade updates the Program group, ReportCaster service, and registry entries.

    If the WebFOCUS ReportCaster service was configured using a domain user account as a service logon account, the service needs to be reconfigured with this option after the upgrade completes.

  14. Tomcat cache is cleared.
  15. Tomcat is restarted.
  16. Installation completes by running the verification page.
Note:
  • If you are using another application server, redeploy the WebFOCUS web application WAR or EAR file, clear cache manually, and restart the application server.

  • If any of the database update tasks fail, for example, due to connectivity issues or not having database or WebFOCUS account credentials, the database update tasks can be performed postinstallation. For more information, see Postinstallation Review for Upgrading In Place.

Postinstallation Review for Upgrading In Place

  1. For an upgrade in place from Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x, run db_lb_update.batdb_lb_update.sh.

    For example, for release Release 9.2.x run ..\ibi\WebFOCUS92\utilities\dbupdate\db_lb_update.bat.run install_directory/ibi/WebFOCUS92/utilities/dbupdate/db_lb_update.sh.

  2. For an upgrade in place from Release 9.2.x, run update_repos.batupdate_repos.sh.

    For example, for release 9.2.x, run ..\ibi\WebFOCUS92\utilities\WFReposUtil\update_repos.bat.run install_directory/ibi/WebFOCUS92/utilities/dbupdate/update_repos.sh.

  3. Restart the application server.
  4. Ensure all required services are running (application server, WebFOCUS ReportCaster service, WebFOCUS Search Server).
  5. Ensure the connection to the database is working.
  6. Connect to WebFOCUS to ensure the product is working and content is accessible.

    WebFOCUS uses the web application context that was configured in the earlier Release 8207, Release 9.0.x, Release 9.1.x, or Release 9.2.x version.

  7. If the web application fails to load, check the application logs and WebFOCUS event.log file.
  8. For an upgrade in place from Release 9.2.x, ensure that the configuration file migration is successful by checking the existence of the version folder of the earlier release. For example, for an upgrade from Release 9.2.x check that the following folder exists:

    ..\ibi\WebFOCUS92\merge_files\
    /install_directory/ibi/WebFOCUS92/merge_files/
  9. For an upgrade in place from an earlier release, verify the contents of the install.cfg and webfocus.cfg files in the release version folder of the earlier release. For example, for an upgrade in place from Release 9.2.x verify the contents of install.cfg and webfocus.cfg in the following folder:
    ..\ibi\WebFOCUS92\config\
    /install_directory/ibi/WebFOCUS92/config/
  10. For an upgrade in place from an earlier release, ensure the JDBC driver set in the release version folder of the earlier release is correct, based on the database used as the repository. For example, for an upgrade from Release 9.2.x check the JDBC driver set in the following folder:
    ..\ibi\WebFOCUS92\utilities\setenv\utiluservars.bat
    /install_directory/ibi/WebFOCUS92/utilities/setenv/utiluservars.sh
  11. If collation check or change failed during the installation, the following needs to be performed postinstallation:
    1. Stop the application server.
    2. Ensure connection to the database is accessible and you have credentials that allow database changes (create/edit tables).
    3. For an upgrade in place from an earlier release, change database collation manually or using the tools available with the updated installation in the release version folder of the earlier release. For example, for an upgrade from Release 9.2.x do the changes in the following folder:
      ..\ibi\WebFOCUS92\utilities\dbupdate\collation\
      /install_directory/ibi/WebFOCUS92/utilities/dbupdate/collation/
    4. For an upgrade in place from an earlier release, run the database update by opening a Command Window (or a UNIX shell) and navigating to the release version folder. For example, for an upgrade in place from Release 9.2.x, navigate to the following folder:
      ..\ibi\WebFOCUS92\utilities\dbupdate\
      /install_directory/ibi/WebFOCUS92/utilities/dbupdate/
    5. From this location, run:
      db_lb_update.bat 
      db_lb_update.sh

      For example, for an upgrade in place from Release 9.2.x:

      C:\ibi\WebFOCUS92\utilities\dbupdate\db_lb_update.bat
      /install_directory/ibi/WebFOCUS92/utilities/dbupdate/db_lb_update.sh
    6. For an upgrade in place from an earlier release, run the command to import the required Change Management packages. For example, for an upgrade in place for Release 9.2.x run the command from:
      ..\ibi\WebFOCUS9\utilities\WFReposUtil\update_repos.bat
      /install_directory/ibi/WebFOCUS9/utilities/WFReposUtil/update_repos.sh
    7. Clear the application server cache.
    8. Restart the application server.