IBM Integrated Solutions Console Update Installer Readme

About this document

This document provides instructions for using the Update Installer for Integrated Solutions Console. Use the Update Installer to install a fix on an existing console runtime installation. You download the separate fix package from the Web site. Each fix package includes a release notes document that provides a complete description of that fix, the versions of the console runtime to which the fix can be applied, and the changes included in the fix.

This document contains the following sections:

What the Update Installer does

The Update Installer applies a fix to the Integrated Solutions Console runtime. In production environments, a product that uses Integrated Solutions Console for its administrative interface embeds the console runtime in the product installation. In development environments, you use the installation program for the Integrated Solutions Console Toolkit to install the runtime.

You can use the Update Installer to install and remove three types of updates:

Guidelines for using the Update Installer

Adhere to the following guidelines when using the Update Installer:

Preparing the Update Installer

  1. Verify that you have a copy of the GNU tar 1.13 or later.
  2. Verify that a 32-bit Java Runtime Environment 1.4.2 is on the system. Do not use a 64-bit Java Runtime Environment.
  3. Verify that the JAVA_HOME environment variable is set to point to the root directory for the 32-bit Java Runtime Environment 1.4.2 installation. Ensure that the JAVA_HOME environment variable does not point to the Java Runtime Environment for the application server that Integrated Solutions Console runtime uses.
  4. Download the Update Installer from the Common Systems Administration (CSA) Web site. Follow the links to the Integrated Solutions Console Support page.
  5. Make a directory (for example, IscFix) to contain the files that will be extracted from the download file or files.
  6. At a system command prompt, change to the directory that contains the downloaded files. For Windows systems that use Cygwin, open a DOS command window instead of using the Cygwin bash shell window.
  7. Extract the TAR file for the Update Installer. To extract the TAR file, run one of the following commands:

    where:

  8. Change to the root directory of the extracted Update Installer and run the following command:
    chmod -R 777 * 

The following table lists the files and directories that are created in the root directory:

Resource Description
readme_en.html This document. If translated versions of this file are available, the file name suffix is _cc, where cc is the Java locale, such as de for German.
info.css Style sheet for formatting this readme.
ISCUpdateInstaller.jar The Update Installer code.
iui.properties Identifies the version of the Update Installer.
updateISC.bat The script for running the Update Installer on Windows systems.
updateISC.sh The script for running the Update Installer on AIX, Linux, Solaris, and i5/OS systems.
dtd The directory that contains the Document Type Definition (DTD) that is used to validate the fix descriptor (an XML file named fix_name.xml) that is packaged with the fix. The DTD file name is ISCFixNN.dtd, where NN is the version, such as 10. This directory might contain multiple versions of the DTD.
PUI The directory that contains the code used to update Integrated Solutions Console and additional software that the console installation program installs.
WUI The directory that contains the code used to update the application server that the console installation program installs.

Downloading a fix

To download a fix for the console runtime:

  1. Use your browser to open the CSA Web site.
  2. Follow the links to the Integrated Solutions Console Support page.
  3. Download each fix that you need. For each fix, there is a separate package for each operating system.
  4. Extract the ZIP file for the fix into a directory. That directory is the one you will specify on the -fixDIR parameter for the installation command. The table below lists the files that are created by the extraction.
  5. Read the release notes file in the root directory of the extracted ZIP file.
Resource Description
release_notes_fixname_en.html A document that describes the changes included in the fix, the versions of the console runtime to which the fix can be applied, and other information specific to the fix. In the file name, fixname matches the name of the ZIP file for the fix download. If translated versions of the file are available, the file name suffix is _cc, where cc is the Java locale, such as de for German.

Note: The release notes for the V6.0.1 refresh are not included in the download package. Instead, this document is available from the location where the V6.0.1 refresh is obtained. For more information, visit the downloads page for Integrated Solutions Console at http://w3.rchland.ibm.com/projects/CSA/isc/downloads/.

fix_name.xml An XML file that describes and controls the installation of each change included in the fix. The Update Installer uses this file as a script for applying the fix. Never modify or move this file.
fix_file.jar An archive for the changes to be applied to the Integrated Solutions Console runtime installation. One or more archives may be included.

Displaying version and help information

To display the version of the Update Installer, the version of the other installers that the Update Installer uses, and the version of the console subcomponents, issue the following command: updateISC -version -installDIR "isc_runtime_root"

The following example shows the output of this command. The version information displayed is only an example and does not necessarily represent the version information that is displayed for your fix.

    Version information for
     IBM Integrated Solutions Console Update Installer           6.0
    Fix installers:
     IBM WebSphere Application Server Update Installer           6.0.1.1
     Embedded Version of IBM WebSphere Portal Update Installer   20050527_1440
    Dependent products:
     IBM Integrated Solutions Console                            6.0.0.0
     Embedded Version of IBM WebSphere Application Server        WAS 6.0.0.2
     Embedded Version of IBM WebSphere Portal                    5.1.0.1
     WebSphere Studio Workbench Help Server                      3.0.1.0
	

You can also issue the command updateISC -version, which displays less information than shown above.

To display help for the command syntax, issue the following command: updateISC -help. You can also use the parameter -?, -usage, /help, or /? to display the help.

Note: If you need to embed the Update Installer in your product installer, see the Version 6.0 Developer Information Center for an example of how to call the console runtime installer from Java code and how to monitor the installer return codes. That information also applies to the Update Installer. In the Information Center, see the subsection"Writing code to install the runtime" in the topic "Embedding the installation".

Installing a fix

To install a console runtime fix, perform the following steps:

  1. Go to the system where the Integrated Solutions Console runtime is installed.

  2. Log in as an administrator on Windows systems or as root on AIX, Solaris, and Linux systems. For i5/OS systems, log in with a user profile that has ALLOBJ and JOBCTL authorities.

  3. Ensure that the system contains a copy of the Update Installer and each fix to be applied.

  4. Change to the directory where the Update Installer is extracted.

  5. If the Integrated Solutions Console runtime is running in a federated WebSphere Application Server Network Deployment node, remove the node from the federation before you install the fix.

  6. To start the Update Installer, issue one of the following commands on a single line:

    Note: If you are using DB2, LDAP, or WebSphere Member Manager for your user registry, you must add additional parameters to supply the administrative credentials. See Description of updateISC command line parameters for assistance with the values needed for this command.

  7. Wait until the Update Installer finishes. When embedding the fix installation in a product installer, wait for the Update Installer return code. If the installation is successful, the return code is 0. Any other value indicates that the installation was not successful.

  8. (Optional) Delete the extracted fix files. The fix files will be required to uninstall a fix.

  9. (Optional) Delete the Update Installer. If possible, leave a copy of the Update Installer on the system so that it will be available for removing fixes.

  10. If the Integrated Solutions Console runtime was running in a federated WebSphere Application Server Network Deployment node, add the node back to the federation.

  11. If the Integrated Solutions Console runtime was running on an existing WebSphere Application Server, you must upgrade the Java Software Developer Kit (SDK) to version SR7 (Windows, Linux, and AIX) or SR12 (Solaris). The Java SDK upgrade is available from the IBM WebSphere support Web site.

Verifying a fix installation

If the installation was successful and you applied a fix pack or a cumulative fix, the version information has been updated. To display the version of the console, issue the following command:

updateISC -version -installDIR "isc_runtime_root"
In the command response, the value for IBM Integrated Solutions Console should match the version of the most recent fix pack or cumulative fix that you applied.

See Displaying version and help information for more information.

Uninstalling a fix

To uninstall a console runtime fix, perform the following steps:

  1. Go to the system where the Integrated Solutions Console runtime is installed.

  2. Log in as an administrator on Windows systems or as root on AIX, Solaris, and Linux systems. For i5/OS systems, log in with a user profile that has ALLOBJ and JOBCTL authorities.

  3. Ensure that the system contains a copy of the Update Installer and each fix to be removed.

  4. Change to the directory that contains the Update Installer.

  5. If the Integrated Solutions Console runtime is running in a federated WebSphere Application Server Network Deployment node, remove the node from the federation before you remove the fix.

  6. For Windows systems: if the system is configured to restart the console whenever the system restarts, use the Windows Services control to stop the console service and stop the console help service.

  7. To start the fix removal, issue one of the following commands:

    Note: If you are using DB2, LDAP, or WebSphere Member Manager for your user registry, you must add additional parameters to supply the administrative credentials. See Description of updateISC command line parameters for assistance with the values needed for this command.

  8. Wait until the Update Installer finishes. When embedding the fix removal in an uninstall program for product updates, wait for the Update Installer return code. If the removal is successful, the return code is 0. Any other value indicates that the installation was not successful.

  9. Regardless of whether you are using a separate WebSphere Application Server or an embedded one, you must reinstall the WebSphere Application Server fixes that Integrated Solutions Console, Version 6.0 requires. For a list of the required WebSphere Application Server fixes, see the Hardware and software requirements for Integrated Solutions Console Version 6.0 at http://w3.rchland.ibm.com/projects/CSA/isc/downloads/60/swhwreq.html.

Description of updateISC command line parameters

This section provides a full description of each of the command line parametes for updateISC.

Parameter Description
-fixDIR indicates the root directory where the fix or fixes are extracted. If you do not specify this parameter, the fixes must be in the directory where the Update Installer is extracted.

If the directory name contains spaces, the entire path name should be enclosed in double quotes. Do not end the path name with a slash, especially when enclosed in quotes. If the directory name includes the tilde character ( ~ ), you cannot enclose the string in single or double quotes.

-fixList provides a space-delimited list of fix names to install or remove. Each fix name is case-sensitive and is the file name (without the file extension) of the fix download package. For example, if the fix package is ISC5.0.2.1.zip, specify ISC5.0.2.1. If there is only one fix, specify a single fix name.

To install a list of fixes, specify the fixes in the order of their release.

To remove a list of fixes, fixes must be removed in the reverse of the order in which they were applied. For example, if fixes A, B, and C were installed in the order A, B, and C, then specify -fixList C B A.

-help displays help information for the command syntax. As an alternative, you can use -?, /help, or /?.
-install installs the fixes indicated by the -fixList parameter.
-installDIR indicates the root directory of the Integrated Solutions Console runtime. When embedding the update in a product installer, prompt the user for this information or retrieve it from data that your product installer saved during the original installation.

If the directory name contains spaces, the entire path name should be enclosed in double quotes. Do not end the path name with a slash, especially when enclosed in quotes. If the directory name includes the tilde character ( ~ ), you cannot enclose the string in single or double quotes.

-ISCAdmin indicates the administrator user ID for Integrated Solutions Console. If the installation uses the embedded application server, this user ID is the same as the one for the application server administrator.
-ISCAdminPw indicates the password for the Integrated Solutions Consoled administrator.
-norestart specifies that the servers are not restarted after the update has been installed or removed. This parameter is optional.
-stopServers specifies that the servers should be stopped before the updates are installed or removed. If servers are running when updateISC is issued, this parameter stops the servers so that the update can continue. For embedded WebSphere Application Server, ISC_Portal, the console help server, and server1 are stopped. For a separate application server, only ISC_Portal and the console help server are stopped. The update can continue while server1 is running. As an alternative, you can stop the servers manually and then issue this command without the -stopServers parameter. See the Developer Information Center for instructions for stopping and starting the servers. After the update has been installed or removed, the servers are restarted unless the -norestart parameter was specified on updateISC.

If -stopServers is omitted and the servers are running when updateISC is issued, then the servers are not stopped and the command fails.

-uninstall uninstalls the fixes indicated by the -fixList parameter.
-version displays the version of the Update Installer, the version of the other installers that the Update Installer uses, and the version of the console subcomponents. See Displaying version and help information for example output.
-wasAdmin indicates the administrator user ID for WebSphere Application Server. If the installation uses the embedded application server, this user ID is the same as the one for Integrated Solutions Console.
-wasAdminPw indicates the password for the WebSphere Application Server administrator.
-DB2Admin indicates the administrator user ID for DB2. Use this parameter only if you are using DB2 for your user registry.
-DB2AdminPw indicates the password for DB2. Use this parameter only if you are using DB2 for your user registry.
-LDAPAdmin indicates the administrator user ID for LDAP. Use this parameter only if you are using LDAP for your user registry.
-LDAPAdminPw indicates the password for LDAP. Use this parameter only if you are using LDAP for your user registry.
-WMMAdmin indicates the administrator user ID for WebSphere Member Manager. Use this parameter only if you are using WebSphere Member Manager for your user registry.
-WMMAdminPw indicates the password for WebSphere Member Manager. Use this parameter only if you are using WebSphere Member Manager for your user registry.

Notices

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

Intel is a trademark of Intel 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.

Linux is a registered trademark of Linus Torvalds.

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

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

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

(c) Copyright IBM Corporation 2004, 2005. All Rights Reserved.

U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.