IBM^® Product Update Installer README

for WebSphere Everyplace Access Version 5.x

Last update: September 22, 2005

This document describes the Product Update Installer application, which can be used to install or remove interim fixes and fix packs for selected features on supported products. This document includes examples of the command syntax used by the Update Installer and information on tracking product version and history information that the supported products maintains whenever you install or remove an interim fix or fix pack.

This document should be used as a reference for the updateProductWizard and updateProduct commands and their parameters. However, for detailed instructions on using the Product Update Installer to install an interim fix or fix pack, always refer to the README file provided with the interim fix or fix pack.

Using updateProduct command-line interface
Using the GUI Interface
Product version and history information
Trademarks

Using updateProduct command-line interface

This section describes the updateProduct 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

The symbol wea_feature_home represents the directory where a WebSphere Everyplace Access feature is installed. This varies for each feature and operating system:

Features	Windows default home	AIX default home
DB2 Everyplace	drive:\Program Files\WebSphere\DB2Everyplace	/usr/WebSphere/DB2Everyplace82
Device Manager	drive:\Program Files\WebSphere\DMS16	/usr/WebSphere/DM16
Everyplace Access Services	drive:\Program Files\WebSphere\EAS	/usr/WebSphere/EAS
Everyplace Synchronization Server	drive:\Program Files\WebSphere\IBMSyncServer	/usr/WebSphere/IBMSyncServer
Intelligent Notification Services	drive:\Program Files\WebSphere\INS	/usr/WebSphere/INS
Location Aware Services	drive:\Program Files\WebSphere\LAS	/usr/WebSphere/LAS

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 wea_feature_home/config/version/backup directory.

Command name

updateProduct.sh and updateProduct.bat

Prerequisite environment setting

The Java environment setting.

Set up the Java environment for the update installer:

Open a command line window.
Determine path to Java.
Issue appropriate command to set JAVA_HOME depending on path:

export JAVA_HOME=/usr/java14 (AIX platforms)
set JAVA_HOME=c:\Program Files\IBM\Java142 (Windows platforms only)

Download to

The default location for unpacking the update installer file is the WebSphere/WEA_updater directory. Interim fixes can be downloaded to the WebSphere/WEA_updater/fixes directory, and fix packs can be downloaded to the WebSphere/WEA_updater/fixpacks directory. The location of these directories is arbitrary. If you want to use a different directory, adjust the instructions in this section accordingly.

On Windows platforms, the pkunzip utility might not decompress the download image correctly. Use another utility (such as WinZip) to unzip the image.

The following files are associated with the update installer:

Location of extfile.jar, PuiProduct.jar: WebSphere/WEA_updater/lib (or WebSphere\WEA_updater\lib for Windows platforms)
Location of ProductUpdateInstaller.jar, updateProductWizard.sh/bat, updateProduct.sh/bat: WebSphere/WEA_updater (or WebSphere\WEA_updater\update for Windows platforms)
Location of fix Java archive (JAR) files: WebSphere/WEA_updater/fixes (or WebSphere\WEA_updater\update\fixes)
or
WebSphere/WEA_updater/fixpacks (or WebSphere\WEA_updater\update\fixpacks)

Files in ProductUpdateInstaller.zip

Files in the ProductUpdateInstaller.zip package include:

PuiProducts.xml
extfile.jar
PuiProduct.jar
ProductUpdateInstaller.jar
product_update_installer.html
updateProductWizard.sh (or updateProductWizard.bat)
updateProduct.sh (or updateProduct.bat)
puiVersionInfo.sh (or puiVersionInfo.bat)
puiHistoryInfo.sh (or puiHistoryInfo.bat)
genHistoryReport.sh (or genHistoryReport.bat)
genVersionReport.sh (or genVersionReport.bat)

Location of log and backup files

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

Syntax examples for command-line interface

Depending upon the parameters you choose, the updateProduct command:

Installs and uninstalls interim fixes and fix packs
Provides information about the update state of interim fixes and fix packs you apply

The following examples describe the syntax of various uses of the update installer. In each example, optional parameters are enclosed by brackets ([ ]). Values that you supply appear in italicized font. Choices are denoted by the pipe symbol (|).

Help

updateProduct  -help | -? | /help | -usage

Fix processing

updateProduct -installDir "fully qualified WEA feature installation directory"
             -fix
             -fixDir "fully qualified fix directory" 
             -install | -uninstall | uninstallAll
             -fixes space-delimited list of fixes
             -fixJars space-delimited list of fix JAR files
            [ -configProperties "property file name and path" ]
            [-fixDetails]
            [-prereqOverride]

View applied fixes

updateProduct -fix 
             -installDir "fully qualified WEA feature installation directory"

View available fixes

updateProduct -fix 
             -installDir "fully qualified WEA feature installation directory"
             -fixDir "fully qualified fix directory"

Fix pack processing

updateProduct -installDir "fully qualified WEA feature installation directory"
             -fixpack
             -fixpackDir "fully qualified fix pack directory" 
             -install | -uninstall
             -fixPackID fix pack ID
             [-configProperties "property file name and path"]
             [-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

updateProduct -fixpack 
             -installDir "fully qualified WEA feature installation directory"

View available fix packs

updateProduct -fixpack 
             -installDir "fully qualified WEA feature installation directory"
             -fixpackDir "fully qualified fix pack directory"

Parameters

Use the following parameters for the updateProduct command:

-?

Shows command usage.

/?

Shows command usage on Windows platforms only. Not supported for AIX-based platforms.

-configProperties <propertyFile>.properties

Specifies an externally supplied properties file containing WebSphere Application Server properties and values. Using a properties file enables you to set property values that will be used during the installation of the interim fix or fix pack. You can also share the properties file across multiple installations of WebSphere Everyplace Access, where appropriate for your environment. A default properties file is included with the updater tool called puiconfig.properties. The values must be updated prior to running the updater tool.

You can use the following properties in this file:

Any property in the puiconfig.properties file

When specifying properties in a file, the following conventions should be observed:

Values identified for properties should not have trailing spaces.
Do not enclose values in quotation marks.
When typing directories, use a forward slash (/) instead of a backward slash (\), regardless of the operating system used.

-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: Specifies the fully qualified directory where you download interim fixes.

-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.

-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 Everyplace Access 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: ESS_PTF_5001
fix pack JAR file name: ESS_PTF_5001.jar
fix pack ZIP file name: ESS_PTF_5001.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 type.

-installDir

Specifies the fully qualified installation root of the feature being updated.

-prereqOverride

Interim fix only: Overrides any installation and uninstallation prerequisite checking. The update installer does not log missing prerequisites.

-uninstall

Specifies to uninstall the identified fix.

-uninstallAll

Interim fix only: Specifies to uninstall all applied interim fixes.

-usage

Shows command usage.

Examples

The following examples are based on Everyplace Access Services and assume that:

The installation root is the C:\Program Files\WebSphere\EAS directory.
The fix repository is the C:\Program Files\WebSphere\WEA_updater\fixes directory.
The fix pack repository is the C:\Program Files\WebSphere\WEA_updater\fixpacks directory.

Examples in this section include:

Getting help for the command
Installing interim fixes
Uninstalling interim fixes
Viewing information about interim fixes
Installing fix packs
Uninstalling fix packs
Viewing information about fix packs

Most of the examples are split into more than one line, for clarity.

Getting help for the command

To get help for the updateProduct command:

C:\Program Files\WebSphere\WEA_updater> updateProduct -help

Installing interim fixes

To install a collection of interim fixes:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install
          -fixes Fix1 Fix2

To install a collection of interim fixes and display interim fix details:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install 
          -fixes Fix1 Fix2 
          -fixDetails

To install a collection of interim fixes and use a separate properties file:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install
          -fixes Fix1 Fix2 
          -configProperties .\myProp.properties

To install a collection of fixes and override prerequisite checking:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install
          -fixes Fix1 Fix2 
          -prereqOverride

To install interim fixes from a Java archive (JAR) file:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install
          -fixJar Fix1

To install interim fixes from a Java archive (JAR) file and display interim fix details:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install 
          -fixJar Fix1 
          -fixDetails

To install interim fixes from a Java archive (JAR) file and override prerequisite checking:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -install 
          -fixJar Fix1 
          -fixDetails

Uninstalling interim fixes

To uninstall a collection of interim fixes:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixes Fix1 Fix2

To uninstall a collection of interim fixes and display interim fix details:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixes Fix1 Fix2 
          -fixDetails

To uninstall a collection of interim fixes and use a separate properties file:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixes Fix1 Fix2 
          -configProperties .\myProp.properties

To uninstall a collection of interim fixes and override prerequisite checking:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixes Fix1 Fix2 
          -prereqOverride

To uninstall interim fixes in a Java archive (JAR) file:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixJar Fix1

To uninstall interim fixes in a Java archive (JAR) file and display interim fix details:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixJar Fix1 
          -fixDetails

To uninstall interim fixes in a Java archive (JAR) file and override prerequisite checking:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes" 
          -uninstall 
          -fixJar Fix1 
          -fixDetails

Viewing information about interim fixes

To view a list of installed interim fixes:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS"

To view a list of interim fixes available in the repository:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fix 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixDir "C:\Program Files\WebSphere\WEA_updater\fixes"

Installing fix packs

To install a fix pack:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixpackDir "C:\Program Files\WebSphere\WEA_updater\fixpacks" 
          -install
          -fixpackID Fixpack1

To install a fix pack, and display fix pack details:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixpackDir "C:\Program Files\WebSphere\WEA_updater\fixpacks"
          -install 
          -fixpackID Fixpack1 
          -fixpackDetails

To install a fix pack and use a separate properties file:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixpackDir "C:\Program Files\WebSphere\WEA_updater\fixpacks"
          -install 
          -fixpackID Fixpack1 
          -configProperties .\myProp.properties

Uninstalling fix packs

To uninstall a fix pack:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -uninstall 
          -fixpackID Fixpack1

To uninstall a fix pack, and display fix pack details:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -uninstall 
          -fixpackID Fixpack1 
          -fixpackDetails

To uninstall a fix pack, and use a separate properties file:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -uninstall 
          -fixpackID Fixpack1 
          -configProperties .\myProp.properties

Viewing information about fix packs

To view a list of installed fix packs:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS"

To view a list of fix packs available in the repository for WebSphere Everyplace Access:

C:\Program Files\WebSphere\WEA_updater> updateProduct -fixpack 
          -installDir "C:\Program Files\WebSphere\EAS" 
          -fixpackDir "C:\Program Files\WebSphere\WEA_updater\fixpacks"

Using the GUI Interface

Command name

updateProductWizard.sh and updateProductWizard.bat

Prerequisite environment setting

The Java environment setting.

Set up the Java environment for the update installer:

Open a command line window.
Determine path to Java.
Issue appropriate command to set JAVA_HOME depending on path:

export JAVA_HOME=/usr/java14 (AIX platforms)
set JAVA_HOME=c:\Program Files\IBM\Java142 (Windows platforms only)

Product version and history information

The wea_feature_home/config/version directory in the installation directory for each feature contains important data about the WebSphere Everyplace Access features, such as the build version and build date. This information is included in [feature].feature file.

The wea_feature_home/config/version/history directory in the installation directory for each feature contains a collection of records for installed fixes fix packs. This information is included in [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 wea_feature_home/config/version/log directory of the installation directory for each feature.

This topic describes the XML data files that store product information for WebSphere Everyplace Access features. By default, the document type declarations (DTDs) for these files are in the wea_feature_home/config/version/dtd folder of the installation directory for each feature. See the Storage locations section for more information.

This topic includes:

A list of product information files and file locations
A description of logs and component backups
A list of storage locations

Product information files

There are two kinds of product information files:

XML files in the wea_feature_home/config/version directory that store version information
XML files in the wea_feature_home/config/version/history directory

XML files in the wea_feature_home/config/version directory that store version information

The following file indicates that a WebSphere Everyplace Access feature is installed:

platform.websphere

This file indicates that a WebSphere Everyplace Access 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 Everyplace Access" version="5.0"/>

The following XML files represent installed items and installation events:

<component-name>Component

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 the EAS.config.component file, which indicates that the Everyplace Access Services 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="2004-08-27" build-version="5.0.0.0" name="EAS.config" spec-version="5.0"/>

<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.

XML files in the wea_feature_home/config/version/history directory

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 wea_feature_home/config/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 shown here by <angle brackets> and italicized text.

<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 Everyplace Access 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:

wea_feature_home/config/version/log: Product updates log directory.
WebSphere Everyplace Access products store log files to document component, interim fix, and fix pack operations and updates.
wea_feature_home/config/version/backup: Product updates backup directory
WebSphere Everyplace Access products back up components before applying interim fixes or fix packs. If you uninstall an interim fix or fix pack, WebSphere Everyplace Access products restore the backed-up component JAR file.

File naming convention

Time stamp

YYYYMMDD_HHMMSS

For example: 20020924_211832 is 24-Sep-2002, 9:18:32 pm

ID

Interim fix ID or fix pack ID

For example: PQ77683_EAS50_iFix is an interim fix ID; EAS_PTF_5001 is a fix pack ID.

Operation

install | uninstall

Interim fix log file names

<timeStamp>_<fixId>_<operation>.log

For example: wea_feature_home/config/version/log/20040915_144857_PQ77683_EAS50_iFix_install.log and wea_feature_home/config/version/log/20040915_162140_PQ77683_EAS50_iFix_uninstall.log

Interim fix component log file names

<timeStamp>_<fixId>_<componentName>_<operation>Log

For example: wea_feature_home/config/version/log/20040915_144857_PQ77683_EAS50_iFix_Config_install.log and wea_feature_home/config/version/log/20040915_162140_PQ77683_EAS50_iFix_Config_uninstall.log

Fix pack log file names

<timeStamp>_<ptfId>_<operation>Log

For example: wea_feature_home/config/version/log/20040915_144857_EAS_PTF_5001_install.log and wea_feature_home/config/version/log/20040915_162140_EAS_PTF_5001_uninstall.log

Interim fix component log file names

<timeStamp>_<ptfId>_<componentName>_<operation>Log

For example: wea_feature_home/config/version/log/20040915_144857_EAS_PTF_5001_Config_install.log and wea_feature_home/config/version/log/20040915_162140_EAS_PTF_5001_Config_uninstall.log

Backup JAR file names

<timeStamp>_<ptfId>_<componentName>_undo.jar or <timeStamp>_<fixId>_<componentName>_undo.jar

For example: 20030915_144857_PQ77683_EAS50_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 Everyplace Access feature installation root.

Default file paths and Java properties that set them are:

Version directory: wea_feature_home/config/version
History directory: wea_feature_home/config/version/history
Updates log directory: wea_feature_home/config/version/log
Updates backup directory: wea_feature_home/config/version/backup
DTD directory: wea_feature_home/config/version/dtd
Temporary directory: Specified by the java.io.tmpdir Java system property

Trademarks

AIX, DB2, Everyplace, IBM, Tivoli, and WebSphere are registered trademarks of the IBM Corporation in the United States, other countries, or both.

Lotus and Domino are trademarks or registered trademarks of Lotus Development Corporation and/or IBM Corporation in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

JDBC is a trademark of Sun Microsystems, Inc. in the United States, other countries, or both.

Microsoft, Active Directory, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

This product includes software developed by the ExoLab Project (http://www.exolab.org/).

This product includes software developed by the Java Apache Project (http://java.apache.org/).

Other company, product, and service names may be trademarks or service marks of others.

(c) Copyright International Business Machines Corporation 1994, 2004. All rights reserved.
U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM® Product Update Installer README

IBM^® Product Update Installer README