i-fix Name: PK31575


Problem Summary: There is no easy and convenient way to stop a low quality,
                 bothersome portlet in WebSphere Portal 5.1 and later 
                 releases.

Detailed Problem Description: 

                 Prior releases of WebSphere Portal allowed administrators to 
                 start and stop portlets. This function is not available in
                 5.1 and later releases. Thus, there is no easy and convenient
                 way for an administrator to stop a bothersome, low quality
                 portlet.

Problem Analysis:

Failing Module: wp.ap.portletmanager

Problem Solution: This iFix adds the ability to start and stop web modules.
                  It does NOT add the ability to start and stop individual
                  portlets. The default behavior is that the portlet will
                  behave as it does today. When the customer adds a
                  allowStartStopWebModule parameter with a value of true
                  to the Manage Web Modules portlet, this new function 
                  becomes visible in the UI after a restart of the 
                  portal server. Once enabled there will be an additional
                  icon visible in the lists of web modules that allows an
                  administrator to start or stop the web module, depending on 
                  the web modules current state. 
                  
                  This new capability is not fully translated and text (eg.
                  hover helps and messages) will only be available in 
                  English or German. If another language is used the text
                  will appear in English.
                  
                  The new icons on the Manage Web Modules page will be
                  visible to all users. That is, no authorization check is
                  done to determine if the user has the authority to 
                  start or stop a web module when the icon is rendered.
                  Instead, the authorization checks will be done when the
                  user clicks the start or stop web module icon. If the user
                  does not have the authority to execute the action then a
                  failure message will appear on the page when it is
                  re-rendered.
                  
                  An administrator may not start or stop the PortletManager
                  web module under any circumstances.
                  
                  When a web module is stopped its portlet skins will still 
                  be visible to the user but the portlet body will show this
                  message: "This portlet is temporarily disabled.". When the
                  web module is restarted the portlets will display normally.

Affected Users:   This iFix may be applied by all customers.

Requisites:       None

Platform Specific: No

Fix pack: This fix will be integrated into WebSphere Portal V6.0.1

Installation Steps:

Example:
   NOTE:  YOU MUST FIRST DOWNLOAD THE UPDATE INSTALLER TOOL IN ORDER TO INSTALL A FIX.
          The Portal Update Installer can be downloaded from the following link:
          http://www.ibm.com/software/genservers/portal/support

   1. Create temporary "fix" directory to store the jar file.
   2. Copy jar file to this directory.
   3. Shutdown WebSphere Portal.
   4. Ensure the pre-requisite fix(es) are installed.
   5. Follow the fix installation instructions that are packaged with
      the Portal Update Installer on how to install a fix.
      NOTE: You must also ensure all pre-requisite fix(es) are installed.
      If you do not, the Portal Update Installer will fail and will list
      the missing pre-requisite fix(es).
   6. Restart WebSphere Portal.        
   7. Note that this iFix provided new war file(s):
   
      <PortalServer>/installableApps/PortletManager.war

   8. To install the admin portlet listed above, you will need to use xmlaccess.

      You can start with the <PortalServer>/doc/xml-samples/UpdatePortlet.xml that is 
      already installed on your Portal Server as an example.  Then, modify a copy of 
      that file to work with your installation and the included PortletManager.war file.
   
      Or, you can start with the included UpdatePortletManagerPortlet.xml and modify it
      to work with your installation.

      Use <PortalServer>\bin\xmlaccess.bat or xmlaccess.sh and run the xmlaccess script 
      that you modified above to update the PortletManager portlets.
   9. To enable the new feature, login as wpsadmin and do the following:
      -- Click Administration -> Portlet Management -> Applications -> Portlet Manager Application -> Manage Web Modules configure (wrench) icon
      -- In the New parameter field type allowStartStopWebModule 
      -- In the New value field type true 
      -- Click Add
      -- Click OK
      -- Restart WebSphere_Portal server

      
Refer to Clustering->”Performing Upgrades in a 24x7 cluster” section for additional information on applying interim fixes in clustered environments while maintaining continuous availability of your Portal.


Un-Installation Steps:

NOTE:  FIXES MUST BE REMOVED IN THE ORDER THEY WERE APPLIED.  DO NOT REMOVE A 
   FIX UNLESS ALL FIXES APPLIED AFTER IT HAVE FIRST BEEN REMOVED.
   YOU MAY REAPPLY ANY REMOVED FIX.

   1. Shutdown WebSphere Portal.
   2. Follow the instructions that are packaged with the
      Portal Update Installer on how to uninstall a fix.
   3. Restart WebSphere Portal.
   4. The new war file has been removed from the <PortalServer>/installableApps directory, 
      and the previous version should be there now.  Install the previous admin portlet, 
      as described above.

Refer to Clustering->”Performing Upgrades in a 24x7 cluster” section for additional information on applying interim fixes in clustered environments while maintaining continuous availability of your Portal.