IBM WebSphere Portal Update Installer README

This document describes the IBM WebSphere Portal update installer application.

Last updated: May 13, 2009

This section describes the WebSphere Portal update installer application, which can be used to install interim or cumulative fixes and fix packs on the WebSphere Portal Version 6.1 product. The application can also be used to uninstall fixes. This section provides examples of the command syntax used by the update installer and information on tracking product offering version and history information that the WebSphere Portal product offerings maintain whenever you install or remove an interim fix or fix pack.

This section is a reference for theupdatePortal command and its parameters. However, for detailed instructions on using the update installer, always refer to the README file provided with the interim or cumulative fix or fix pack.

 

Contents

 

Downloading the Portal Update Installer

Download the PortalUpdateInstaller.zip file which contains the Portal Update Installer application. Download this file from the appropriate support page for your product offering: NOTE: References to PortalUpdateInstaller.zip also include PortalUpdateInstaller lt;platform>.zip where <platform> is the platform specific zip file.

The default location from which to unpack the update installer file is the portal_server_root/update directory. Interim fixes can be downloaded to the /update/fixes directory, and fix packs can be downloaded to the portal_server_root/update/fixpacks directory. The location of these directories is arbitrary. To use a different directory, adjust the instructions in this section accordingly.

Notes:

The update installer records processing results in log files in the portal_server_root /version/log directory. Backup files created during the installation of interim fixes and fix packs are stored in the portal_server_root/version/backup directory. These files are required to uninstall an interim fix or fix pack.

 

Using theupdatePortalWizard Graphical User Interface

This section describes theupdatePortalWizard command and its command-line parameters. After launching the updatePortalWizard, refer to the instructions in the panels for installing or uninstalling fixes and fix packs.

The graphical user interface is not supported on i5/OS.

On Solaris, it is recommended to use the Common Desktop Environment.

Do not launch multiple copies of the update installer at one time. The update installer cannot be launched concurrently with itself. Performing more than one update at the same time can lead to a failed or faulty installation.

Installation roots

portal_server_root represents the directory where WebSphere Portal is installed. By default, this varies per product offering and operating system.
  • IBM AIX: /usr/WebSphere/PortalServer
  • UNIX and Linux: /opt/WebSphere/PortalServer
  • Windows: drive:\Program Files\WebSphere\PortalServer

Space requirements

Space requirements vary depending on what you are installing. The size of each download is available on the Support site. After unpacking the ZIP file you download, delete the ZIP file to free space. Space is also required for backup files in the portal_server_root /version/backup directory and your system temp directory.

Prerequisite Java environment setting

Set up the Java environment for the update installer:
  1. Open a command line window.
  2. Change directory to the app_server_root/bin directory, where app_server_root is the installation directory of the WebSphere Application Server that is associated with WebSphere Portal.
  3. Issue the appropriate command:
    • UNIX: .(space)./setupCmdLine.sh

      When running this command in a UNIX shell, be sure to use the syntax .(space)./setupCmdLine.sh. If you do not precede the command with the period and space, the Java environment will not be properly set for the active shell.

    • Linux: source setupCmdLine.sh
    • Windows: setupCmdLine.bat

Command name

updatePortalWizard.{sh|bat}

Follow the instructions in the panels of theupdatePortalWizard to install or uninstall fixes and fix packs.

 

Using theupdatePortal command

This section describes theupdatePortal command and its command-line parameters.

Do not launch multiple copies of the update installer at one time. The update installer cannot be launched concurrently with itself. Performing more than one update at the same time can lead to a failed or faulty installation.

Installation roots

portal_server_root represents the directory where WebSphere Portal is installed.
  • AIX: /usr/WebSphere/PortalServer
  • UNIX and Linux: /opt/WebSphere/PortalServer
  • Windows: drive:\Program Files\WebSphere\PortalServer
  • i5/OS: portal_server_root

Space requirements

Space requirements vary depending on what you are installing. The size of each download is available on the Support site. After unpacking the ZIP file you download, delete the ZIP file to free space. Space is also required for backup files in the portal_server_root/version/backup directory.

Prerequisite Java environment setting

Set up the Java environment for the update installer:

If you are using the platform specific update installer which includes an embedded jre, the following steps are not needed.

  1. Open a command line window.

  2. Change directory to the app_server_root/bin directory, where app_server_root is the installation directory of the WebSphere Application Server that is associated with WebSphere Portal.

  3. Issue the appropriate command:

    • UNIX: .(space)./setupCmdLine.sh

      When running this command in a UNIX shell, be sure to use the syntax .(space)./setupCmdLine.sh. If you do not precede the command with the period and space, the Java™ environment will not be properly set for the active shell.

    • Linux: source setupCmdLine.sh

    • Windows: setupCmdLine.bat

    • i5/OS, export WAS_PROD_HOME from a QSH environment:

      • For example, WebSphere Application Server Version 6.1:
          export WAS_PROD_HOME=/QIBM/ProdData/WebSphere/AppServer/V61/ND

Command name

updatePortal.{sh|bat}

Command parameters

Given certain command parameters, theupdatePortal command can:
  • Install or uninstall interim or cumulative fixes or fix packs
  • Provide information about the update state of applied interim or cumulative fixes or fix packs

The following table describes the parameters that can be used with theupdatePortal command. Variables in the parameter column are show italicized, like this.

Parameter Description
-? Shows command usage
/?

Shows command usage on Windows platforms only. Not supported for Linux and UNIX-based platforms.

-fix Interim fix only. Identifies the update as an interim fix update.
-fixDetails Interim fix only. Displays interim fix detail information.
-fixDir Interim fix only. Fully qualified directory where you download interim fixes. Usually portal_server_root/update/fixes directory
-fixes Interim fix only. Specifies a list of space-delimited interim fixes to install or uninstall.
-fixJars Interim fix only. Specifies a list of space-delimited interim fix JAR files to install or uninstall. Each JAR file has one or more interim fixes.
-fixpack Fix pack only. Identifies the update as a fix pack update.
-fixpackDetails Fix pack only. Displays fix pack detail information.
-fixpackDir Fix pack only. Specifies the fully qualified directory where you download and unpack fix packs. By default, this directory is the portal_server_root/update/fixpacks directory.
-fixpackID Fix pack only. Specifies the ID of a fix pack to install or uninstall. The value you specify does not include the .jar extension. The value is not the fully qualified package file name, but is the name of the individual fix pack within the JAR file. The current WebSphere Portal strategy for fix pack JAR files is to use one JAR file per fix pack. The fix pack ID is the name of the JAR file before the Jar extension. For example:

fix pack ID: WP_PTF_6101 fix pack JAR file name: WP_PTF_6101.jar fix pack ZIP file name: WP_PTF_6101.zip

-help Shows command usage
/help Shows command usage
-includeOptional Fix pack only. Specifies a space-delimited list of features. The installer applies any service for the components, if present in the fix pack. Otherwise, the installer does not apply the service.
-install Installs the update, either interim fix or fixpack
-installDir Specifies the fully qualified installation root of the WebSphere Portal product.
-prereqOverride Interim fix only. Overrides any installation and uninstallation prerequisite checking. The update installer does not log missing prerequisites.
-uninstall Uninstalls the identified fix
-uninstallAll Interim fix only. Specifies to uninstall all applied interim fixes.
-usage Shows command usage


Examples of command parameter syntax

The following table of examples provides the syntax of various parameters used with the update installer. In each example, optional parameters are enclosed by brackets ([ ]). Values that you supply are italicized, like this. Choices are denoted by the pipe symbol (|).

Parameter function Syntax example
Help updatePortal -help | -? | /help | -usage
Fix processing 
updatePortal -installDir "/path/to/portal/home"
             -fix
             -fixDir "$PORTAL_HOME/update/fixes/MyFixDir"
             -install | -uninstall | uninstallAll
             -fixes space-delimited list of fixes
             -fixJars space-delimited list of fix JAR files
            [-fixDetails]
            [-prereqOverride]
View applied fixes 
updatePortal -fix 
             -installDir "/path/to/portal/home"
View available fixes 
updatePortal -fix 
             -installDir "/path/to/portal/home"
             -fixDir "$PORTAL_HOME/update/fixes/MyFixDir"
Fix pack processing 
updatePortal -installDir "/path/to/portal/home"
             -fixpack
             -fixpackDir "$PORTAL_HOME/update/fixpacks/MyFixPack"
             -install | -uninstall
             -fixPackID fix pack ID
            [-includeOptional space-delimited list of components]
            [-fixpackDetails]

All other valid arguments are ignored, such as the prereqOverride argument, which is for fix processing only.

View applied fix packs 
updatePortal -fixpack 
            -installDir "/path/to/portal/install/dir"
View available fix packs 
updatePortal -fixpack 
            -installDir "/path/to/portal/install/dir"
            -fixpackDir "$PORTAL_HOME/update/fixpacks/MyFixPack"


Examples of useful commands with parameters

The following examples assume that:
  • The installation root is the $PORTAL_HOME/directory.
  • The fix repository is the $PORTAL_HOME/update\fixes directory.
  • The fix pack repository is the $PORTAL_HOME/update\fixpacks directory.

The examples are split onto more than one line for visual clarity, but the command and associated parameters would be entered on one line during actual usage.

Install a collection of interim fixes

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -install 
               -fixes Fix1 Fix2

Install a collection of interim fixes and displaying interim fix details

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -install 
               -fixes Fix1 Fix2 
               -fixDetails

Install a collection of fixes and overriding prerequisite checking

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -install 
               -fixes Fix1 Fix2 
               -prereqOverride

Install interim fixes from a Java archive (JAR) file

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -install 
               -fixJars Fix1

Install interim fixes from a Java archive (JAR) file and displaying interim fix details

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -install 
               -fixJars Fix1 
               -fixDetails

Install interim fixes from a Java archive (JAR) file and overriding prerequisite checking

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -install 
               -fixJars Fix1 
               -fixDetails 
               -prereqOverride

Uninstall a collection of interim fixes

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -uninstall 
               -fixes Fix1 Fix2

Uninstall a collection of interim fixes and displaying interim fix details

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -uninstall 
               -fixes Fix1 Fix2 
               -fixDetails

Uninstall a collection of interim fixes and overriding prerequisite checking

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -uninstall 
               -fixes Fix1 Fix2 
               -prereqOverride

Uninstall interim fixes in a JAR file

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -uninstall 
               -fixJars Fix1

Uninstall interim fixes in a Java archive (JAR) file and displaying interim fix details

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -uninstall 
               -fixJars Fix1 
               -fixDetails

Uninstall interim fixes in a JAR file and overriding prerequisite checking

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes" 
               -uninstall 
               -fixJars Fix1 
               -fixDetails
               -prereqOverride

View a list of installed interim fixes

./updatePortal -fix 
               -installDir "$PORTAL_HOME/

View a list of interim fixes available in the repository

./updatePortal -fix 
               -installDir "$PORTAL_HOME/ 
               -fixDir "$PORTAL_HOME/update\fixes"

Install a fix pack

./updatePortal -fixpack 
               -installDir "$PORTAL_HOME/ 
               -fixpackDir "$PORTAL_HOME/update\fixpacks" 
               -install 
               -fixpackID Fixpack1

Install a fix pack and displaying fix pack details

./updatePortal -fixpack 
               -installDir "$PORTAL_HOME/ 
               -fixpackDir "$PORTAL_HOME/update\fixpacks"
               -install 
               -fixpackID Fixpack1 
               -fixpackDetails

Performing a partial installation of a fix pack by choosing to skip the installation of optional service to the WebSphere Portal content publishing feature

./updatePortal -fixpack 
               -installDir "$PORTAL_HOME/ 
               -fixpackDir "$PORTAL_HOME/update\fixpacks"
               -install 
               -fixpackID Fixpack1

The fix pack status shows partial installation.

Uninstall a fix pack

./updatePortal -fixpack 
               -installDir "$PORTAL_HOME/ 
               -uninstall 
               -fixpackID Fixpack1

Uninstall a fix pack and displaying fix pack details

./updatePortal -fixpack 
               -installDir "$PORTAL_HOME/ 
               -uninstall 
               -fixpackID Fixpack1 
               -fixpackDetails

View a list of installed fix packs

./updatePortal -fixpack 
               -installDir "$PORTAL_HOME/

View a list of fix packs available in the repository for the WebSphere Portal product

./updatePortal -fixpack 
               -installDir $PORTAL_HOME 
               -fixpackDir "$PORTAL_HOME/update\fixpacks"

 

Product version and history information

The portal_server_root/version directory in the installation root contains important data about WebSphere Portal and its installed components, such as the build version and build date. This information is included in the [product].product and [component].component files.

The portal_server_root/version/history directory in the installation root contains a collection of records for installed fixes and fix packs. This information is included in the [interim fixID].efixApplied, [interim fixID].efixDriver, [fix packID].ptfApplied, and [fix packID].ptfDriver files.

A driver file has useful information about the entire contents of an interim fix or fix pack. The applied file has relevant information about the fixes or fix packs that are currently applied.

Event.history files contain a detailed log about updates you have applied, either successfully or unsuccessfully. Time-stamped, detailed logs record each update process in the portal_server_root/version/log directory of the installation root.

 

Application files, logs and storage locations

This section describes the XML data files that store product information for WebSphere Portal products. By default, the document type declarations (DTDs) for these files are in the portal_server_root/version/dtd folder of the installation root directory.

This section includes:

Product information files

There are two kinds of product information files:

Version information

The following file indicates that a WebSphere Portal product is installed:

platform.websphere

This file indicates that a WebSphere Portal product is installed. An example of the file follows: 
<?xml version="1.0" encoding="UTF-8"?>
       <!DOCTYPE websphere PUBLIC "websphereId" "websphere.dtd">
       <websphere name="IBM WebSphere Portal" version="6.1"/>

The following XML files represent installed items and installation events:

product-idProduct

This file indicates the particular WebSphere Portal product that is installed. Data in the file indicates the version, build date, and build level. For example, the file might be named MP.product, which indicates that the installed product is IBM WebSphere Portal. An example of the file follows: 
<!DOCTYPE product SYSTEM "product.dtd">
       <product name="IBM WebSphere Portal Multiplatform">
         <id>MP</id>
         <version>6.1.0.0</version>
         <build-info date="06/20/2008" 
                     level="06201252"/>
       </product>

component-nameComponent

These component files indicate the presence of an installed component, which is part of the product. Data in the file indicates the component build date, build version, component name, and product version. For example, the file might be named config.component, which indicates that the WebSphere Portal configuration component is installed. An example of the file follows: 
<?xml version="1.0" encoding="UTF-8"?>
       <!DOCTYPE component PUBLIC "componentId" "component.dtd">
       <component build-date="2008-06-15" build-version="6.1.0.0" name="Config" spec-version="6.1"/>

fix-id.efix

These fix files indicate the presence of an installed interim fix.

ptf-id.ptf

These files indicate the presence of an installed fix pack.

History information

This file stores version history information:

event.history

This file lists update events that have occurred. An update event is an operation that installs or uninstalls an interim fix or fix pack. The file is sorted by the date and time of the events that are listed.

The following XML files in the portal_server_root/version/history directory describe fixes and fix packs that are currently installed. These XML files are related to installation items by the primary ID information, which is indicated by italicized text like this.

fix-id.efixDriver

Fix-driver defining information

fix-id.efixApplied

Fix installation details

ptf-id.ptfDriver

Fix pack-driver defining information

ptf-id.ptfApplied

Fix pack installation details

Logs and component backups

WebSphere Portal products use two other directories when performing update operations, for logging and backups. By default, the two directories are relative to the product version directory, as follows:

portal_server_root/version/log

Product updates log directory. WebSphere Portal products store log files to document component, interim fix, and fix pack operations and updates.

portal_server_root/version/backup

Product updates backup directory. WebSphere Portal products back up components before applying interim fixes or fix packs. If you uninstall an interim fix or fix pack, WebSphere Portal products restore the backed-up component JAR file.

Examples of log file names

Interim fix log file names are named as follows: 

timeStamp_fixId_operation.log
where these naming conventions are used:

timeStamp

YYYYMMDD_HHMMSS

For example: 20090924_211832 is 24-Sep-2009, 9:18:32 pm, GMT. All time stamps are in GMT.

fixId

Interim fix ID or fix pack ID

For example: PQ77683_WP61_iFix is an interim fix ID; WP_PTF_6101 is a fix pack ID.

operation

The operation is either install or uninstall

For example: portal_server_root/version/log/20090915_144857_PQ77683_WP61_iFix_install.log

Here are some examples of log file names for common Portal Update Installer operations:

Interim fix install and uninstall

timeStamp_fixId_operation.log

For example: portal_server_root/version/log/20090915_144857_PQ77683_WP61_iFix_install.log and portal_server_root/version/log/20090915_162140_PQ77683_WP61_iFix_uninstall.log

Interim fix component install and uninstall

timeStamp_fixId_operation.log

For example: portal_server_root/version/log/20090915_144857_PQ77683_WP61_iFix_Config_install.log and portal_server_root/version/log/20090915_162140_PQ77683_WP61_iFix_Config_uninstall.log

Fix pack install and uninstall

timeStamp_fixId_operation.log

For example: portal_server_root/version/log/20090915_144857_WP_PTF_6101_install.log and portal_server_root/version/log/20090915_162140_WP_PTF_6101_uninstall.log

Fix pack component install and uninstall

timeStamp_fixId_operation.log

For example: portal_server_root/version/log/20090915_144857_WP_PTF_6101_Config_install.log and portal_server_root/version/log/20090915_162140_WP_PTF_6101_Config_uninstall.log

Examples of backup file names

Backup JAR files are named as follows: 

timeStamp_fixId_operation_undo.jar
For example: 20090915_144857_PQ77683_WP61_iFix_Config_undo.jar

Do not delete a backup Java archive (JAR) file. You cannot remove a component update if the corresponding backup JAR file is not present.

Update processing might also use a temporary directory, if necessary. A Java property specifies this directory, as described in the next section.

Storage locations

Product information files are located relative to the WebSphere Portal product installation root. Default file paths are as follows:

Version directory

portal_server_root/version

History directory

portal_server_root/version/history

Updates log directory

portal_server_root/version/log

Updates backup directory

portal_server_root/version/backup

DTD directory

portal_server_root/version/dtd

Temporary directory

Specified by the java.io.tmpdir Java system property