|
| |
| Sun Java Communications Suite 5 Upgrade Guide | |
Chapter 7
Upgrading Instant MessagingThis chapter describes how to upgrade Instant Messaging to Communications Suite 5: Sun Java System Instant Messaging 7.2. The chapter provides an overview of upgrade considerations for the different upgrade paths supported by Communications Suite 5. The chapter covers upgrades on both the Solaris and Linux operating systems:
Overview of Instant Messaging UpgradesThis section describes the following general aspects of Instant Messaging that impact upgrade:
About Communications Suite 5 Instant Messaging
Communications Suite 5 Instant Messaging represents a minor release with respect to 2005Q4. The major new functionality in Communications Suite 5 is support for HTML-based clients, in addition to the Java-based Messenger client. This support requires a new httpbind gateway feature that requires post-upgrade configuration to enable. The gateway was introduced in the 2006Q1 IFR release.
In addition, Instant Messaging has a private interface change that affects upgrade: the Multiplexor protocol used between the Instant Messaging Multiplexor and server has changed. This version also includes some new administrative interfaces.
Communications Suite 5 Instant Messaging represents only a bug-fix update with respect to the Interim Feature Release (2006Q1) that followed 2005Q4.
Instant Messaging Upgrade Roadmap
Table 7-1 shows the supported Instant Messaging upgrade paths. The table applies to both Solaris and Linux operating systems.
Instant Messaging Data
The following table shows the type of data that could be impacted by an upgrade of Instant Messaging software.
Instant Messaging Upgrade Strategy
Your strategy for upgrading Instant Messaging depends on the many considerations discussed in Chapter 1, "Planning for Upgrades": upgrade path, dependencies between Communications Suite components, selective upgrade versus upgrade all, multi-instance deployments, and so forth.
This section is to particularize that general discussion to Instant Messaging by presenting issues that might influence your Instant Messaging upgrade plan.
Compatibility Issues
Instant Messaging 7.2 includes a new public interface (the httpbind gateway), however this represents a new feature that does not affect backward compatibility with earlier versions.
However, the change in Multiplexor protocol, a private interface, means that while a 7.2 Instant Messaging server can communicate with a 2005Q4 Multiplexor component, a 7.2 Instant Messaging Multiplexor component is unable to communicate with a 2005Q4 server. This limitation, impacts the order in which components need to be upgraded.
If you intend to use a redirect server in your deployment, you must also upgrade the client (Instant Messenger).
Instant Messaging Dependencies
Instant Messaging dependencies on other Communications Suite components can impact the procedure for upgrading and re-configuring Instant Messaging software. Changes in Instant Messaging interfaces or functions, for example, could require upgraded version of components upon which Instant Messaging depends. The need to upgrade such components depends upon the specific upgrade path.
Instant Messaging has dependencies on the following Communications Suite components:
- Shared components. Instant Messaging has dependencies on specific Communications Suite shared components (see Table 1-6).
- Web Container. Instant Messaging clients depend upon web container services, which can be provided either by Communications Suite Web Server or Communications Suite Application Server.
- Access Manager (optional). For software solutions that support single user sign-on for web-based services, Instant Messaging can be configured to use Access Manager single sign-on capability.
- Directory Server (optional). Instant Messaging can be configured to store and access user data in Directory Server. As a result, Instant Messaging upgrades might require extensions of directory schema.
Web Container Upgrade Scenarios
Instant Messaging client resources can be deployed in a web container provided by either Web Server or Application Server. As a result, the upgrade of Instant Messaging to 7.2 can be complicated by the possibility of also having upgraded the web container in which it is deployed. In this regard, there are a number of web container upgrade scenarios possible, enumerated in the following table.
You must be careful when upgrading Instant Messaging (for example when re-deploying Instant Messaging resources) to provide values appropriate to the upgrade scenario in Table 7-3 that applies, especially when there is a major version upgrade of the web container.
Upgrading Instant Messaging from Java Enterprise System 2005Q4 or 2006Q1This section includes the following information about upgrading Instant Messaging from Communications Suite 2005Q4 to Communications Suite 5. The section covers the following topics:
Introduction
When upgrading 2005Q4 or 2006Q1 Instant Messaging to 7.2, consider the following aspects of the upgrade process:
- General Upgrade Approach. The upgrade is performed by applying patches to the previous version, and explicitly re-deploying client resources. There is no re-configuration of Instant Messaging required, except to enable the httpbind gateway feature.
- Upgrade Dependencies. While Instant Messaging has dependencies on a number of Communications Suite shared components (see Table 1-6), Instant Messaging 7.2 requires only that IM-SDK be upgraded to Communications Suite 5.
In addition, Instant Messaging 7.2 is dependent on a web container and optionally dependent on Access Manager and Directory Server, as described in Instant Messaging Dependencies. These are soft upgrade dependencies; upgrade of these components is optional with respect to upgrade of Instant Messaging to 7.2.
- Backward Compatibility. Instant Messaging 7.2 is backwardly compatible with the 2005Q4 and 2006Q1 versions.
- Upgrade Rollback. Rollback of the 7.2 upgrade to 2005Q4 or 2006Q1 is achieved on Solaris platforms by removing the patches applied during the upgrade and redeploying the client resources to the web container.
- Platform Issues. The general approach for upgrading Instant Messaging is the same on both Solaris and Linux operating systems, however the patching technologies are different. The upgrade process therefore includes platform-specific procedures.
2005Q4 and 2006Q1 Instant Messaging Upgrade
This section describes how to perform an upgrade of Instant Messaging from Communications Suite 2005Q4 or 2006Q1 to Communications Suite 5 on both the Solaris and Linux platform. Where a topic depends on platform-specific procedures, the topic will indicate the operating system to which it applies. The section covers the following topics:
Pre-Upgrade Tasks
Before you upgrade Instant Messaging you should perform the tasks described below.
Verify Current Version Information
You can verify the current version of Instant Messaging by entering the following command:
InstantMessaging-base/sbin/imadmin version
Upgrade Instant Messaging Dependencies
It is generally recommended that all Communications Suite components on a computer system (and in a computing environment) be upgraded to Communications Suite 5. However, Instant Messaging has a hard upgrade dependency only on the IM-SDK shared component.
If you choose to upgrade all Instant Messaging dependencies, they should be upgraded in the following order, all before you upgrade Instant Messaging. You can skip any that might already have been upgraded.
- Shared Components. Instructions for updating all Communications Suite shared components to Communications Suite 5 are provided in Chapter 2, "Upgrading Communications Suite Shared Components". You must upgrade shared components before upgrading Instant Messaging.
- Web Container Software. Instructions for upgrading Web Server or Application Server are provided in the Java Enterprise System Upgrade Guide.
- Access Manager (optional). Instructions for upgrading Access Manager are provided in the Java Enterprise System Upgrade Guide.
- Directory Server (optional). Instructions for upgrading Directory Server are provided in the Java Enterprise System Upgrade Guide.
Back Up Instant Messaging Data
The Instant Messaging upgrade from 2005Q4 or 2006Q1 to Communications Suite 5 does not modify configuration data. However, as a safety measure, in case you re-configure something by accident, it is a good idea to back up the Instant Messaging database and any existing resource and configuration files before upgrading Instant Messaging. This would include, for example, the iim.conf file (for location, see Table 7-2).
For more information, see the Sun Java System Instant Messaging 7 2005Q4 Administration Guide, http://docs.sun.com/doc/819-2503.
Obtain Required Configuration Information and Passwords
You have to log in as superuser to perform the upgrade. Depending on the web container you are using, you might need the corresponding administrator user ID and password.
Upgrading 2005Q4 or 2006Q1 Instant Messaging (Solaris)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by the procedure itself.
Upgrade Considerations (Solaris)
The upgrade of Instant Messaging software to Communications Suite 5 takes into account the following considerations:
- Instant Messaging components should be shut down when patches are being applied to the installed image.
- In deployment architectures in which different Instant Messaging subcomponents reside on different computers, for example messenger resources on one computer, Instant Messaging Server on another, and Instant Messaging Multiplexor on yet another, the upgrade must be performed on all such computers.
- Because of a change in Multiplexor protocol, an Instant Messaging 7.2 server component can communicate with a 2005Q4 or 2006Q1 Instant Messaging Multiplexor, but not the other way around. Therefore in distributed deployments, you should upgrade the server components before upgrading the Multiplexor components.
- The Instant Messaging upgrade applies to multiple subcomponents of Instant Messaging on one computer using the same installed image.
- The Instant Messaging upgrade patches for Solaris OS are shown in the following table. Patch revision numbers are the minimum required for upgrade to Communications Suite 5. If newer revisions become available, use the newer ones instead of those shown in the table.
Upgrade Procedure (Solaris)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Obtain the required patches, based on Table 7-5.
Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access
- Log in as root or become superuser.
su -
- Stop Instant Messaging if it is running.
InstantMessaging-base/sbin/imadmin stop
- If you have not already done so, update all shared component to Communications Suite 5.
See Upgrade Instant Messaging Dependencies.
- Apply the appropriate Instant Messaging patches in Table 7-5.
If needed, be sure to apply the Instant Messaging localization patch before applying the core patch.
patchadd patch_ID
- Confirm that the patch upgrades were successful:
showrev -p | grep patch_ID
The output should return the versions of patch IDs applied in Step 5.
- Re-deploy Instant Messaging client resources in a web container instance.
Web container upgrade scenarios 1, 3, and 4:
If the web container had not been upgraded in a pre-upgrade task (Scenarios 1 and 3 of Table 7-3) or if the web container had been upgraded so that instance configuration data remained in a known location (Scenario 4), then the re-deployment of client resources is performed as follows:
- Run the configurator program.
InstantMessaging-base/configure
- In the interface, select only Client Components.
Do not re-configure server components.
- Select the Deploy Messenger Resources download checkbox.
The configure utility requests necessary web container information, queries the web container for configuration information, generates .war files, and deploys them.
- InstantMessaging-base/sbin/iwadmin redeploy im
You are prompted for any required admin ID and password.
- Restart the Instant Messaging service that was stopped in Step 3.
InstantMessaging-base/sbin/imadmin start
Web container upgrade scenario 2:
However, if the web container had been upgraded so that instance configuration data moved to a new location (Scenario 2 of Table 7-3) then the re-deployment of client resources is performed using the Instant Messaging configure utility, as follows:
- Run the configurator program.
InstantMessaging-base/configure
- In the interface, select only Client Components.
Do not re-configure server components.
- Select the Deploy Messenger Resources download checkbox.
The configure utility requests necessary web container information, queries the web container for configuration information, generates .war files, and deploys them.
- Restart the Instant Messaging service that was stopped in Step 3.
InstantMessaging-base/sbin/imadmin start
Upgrading 2005Q4 or 2006Q1 Instant Messaging (Linux)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by the procedure.
Upgrade Considerations (Linux)
The upgrade of Instant Messaging software to Communications Suite 5 on the Linux platform takes into account the same considerations as on the Solaris platform (see Upgrade Considerations (Solaris)), except that the Linux 5 upgrade patches differ from the Solaris patches.
The Instant Messaging upgrade patches for Linux OS are shown in the following table. Patch revision numbers are the minimum required for upgrade to Communications Suite 5. If newer revisions become available, use the newer ones instead of those shown in the table
Table 7-6 Patches to Upgrade Instant Messaging on Linux
Description
Patch ID and RPM names
Instant Messaging core
118788-26
Instant Messaging localization
120842-2
Upgrade Procedure (Linux)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Obtain the required patch using the patch number and RPM name from Table 7-6. Use this information to obtain the version numbers for the RPM.
Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access
- Log in as root or become superuser.
su -
- Stop Instant Messaging if it is running.
InstantMessaging-base/sbin/imadmin stop
- If you have not already done so, synchronize all shared component to Communications Suite 5.
See Upgrade Instant Messaging Dependencies.
- Apply the RPMs for Instant Messaging in Table 7-6.
If needed, be sure to apply the Instant Messaging localization patch before applying the Instant Messaging core patch.
rpm -Fvh sun-im-module-Locale-7.2-9.i386.rpm
rpm -Fvh sun-im-module-7.2-9.i386.rpm- Confirm that the patch upgrades were successful:
rpm -qa | grep sun-im
The new version numbers of the RPMs should be returned.
- Re-deploy Instant Messaging client resources in a web container instance.
Web container upgrade scenarios 1, 3, and 4:
If the web container had not been upgraded in a pre-upgrade task (Scenarios 1 and 3 of Table 7-3) or if the web container had been upgraded so that instance configuration data remained in a known location (Scenario 4), then the re-deployment of client resources is performed as follows:
- Run the configurator program.
InstantMessaging-base/configure
- In the interface, select only Client Components.
Do not re-configure server components.
- Select the Deploy Messenger Resources download checkbox.
The configure utility requests necessary web container information, queries the web container for configuration information, generates .war files, and deploys them.
- InstantMessaging-base/sbin/iwadmin redeploy im
You are prompted for any required admin ID and password.
- Restart the Instant Messaging service that was stopped in Step 3.
InstantMessaging-base/sbin/imadmin start
Web container upgrade scenario 2:
However, if the web container had been upgraded so that instance configuration data moved to a new location (Scenario 2 of Table 7-3) then the re-deployment of client resources is performed using the Instant Messaging configure utility, as follows:
- Run the configurator program.
InstantMessaging-base/configure
- In the interface, select only Client Components.
Do not re-configure server components.
- Select the Deploy Messenger Resources download checkbox.
The configure utility requests necessary web container information, queries the web container for configuration information, generates .war files, and deploys them.
- Restart the Instant Messaging service that was stopped in Step 3.
InstantMessaging-base/sbin/imadmin start
Verifying the Upgrade
You can verify the upgrade of Instant Messaging by entering the following command:
InstantMessaging-base/sbin/imadmin version
See Table 7-4 for output values.
You can also check the status of the various Instant Messaging subcomponents using the following command:
InstantMessaging-base/sbin/imadmin status
Or you can check the log file located at iim.instancevardir/log,
where instancevardir is specified in the iim.conf file (for path, see Table 7-2).
To confirm that the upgrade is properly localized:
- Launch localized Instant Messaging home page.
http://hostName:port/uri/Locale
- On localized Instant Messaging home page, launch Instant Messaging client login dialog by clicking Java Web Start button or Java Plugin button.
- Enter your user name and password on localized Instant Messaging client and make sure that localized client is displayed.
Post-Upgrade Tasks
If you want to enable the httpbind gateway as part of your upgrade to 5, you need to perform the following steps:
- Configure the httpbind component in the server.
See the Sun Java System Instant Messaging 7.2 Administration Guide, http://docs.sun.com/doc/819-4412.
- Deploy the httpbind gateway in a web container instance.
Rolling Back the Upgrade (Solaris)
This section describes considerations that impact the upgrade rollback procedure for Instant Messaging followed by the procedure itself.
Rollback Considerations (Solaris)
The procedure for rolling back the upgrade from Instant Messaging 7.2 to 2006Q1 or 2005Q4 is almost the reverse of the procedure for upgrading.
Rollback Procedure (Solaris)
- Log in as root or become superuser.
su -
- Stop Instant Messaging if it is running.
InstantMessaging-base/sbin/imadmin stop
- Remove the patches in Table 7-5.
patchrm patch_ID
The patch removal will undeploy the current client resources and redeploy the older version.
- Manually remove the 7.2 schema from your Directory Server and then apply the schema from the version to which you rolled back.
This includes removing sunimuser and sunpresenceuser object classes from all users in your directory.
- If you had run the Instant Messaging 7.2 configurator program to configure or deploy client resources, you must run the 2005Q4 or 2006Q1 configurator program to re-configure or re-deploy the client resources.
- Restart the Instant Messaging service that was stopped in Step 2.
InstantMessaging-base/sbin/imadmin start
Multiple Instance Upgrades
If you have multiple Instant Messaging Server instances using the same installed image, upgrading the default instance will upgrade all other instances. However, only the client components of the default instance will be redeployed as part of the upgrade.
The web-based client components corresponding to the additional (non-default) Instant Messaging Server instances, however, have to be manually redeployed to the web container as follows:
- Reuse the working directory, or a copy thereof, created when the additional instance was first created.
The steps for creating an additional instance are described in the Sun Java System Instant Messaging 7.2 Administration Guide, http://docs.sun.com/doc/819-4412..
- In the working directory, replace only the non-customized files, that is, the contents of the upgraded program files (the .jar file) for this instance.
- Generate a .war file from the working directory.
- Un-deploy the 2005Q4 web application corresponding to this instance.
- Deploy the 7.2 .war file generated in Step 3.
You will have to use the web container's deployment interface.
Upgrading Instant Messaging from Java Enterprise System 2005Q1On Linux, you must uninstall the sun-im-ident-7.0-13 package before upgrading. Otherwise, the procedure for upgrading Communications Suite 2005Q1 Instant Messaging to 7.2 is the same as that for upgrading 2005Q4 or 2006Q1 Instant Messaging to 7.2 regardless of operating system.
To upgrade 2005Q1 Instant Messaging to 7.2, use the instructions in Upgrading Instant Messaging from Java Enterprise System 2005Q4 or 2006Q1, except substitute 2005Q1 wherever 2005Q4 is referenced.
Upgrading Instant Messaging from Java Enterprise System 2004Q2This section includes information about upgrading Instant Messaging from Java Enterprise System 2004Q2 to Communications Suite 5 (Instant Messaging 7.2). The procedure for upgrading 2004Q2 Instant Messaging to 7.2 is quite different from that for upgrading from 2005Q4 Instant Messaging.
The section covers the following topics:
Introduction
When upgrading Communications Suite 2004Q2 Instant Messaging to 5, consider the following aspects of the upgrade process:
- General Upgrade Approach. The upgrade is performed using an upgrade utility that performs all operations needed to upgrade Instant Messaging software.
- Upgrade Dependencies. Upgrade of any Communications Suite component on a computer from 2004Q2 requires the upgrade of all other Communications Suite components hosted by the computer; selective upgrade of Communications Suite components from 2004Q2 to 7.2 is not supported. In particular, all Communications Suite shared components used by Instant Messaging, the web container, and Access Manager need to be upgraded to Communications Suite 5.
- Backward Compatibility. Instant Messaging 7.2 is backwardly compatible with the 2004Q2 version.
- Upgrade Rollback. Rollback of the 7.2 upgrade to 2004Q2 is achieved by saving all 2004Q2 software and data and manually reverting back to the 2004Q2 version. There is no utility for rolling back the upgrade.
- Platform Issues. The general approach for upgrading Instant Messaging is the same on both Solaris and Linux operating systems. The upgrade process includes any platform-specific details.
2004Q2 Instant Messaging Upgrade
This section describes how to perform an upgrade of Instant Messaging from Java Enterprise System 2004Q2 to Communications Suite 5 on both the Solaris and Linux platform. Where a topic depends on platform-specific procedures, the topic will indicate the operating system to which it applies. The section covers the following topics:
Pre-Upgrade Tasks
Before you upgrade Instant Messaging you should perform the tasks described below.
Verify Current Version Information
You can verify the current version of Instant Messaging using standard version checking utilities:
Solaris:
pkginfo -l SUNWiiminLinux:
rpm -qa | grep sun-imSee Table 7-4 for output values.
Upgrade Instant Messaging Dependencies
Communications Suite 5 does not support the coexistence of Instant Messaging 2004Q2 and Instant Messaging 7.2 shared components on a single computer.
You are therefore required to upgrade all local Communications Suite 2004Q2 components on which Instant Messaging depends to Communications Suite 5. When you upgrade all Instant Messaging dependencies on a computer, they should be upgraded in the following order, all before you upgrade Instant Messaging.
- Shared Components. All shared components must be updated to 5. Instructions for updating Communications Suite shared components to 5 are provided in Chapter 2, "Upgrading Communications Suite Shared Components").
- Web Container Software. Instructions for upgrading Web Server or Application Server are provided in the Java Enterprise System Upgrade Guide.
- Access Manager (Access Manager SDK). Instructions for upgrading Access Manager to are provided in the Java Enterprise System Upgrade Guide.
- Directory Server (optional). Instant Messaging is rarely dependent on a local Directory Server, however, instructions for upgrading Directory Server are provided in the Java Enterprise System Upgrade Guide.
Back Up Instant Messaging Data
The Instant Messaging upgrade from 2004Q2 to 7.2 modifies configuration data and customizations. Before upgrading Instant Messaging, it is a good idea to back up the Instant Messaging database and any existing resource and configuration files. For more information, see the Sun Java System Instant Messaging 7 2005Q4 Administration Guide, http://docs.sun.com/doc/819-2503.
Obtain Required Configuration Information and Passwords
You have to log in as superuser to perform the upgrade. Depending on the web container you are using, you might need the corresponding administrator user ID and password.
Upgrading 2004Q2 Instant Messaging (Solaris)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by a description of the procedure itself.
Upgrade Considerations (Solaris)
The upgrade of Instant Messaging software to Communications Suite 5 takes into account the following considerations:
- In deployment architectures in which different Instant Messaging subcomponents reside on different computers, for example messenger resources on one computer, Instant Messaging Server on another, and Instant Messaging Multiplexor on yet another, the upgrade must be performed on all such computers.
- Because of a change in Multiplexor protocol, a Instant Messaging 7.2 server component can communicate with a 2005Q4 Instant Messaging Multiplexor, but not the other way around. Therefore in distributed deployments, you should upgrade the server components before upgrading the Multiplexor components.
- The Instant Messaging upgrade applies to multiple subcomponents of Instant Messaging on one computer using the same installed image.
- The upgrade of 2004Q2 Instant Messaging software to Communications Suite 5 makes use of an upgrade utility that performs the following operations:
- Creates a temporary directory where it stores working files.
- Gathers and temporarily stores previous package installation parameters for all packages installed on the system.
- Shuts down the previous version of the Instant Messaging server.
- Installs new packages and patches existing packages.
- Installs any new shared component packages needed by Instant Messaging.
- Saves the previous graphics contents from IIM_DOCROOT and restores them to the new resource files location.
- Restarts all services.
- Deletes the temporary directory and its contents.
Upgrade Procedure (Solaris)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Log in as root or become superuser.
su -
- If you have not already done so, upgrade the IM-SDK shared component and all other shared components to 5.
See Upgrade Instant Messaging Dependencies.
- Run the upgrade utility from the Instant Messaging tools directory of the Communications Suite 5 distribution.
cd /Solaris_arch/Product/instant_messaging/Tools
./upgradeThe upgrade utility creates a log file that shows the progression of the upgrade process. The log file resides in the following location:
/var/sadm/install/logs/Instant_Messaging_Upgrade.timestamp
Where timestamp is in the format yyyymmddhhss.
- Re-configure Instant Messaging.
Change configuration as necessary to use new features introduced after 2004Q2.
InstantMessaging-base/configure
If you have not customized messenger resources, choose to configure both client and server components when prompted. This completes the upgrade procedure.
If you have customized messenger resources, choose to configure only the server when prompted, then complete Step 5 and Step 6 that follow. For configuration information, see Sun Java System Instant Messaging 7.2 Administration Guide, http://docs.sun.com/doc/819-4412..
- Re-customize messenger resources.
If you had customized your messenger resources, you need to reapply those customizations to the following files:
InstantMessaging-base/html/Locale/imbrand.jar
InstantMessaging-base/html/Locale/imb[ssl].html|jnlpConsult the customized files that you saved under Back Up Instant Messaging Data.
- If you customized messenger resources, re-deploy the resources in a web container instance.
Because the web container had been upgraded as a pre-upgrade task (Scenarios 2 and 5 of Table 7-3), then the re-deployment of client resources is performed using the Instant Messaging configurator program, as follows:
- Run the configurator program.
InstantMessaging-base/configure
- In the interface, select only Client Components.
Do not re-configure server components.
- Select the Deploy Messenger Resources download checkbox.
The configure program requests necessary web container information, generates war files, and deploys them.
Upgrading 2004Q2 Instant Messaging (Linux)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by a description of the procedure itself.
Upgrade Considerations (Linux)
The upgrade of Instant Messaging software to Communications Suite 5 on the Linux platform takes into account the same considerations as on the Solaris platform (see Upgrade Considerations (Solaris)).
Upgrade Procedure (Linux)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Log in as root or become superuser.
su -
- If you have not already done so, upgrade the IM-SDK shared component to 5 and any other shared components you wish to upgrade.
See Upgrade Instant Messaging Dependencies.
- Run the upgrade utility from the Instant Messaging tools directory of the Communications Suite 5 distribution.
cd /Linux_x86/Product/instant_messaging/Tools
./upgradeThe upgrade utility creates a log file that shows the progression of the upgrade process. The log file resides in the following location:
/var/sadm/install/logs/Instant_Messaging_Upgrade.timestamp
Where timestamp is in the format yyyymmddhhss.
- Re-configure Instant Messaging.
Change configuration as necessary to use new features introduced after 2004Q2.
InstantMessaging-base/configure
If you have not customized messenger resources, choose to configure both client and server components when prompted. If you have customized messenger resources, choose to configure only the server when prompted. For configuration information, see the Sun Java System Instant Messaging 7.2 Administration Guide, http://docs.sun.com/doc/819-4412..
- Re-customize messenger resources.
If you had customized your messenger resources, you need to reapply those customizations to the following files:
InstantMessaging-base/html/Locale/imbrand.jar
InstantMessaging-base/html/Locale/imb[ssl].html|jnlp
Consult the customized files that you saved under Back Up Instant Messaging Data.
- If you customized messenger resources, re-deploy the resources in a web container instance.
Because the web container had been upgraded as a pre-upgrade task (Scenarios 2 and 5 of Table 7-3), then the re-deployment of client resources is performed using the Instant Messaging configurator program, as follows:
- Run the configurator program.
InstantMessaging-base/configure
- In the interface, select only Client Components.
Do not re-configure server components.
- Select the Deploy Messenger Resources download checkbox.
The configure program requests necessary web container information, generates war files, and deploys them.
Verifying the Upgrade
You can verify the upgrade of Instant Messaging to 5 by entering the following command:
InstantMessaging-base/sbin/imadmin version
See Table 7-4 for output values.
You can also check the status of the various Instant Messaging subcomponents using the following command:
InstantMessaging-base/sbin/imadmin status
Or you can check the log file located at iim.instancevardir/log,
where instancevardir is specified in the iim.conf file (for path, see Table 7-2).
To confirm that the upgrade is properly localized:
- Launch localized Instant Messaging home page.
http://hostName:port/uri/Locale
- On localized Instant Messaging home page, launch Instant Messaging client login dialog by clicking Java Web Start button or Java Plugin button.
- Enter your user name and password on localized Instant Messaging client and make sure that localized client is displayed.
Post-Upgrade Tasks
If you want to enable the httpbind gateway as part of your upgrade to 5, you need to perform the following steps:
- Configure the httpbind component in the server.
See the Sun Java System Instant Messaging 7.2 Administration Guide, http://docs.sun.com/doc/819-4412..
- Deploy the httpbind gateway in a web container instance.
Rolling Back the Upgrade
Rollback of the 5 upgrade to 2004Q2 is achieved by saving all 2004Q2 software and data (see Back Up Instant Messaging Data) and manually reverting back to the 2004Q2 version. There is no utility for rolling back the upgrade.
Multiple Instance Upgrades
If you have multiple Instant Messaging Server instances using the same installed image, upgrading the default instance will upgrade all other instances. However, only the client components of the default instance will be redeployed as part of the upgrade.
The web-based client components corresponding to the additional (non-default) Instant Messaging Server instances, however, have to be manually redeployed to the web container as follows:
- Reuse the working directory, or a copy thereof, created when the additional instance was first created.
The steps for creating an additional instance are described in the Sun Java System Instant Messaging 7.2 Administration Guide, http://docs.sun.com/doc/819-4412.
- In the working directory, replace only the non-customized files, that is, the contents of the upgraded program files (the .jar file) for this instance.
- Generate a war file from the working directory.
- Un-deploy the 2005Q4 web application corresponding to this instance.
- Deploy the 5 war file generated in Step 3.
You will have to use the web container's deployment interface.
Upgrading Instant Messaging from the Interim Feature Release 2006Q1 (7.1)The procedure for upgrading the Instant Messaging Interim Feature Release 2006Q1 (7.1) to 5 is the same as that for upgrading 2005Q4 Instant Messaging to 5.
To upgrade the Instant Messaging 2006Q1 to 5, use the instructions in Upgrading Instant Messaging from Java Enterprise System 2005Q4 or 2006Q1, except substitute 2006Q1 wherever 2005Q4 is referenced.