Monday, September 19, 2011

How can I customize the messages that Lighthouse uses? How can I customize the messages that Lighthouse uses?

: There is a tool called MsgTool which is available from support. With this tool one can modify individual entries in the message catalog.
You will find this tool as an attachment to this FAQ entry. This tool comes with the following Readme:

Built against the 31SP2 Lighthouse product release, but good for any release of 31SPx

Author: Todd Bradfute
Version: 1.0

Known Issues: None

Files Enclosed:
  classes/com/waveset/session/MessageTool.class
  classes/com/waveset/session/MessageTool-Readme.txt

How to use:
  Unzip the MessageTool-'version here'.zip file into your lighthouse/WEB-INF
  directory. This should create a directory structure underneath WEB-INF like this:
  classes/com/waveset/session

  Once the above files are in place, perform the following steps:
    - UNIX:
      export WSHOME=<path to the lighthouse root directory>
      export JAVA_HOME=<location of a JDK>
      export PATH=$JAVA_HOME/bin:$PATH

    - Windows:
      set WSHOME=<path to the lighthouse root directory>
      set JAVA_HOME=<location of a JDK>
      set PATH=%JAVA_HOME%/bin;%PATH%

  Now you are ready to execute and use the MessageTool utility:
    - Find the message key name of the message you wish to change. These keys are usually found
      in a jsp file, workflow xml, or user form xml object.
    - Execute the following command:
      lh com.waveset.session.MsgTool extract <name of the key you wish to extract>
    - The above step has extracted the message key and current value for you from the
      WPMessages.properties file and placed it into the CustomMessages.properties file located
      in the lighthouse/custom/msgcat directory.
    - Edit the lighthouse/custom/msgcat/CustomMessages.properties file and change the string
      associated with the message key as desired.
    - Execute the following command:
      lh com.waveset.session.MsgTool update
    - The above step has extracted the WPMessages.properties file from lighthouse.jar and placed
      it into the lighthouse/config directory. It has then appended your customized keys, from
      the CustomMessages.properties file, to the WPMessages.properties file found under the
      lighthouse/config directory.

  Once you are done with your message key modifications, you will need to restart the
  application server to pickup the changes.

Notes:
  Each time you perform a new service pack installation, you will need to run the update
  command. This will extract the latest WPMessages.properties file from lighthouse.jar and
  merge your custom messages into that file.
 
  Multiple runs of the update command will not cause the message key to be appended to
  the WPMessages.properties file multiple times.

No comments:

Post a Comment