IZ83545: CUSTOMIZED ECLIPSE PORT NUMBER LOST ON UPGRADE

IBM Tivoli Monitoring 6.2.2 Fix Pack 8 (6.2.2-TIV-ITM-FP0008)
IBM Tivoli Monitoring 6.2.2 Fix Pack 9 (6.2.2-TIV-ITM-FP0009)
IBM Tivoli Monitoring 6.2.2 Fix Pack 6 (6.2.2-TIV-ITM-FP0006)

APAR status

• Closed as program error.

Error description

• When upgrading to a new fix pack, the customized port number for
  the Eclipse Help Server is replaced with the default 9999. The
  problem occurred in the customer environment using the following
  steps:
  
  1. Install ITM TEPS 6.21.00.04.
  2. Configure the TEPS using defaults.
  3. Configure the Eclipse Help Server and specify a port other
     than 9999.
  4. Upgrade ITM TEPS to 6.21.03.00.
  5. Start the Eclipse Help Server.
     - Note that it is still using port number 9999.
  
  A scan of the config files in CANDLEHOME/config shows the port
  number was retained:
  
    kf.config:HELPSVR_PORT='8888'
    .ConfigData/kkfenv:aix533|HELPSVR_PORT|8888|
  
  The problem is the code that starts the Eclipse Help Server does
  not use these settings. Instead, the value is hardcoded in the
  <plat>/kf/IC_start.sh script:
  
     $JREEXE -classpath
     eclipse/plugins/org.eclipse.help.base_3.1.0/helpbase.jar
     org.eclipse.help.standalone.Infocenter -eclipsehome eclipse
     -plugincustomization
     plugins/com.ibm.help.ic.doc_3.1.1/plugin_customization.ini
  >> -port 9999 -command start -noexec
  
  When the Eclipse Help Server (kf) is configured, both the config
  files and this script are updated. However, at upgrade time, the
  script is replaced and the port number change is lost. The
  code needs to be changed to use the config file setting so the
  script file does not need to be modified.
  
  While diagnosing this problem, we noticed that the port number
  also exists in the TEPS (cq) configuration files. We found the
  following entries in CANDLEHOME/config:
  
     cq.config:KFW_ECLIPSE_HELP_SERVER_PORT='9999'
     .ConfigData/kcqenv:aix536|KFW_ECLIPSE_HELP_SERVER_PORT|9999|
     .ConfigData/kcqenv:default|KFW_ECLIPSE_HELP_SERVER_PORT|9999|
  
  These settings are not changed when the Eclipse Help Server (kf)
  is configured. Instead, these settings are changed when the TEPS
  (cq) is configure *after* the change is made to the Eclipse Help
  Server. The documentation makes no mention of this requirement.
  

Local fix

• After installing the upgrade, reconfigure the Eclipse Help
  Server and specify the desired port number. This action will
  reapply the port change to the <plat>/kf/IC_start.sh script.
  

Problem summary

• When upgrading to a new fix pack, the customized port number for
  the Eclipse Help Server is replaced with the default 9999. This
  is because the file IC_start.sh which is used to start the
  Eclipse Help Server is laid down with maintenance and the
  default port is hard coded. When the Eclipse Help Server (kf) is
  configured, both the config files and this script are updated
  with the correct stored port number. This problem only occurs on
  Unix/Linux platform.
  

Problem conclusion

• Added code that is called at install time to invoke the
  kkfconfig.sh to update IC_start.sh with the stored Help Server
  port number.
  
  The fix for this APAR is included in the following maintenance
  vehicle:
      | fix pack | 6.2.1-TIV-ITM-FP0004
      | fix pack | 6.2.2-TIV-ITM-FP0004
  

Temporary fix

• After installing the upgrade, reconfigure the Eclipse Help
  Server and specify the desired port number. This action will
  reapply the port change to the <plat>/kf/IC_start.sh script.
  

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  TEPS

• Fixed component ID

  5724C04PS

Applicable component levels

• R621 PSY

     UP