Install new features after applying fix packs (patch command)

The patch command is the command-line interface to the IBM WebSphere Application Server patcher application. The patcher utility corrects faulty history information that can occur when installing new Application Client product features, after installing interim fixes and fix packs. Installing features for other WebSphere Application Server products does not cause a problem.

However, installing new Application Client features can cause related components to regress. The patcher determines regressed components and corrects their history information.

There are three known scenarios for the regression problem:

Scenario 1 - Installing features after installing Fix Pack 1

  1. Install the WebSphere Application Server Application Clients, Version 5 product.

  2. Install Fix Pack 1 to bring the WebSphere Application Server Application Clients product to the Version 5.0.1 level.

  3. Use the Application Clients Version 5 CD-ROM to install an additional feature.

To correct scenario 1:

  1. List regressed components:

    patch $WAS_HOME .

  2. Disable regressed components:

    patch $WAS_HOME -apply .

  3. Install Fix Pack 1 for the Application Clients product.

Scenario 2 - Installing features after installing Fix Pack 1 and Fix Pack 2

  1. Install the WebSphere Application Server Application Clients Version 5 product.

  2. Install Fix Pack 1 to bring the WebSphere Application Server Application Clients product to the Version 5.0.1 level.

  3. Install Fix Pack 2 to bring the WebSphere Application Server Application Clients product to the Version 5.0.2 level.

  4. Use the Application Clients Version 5 CD-ROM to install an additional feature.

Scenario 3 - Installing features after installing Fix Pack 2 only

  1. Install the WebSphere Application Server Application Clients product, Version 5.

  2. Install Fix Pack 2 to bring the WebSphere Application Server Application Clients product to the Version 5.0.2 level.

  3. Use the Application Clients Version 5 CD-ROM to install an additional feature.

To correct either scenario 2 or scenario 3:

  1. List regressed components:

    patch $WAS_HOME .

  2. Disable regressed components:

    patch $WAS_HOME
         -apply
    

  3. Install Fix Pack 2 for the Application Clients product.

Note:

Stop all Java processes on the machine that use the IBM Developer Kit that WebSphere Application Server Application Clients provides. Before using the patcher, stop all Java processes on the machine that use the IBM Developer Kit that WebSphere Application Server Application Clients provides to support the Java 2 SDK, Standard Edition on your operating system platform, such as the IBM Developer Kit for AIX, Java Technology Edition. Stop all Java processes, if necessary. If you use the patcher while a WebSphere Application Server product-related Java process runs, IBM does not guarantee that the product can continue to run successfully or without error.

Remove the MQ tray icon if present. On a Windows platform, remove the MQ tray icon if it is present. The MQ tray icon in the lower right corner indicates that a MQ process (amqmtbrn.exe) is running. Right click the tray icon and click Hide to remove it.

Do not launch multiple copies of the patcher at one time. Do not launch the patcher command concurrently with itself. Perform simultaneous updates might cause a failed or faulty installation.Installation roots

The variable $WAS_HOME represents the root directory for WebSphere Application Server Application Clients. By default, the root directory name varies per product and operating system:

  • WebSphere Application Server Application Clients products:

    • AIX platforms, /usr/WebSphere/AppClient

    • Other UNIX and Linux platforms, /opt/WebSphere/AppClient

    • Windows platforms, drive\Program Files\WebSphere\AppClient
Command name

patch.sh and patch.bat , command-line interfaces to the patcher.jar file.Prerequisite environment settings

 

Set the environment variable or issue the appropriate command script, from the /bin directory of the installation root:

  • . $WAS_HOME/bin/setupCmdLine.sh (source the command on UNIX platforms)

  • source $WAS_HOME/bin/setupCmdLine.sh (source the command on Linux platforms )

  • $WAS_HOME\bin\setupCmdLine.bat (Windows platforms only)

  • . $WAS_HOME/bin/setupClient.sh (source the command for the Application Server client)

  • source $WAS_HOME/bin/setupClient.sh (Linux platforms only)

  • $WAS_HOME\bin\setupClient.bat (Windows platforms only)

 

UPDATE_HOME environmental variable on Windows platforms

Set the variable to the directory where you extracted Fix Pack 2.

For example, SET UPDATE_HOME=c:\shipped\update .

Download from

Download the patcher as part of the updateInstaller.zip from the WebSphere Application Server Support page, or as part of each fix pack ZIP file package.Download to

The default location for unpacking the patcher is the $WAS_HOME/update directory. Copy the files into the directory containing Version 5.0.2.x of the update installer program. The installer.jar JAR file is required.

On Windows platforms, set the UPDATE_HOME variable to point to the directory containing the 5.0.2.x Version of the update installer program. For example, SET UPDATE_HOME=c:\Program Files\WebSphere\AppClient\update .Files in the patcher utility

The patcher utility is packaged as the following files:

  • patcher.jar

  • patch.bat

  • patch.sh

  • patch.txt (similar to this description)
Syntax and parameters

Syntax

patch [ $WAS_HOME ]
      [ -apply       ]
      [ -verbose     ]
      [ -usage       ]
      [ -help        ]
      [ -revision    ]

      [ -custom propertyFileName  ]

      [ -disableComponents                ]
      [ -enableComponent componentName  ]
      [ -enableComponents                 ]
      [ -disableComponent componentName ]

      [ -disableFixes               ]
      [ -enableFix fixId          ]
      [ -disableFix fixId         ]

      [ -disableFixPacks            ]
      [ -enableFixPack fixPackId  ]
      [ -disableFixPack fixPackId ]

Typically, the patch utility is invoked once without the -apply argument to display regressions. Then, if needed, the patch utility is invoked a second time with the -apply argument to perform corrections on history information.

The patcher scans the target installation directories to verify the installation, then scans installed components and installed updates (fix packs and interim fixes) for regressions. An update is regressed when the component build date is earlier than the update build date.Parameters

Use the following parameters for the patch command:

 

-apply

Removes all regressed component updates and refreshes the update history (event.history) . If the patcher removes all component updates of an interim fix or fix pack, the utility also removes the interim fix or fix pack.

 

-verbose

Provides verbose output.

 

-usage

Displays usage information and then exits.

 

-help

Displays help information and then exits.

 

-revision

Displays revision history and then exits.

 

-custom <propertyFileName>

Specifies a properties file containing customization directives. One can also specify customizations on the command line.

Specify -custom to use a properties file to force on or off component regressions and to skip particular updates, regardless of actual detected regressions.

The properties file supports these properties:

enableComponents=true
    componentName=disable
    disableComponents=true
    componentName=enable

		 disableFixes=true
    fixId=enableFix
    fixId=disableFix

		 disableFixPacks=true
    fixPackId=enableFixPack
    fixPackId=disableFixPack

 

-disableComponents

Specifies component customizations.

 

-enableComponents

Specifies component customizations.

 

<componentName>= disable|enable

Specifies component customizations.

Using the patcher to update components

Use the patcher to enable or disable single components, or all components.

To enable all components but disable those components you specify, use these parameters: enableComponents=true and componentName=disable .

To disable all components but enable those components you specify, use these parameters: -disableComponents=true and componentName=enable .

If you use the disableComponents parameter, specify some enablement. Disabling all components halts all processing, and returns a success return code (0).

Specify both enableComponents and disableComponents produces an error.

 

-disableFixes

Disables all interim fixes.

 

<fixId>=disableFix|enableFix

Specifies customizations to single interim fixes.

Updates for fix packs and interim fixes

You can disable single interim fixes or all interim fixes. One can enable single interim fixes.

 

-disableFixPacks

Disables all fix packs.

 

<fixPackId>=disableFixPack|enableFixPack

Specifies customizations to single fix packs.

Updates for fix packs

One can disable single fix packs or all fix packs. One can enable single fix packs.

 

Return codes

Patcher return codes are:

0 SUCCESS
-1 PARSE_ERROR
-2 BAD_CUSTOM
-3 BAD_TARGET
-4 RUN_ERROR



Installing application clients

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.

 

AIX is a trademark of the IBM Corporation in the United States, other countries, or both.