Migrating Configuration Files from Release 8.1 Version 05M to Release 8.2 Version 03

Topics:

Due to architecture changes in WebFOCUS, the configuration of WebFOCUS has changed between Release 8.1.x and Release 8.2.x. If you are upgrading content from Release 8.1 Version 05M to Release 8.2 Version 03, use the configuration file migration utility to ensure that the configuration applied in the earlier release is properly migrated to the new installation.

Note: Run the configuration file migration utility before updating the WebFOCUS database repository.

Configuration File Migration Utility Implementation

How to:

The configuration file migration utility is implemented using Java. Java 7 or higher is required to run the configuration file migration utility. You can perform the migration by running Java commands from the Command line.

The following configuration files will be migrated:

  • webconfig.xml and install.cfg

    The install.cfg file in Release 8.2 Version 03 will be updated and the following settings will be added while moving entries from the install.cfg and webconfig.xml files from the earlier Release 8.1 Version 05M 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 will be moved to the webfocus.cfg file.

    The configuration file migration utility will not move the following settings. The Release 8.2 Version 03 defaults will be 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
  • languages.xml. Configuration entries in this file for Release 8.1 Version 05M will be combined with the entries in the Release 8.2 Version 03 version of the file.
  • mime.wfs. Configuration entries in this file for Release 8.1 Version 05M will be combined with the entries in the Release 8.2 Version 03 version of the file.
  • Security files:
    • securitysettings.xml
    • securitysettings-mobile.xml
    • securitysettings-portlet.xml
    • securitysettings-zone.xml

    These security files will get copied from Release 8.1 Version 05M to Release 8.2 Version 03.

    If you use SAML authentication, update the migrated securitysettings.xml file and ensure the path to the location of the SAML certificate is correct.

    The default path for Release 8.1.05 is:

    {IBI_CONFIGURATION_DIRECTORY}/was/saml/samlKeystore.jks

    The default location for Release 8.2.03 is:

    {IBI_CONFIGURATION_DIRECTORY}/was/wfKeystore.jks

Note:

  • The original files modified through the configuration file migration utility will be backed up in the following directory:
    ..\ibi\WebFOCUS82\merge_files\
  • The log file name and location is:
    ..\ibi\WebFOCUS82\logs\configMigration.log
  • To preserve additional customizations done in Release 8.1 Version 05M, it is recommended that you copy the following configuration files from your Release 8.1 Version 05M installation to the corresponding folder of your Release 8.2 Version 03 installation.

    Prior to proceeding with the copy, ensure you have backed up the original files from Release 8.2 Version 03.

    • ..\ibi\WebFOCUS81\client\wfc\etc\odin.cfg

      Reporting Servers specified in the odin.cfg file must meet requirements of WebFOCUS Release 8.2.x.

    • ..\ibi\WebFOCUS81\client\wfc\etc\site.wfs

      Restore this file if it has been customized.

    • ..\ibi\WebFOCUS81\config\license.cfg
    • ..\ibi\WebFOCUS81\config\wflicense.key
    • ..\ibi\WebFOCUS81\ibi_html\javaassist\ibi\html\olap\olapdefaults.js
    • ..\ibi\WebFOCUS81\config\caster\ApplicationPreferences.xml
    • ..\ibi\WebFOCUS81\ibi_html\javaassist\nls.txt
    • ..\ibi\WebFOCUS81\config\security_metadatasource.xml
    • ..\ibi\WebFOCUS81\ibi_html\javaassist\ibi\html\js\multidrill.css

      Restore this file if it has been customized.

    • ..\ibi\WebFOCUS81\config\was\
    • ..\ibi\WebFOCUS81\config\web_resource\map\

    Ensure the JDBC driver configuration in the Release 8.2 Version 03 installation is correct and supports the database repository that is configured in the install.cfg file.

    ..\ibi\WebFOCUS82\utilities\setenv\utiluservars.bat
  • The migration of other customized files needs to be manually applied to the new installation.

Procedure: How to Run the Configuration File Migration Utility

  1. From the Command line, navigate to the following directory:
    ..\ibi\WebFOCUS82\utilities\lib\
  2. Run the following command:
    java -classpath IBFSCommands.jar com.ibi.applications.config.WFMigrateConfig 
    oldDocumentRoot newDocumentRoot

    where:

    oldDocumentRoot

    Is the root location of the Release 8.1 Version 05M installation.

    newDocumentRoot

    Is the location of the new installation directory.

    For example:

    java -classpath IBFSCommands.jar com.ibi.applications.config.WFMigrateConfig 
    C:\ibi\WebFOCUS81 C:\ibi\WebFOCUS82

    Note:

    • Java 7 or higher is required to run the configuration file migration utility.
    • When running the Java command to migrate the configuration files, you can also specify the location of Java to be used.

      For example:

      “C:\Program Files\Java\jre1.8.0_161\bin\java” 
      -classpath IBFSCommands.jar 
      com.ibi.applications.config.WFMigrateConfig 
      C:\ibi\WebFOCUS81 C:\ibi\WebFOCUS82 

WebFOCUS

Feedback