PM17679: KEEP LANGUAGE SETTING WHEN CLEARING STATE

6.1.0.5 Download: WebSphere Portal and WCM V6.1.0 fix pack 5
6.1.0.6 Download: WebSphere Portal and WCM V6.1.0 fix pack 6

APAR status

• Closed as program error.

Error description

• A choice of language which has been made temporarily using
  
  <portal-navigation:url command="ChangeLanguage">
    <portal-navigation:urlParam name="locale"
                                value="<language>"/>
  </portal-navigation:url>
  
  is kept in the navigational state. The choice is lost when the
  navigational state is cleared. This happens if bookmarks to
  friendly URLs are used for navigation or the navigational state
  is cleared intentionally. This APAR provides a preprocessor,
  which creates a backup copy of the locale information found in
  the navigational state to a cookie. It sets the locale
  information, if no locale information can be found in the
  navigational state. The locale information in the navigational
  state is not modified. When choosing a different language the
  information in the cookie is updated.
  
  The preprocessor "com.ibm.wps.state.preprocessors.locale
  .CookieSupportedLanguagePreProcessor" can be added to the list
  of preprocessors in the StateManagerService configuration
  according to the information on page "Portal configuration
  services" in the WebSphere Portal information center.
  The lifetime of the cookie (maxAge) can be defined by specifying
  new custom property "com.ibm.wps.state.preprocessors.locale
  .CookieSupportedLanguagePreProcessor.cookie.maxage" in the
  configuration of the StateManagerService. The value of this
  property is an integer value that is interpreted as the amount
  of seconds until the cookie is invalidated. A negative value,
  i.e. -1, means that the cookie is not deleted until the browser
  session is finished, i.e. by closing the web browser window. The
  default of this setting is -1.
  
  Examples:
  # Cookie is active for 30 seconds after the last request
  com.ibm.wps.state.preprocessors.locale
  .CookieSupportedLanguagePreProcessor.cookie.maxage=30
  
  # Cookie is active as long as the browser window is not closed
  com.ibm.wps.state.preprocessors.locale
  .CookieSupportedLanguagePreProcessor.cookie.maxage=-1
  
  
  
  To configure the custom properties:
  1) Login to the WAS Admin Console (or Depoloyment Manager if
  clustered).
  2) Navigate to Resources --> Resource Environment Providers -->
  WP StateManagerService --> Custom Properties
  3) Create a new custom property if it does not exist:
  
  Name:
  com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguagePr
  eProcessor.cookie.maxage
  Value:  -1
  Type:  java.lang.String
  
  *Note, you may specify a different timeout value as noted above.
  This is an example only.
  
  
  
  4) Create a new custom property:
  
  Name: preprocessors
  Value:
  com.ibm.wps.state.preprocessors.urlmapping.URLMappingPreProcesso
  r,
  com.ibm.wps.resolver.friendly.preprocessors.FriendlyPreProcessor
  ,
  com.ibm.wps.resolver.portal.ResolvedPreprocessor,
  com.ibm.wps.state.preprocessors.selection.StandardPortalSelectio
  nImpl,
  com.ibm.wps.state.preprocessors.selection.FragmentSelectionImpl,
  com.ibm.wps.state.preprocessors.selection.ResourceSelectionImpl,
  com.ibm.wps.state.preprocessors.eclipse.ExtensionPreProcessor,
  com.ibm.wps.state.preprocessors.portlet.RequestParameterMerger,
  com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguagePr
  eProcessor
  
  Type: java.lang.String
  
  *Note, the final parameter is the new property required by this
  APAR.  The preceding properties are required and may vary from
  version to version of WebSphere Portal.  Check the Infocenter
  based on your version of WebSphere Portal.  For version 6.1:
  http://publib.boulder.ibm.com/infocenter/wpdoc/v6r1/index.jsp?to
  pic=/com.ibm.wp.ent.doc_v6101/admin/srvcfgref.html
  
  6) Save changes. If clustered, sync nodes.
  7) Restart the Portal server(s).
  

Local fix

• n/a
  

Problem summary

• A choice of language which has been made temporarily using
  
     <portal-navigation:url command="ChangeLanguage">
       <portal-navigation:urlParam name="locale"
                                   value="<language>"/>
     </portal-navigation:url>
  
  is kept in the navigational state. The choice is lost when the
  navigational state is cleared. This happens if bookmarks to
  friendly URLs are used for navigation or the navigational state
  is cleared intentionally. This APAR provides a preprocessor,
  which creates a backup copy of the locale information found in
  the navigational state to a cookie. It sets the locale
  information, if no locale information can be found in the
  navigational state. The locale information in the navigational
  state is not modified. When choosing a different language the
  information in the cookie is updated.
  
  The preprocessor
  "com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguageP
  reProcessor" can be added to the list of preprocessors in the
  StateManagerService configuration according to the information
  on page "Portal configuration services" in the WebSphere Portal
  information center. The lifetime of the cookie (maxAge) can be
  defined by specifying new custom property
  "com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguageP
  reProcessor.cookie.maxage" in the configuration of the
  StateManagerService. The value of this property is an integer
  value that is interpreted as the amount of seconds until the
  cookie is invalidated. A negative value, i.e. -1, means that the
  cookie is not deleted until the browser session is finished,
  i.e. by closing the web browser window. The default of this
  setting is -1.
  
  Examples:
  # Cookie is active for 30 seconds after the last request
  com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguagePr
  eProcessor.cookie.maxage=30
  
  # Cookie is active as long as the browser window is not closed
  com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguagePr
  eProcessor.cookie.maxage=-1
  

Problem conclusion

• Configure the StateManagerService to use the preprocessor
  
  "com.ibm.wps.state.preprocessors.locale.CookieSupportedLanguageP
  reProcessor"
  
  provided with this APAR.
  
  Manual Steps:
     None
  
  Failing Module(s):
     Engine: State handling
  
  Affected Users:
     All users
  
  Version Information:
      Portal Version(s): 6.1.0.1
       Pre-Requisite(s): PM00237 PM17968
        Co-Requisite(s): ---
  
  Platform Specific:
     This fix applies to all platforms.
  
  The fix is available from Fix Central:
  
  http://www.ibm.com/eserver/support/fixes/fixcentral/swgquickorde
  r?apar=PM17679&productid=WebSphere%20Portal&brandid=5
  
  You may need to type or paste the complete address into your Web
  browser.
  

Temporary fix

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

  WEBSPHERE PORTA

• Fixed component ID

  5724E7600

Applicable component levels

• R61A PSY

     UP