Upgrading Instant Messaging


Note	Upgrade saves all the existing database and configuration information. Upgrade is performed to preserve an existing installation and upgrade the product to use the upgraded features.

When the setup program detects a previous version of Sun ONE Instant Messaging on your machine, it allows you to upgrade the installed components.

Upgrading a Sun ONE Instant Messaging component does not allow you to change the installation configuration. If you want to change the directory location of the Instant Messaging files or the port numbers on which your Instant Messaging servers communicate, you should uninstall the component and reinstall it.

The upgrade of a component preserves the Instant Messaging data and the configuration information.

.new Files

When you upgrade Instant Messaging , all the customizable files are retained by the installation. If there are any changes to the customizable files in the new version, a .new file will be created for each of the files that are changed.

As part of the post-upgrade process, you can merge these changes to your old files. You need to do this for the new features to take effect. When merging the changes, compare the old files with the .new files, line by line, and edit your existing files to incorporate these changes.

For example, if you have customized your iim.conf file, you can see the iim.conf.new file in the config directory after the upgrade process is finished. To complete the upgrade process, you have to merge the changes in the iim.conf.new file into your existing iim.conf file.

Protecting Your Files

The upgrade option preserves your databases and configuration information, such as user profile data and preferences. However, to protect this information during the installation process, make sure you back up the files listed in Table B-1 before the upgrade process.

Table B-1 Instant Messaging Files to Back Up Before Upgrading
Type of File	UNIX Default Location	Windows Default Location
Database	For Solaris: /var/opt/SUNWiim/default/db For Linux: /var/opt/soim/default/db	c:\Program Files\Sun\ InstantMessaging\db
User profiles and preferences	For Solaris: /var/opt/SUNWiim/default/db For Linux: /var/opt/soim/default/db	c:\Program Files\Sun\ InstantMessaging\db
Configuration	For Solaris: /etc/opt/SUNWiim/default/config For Linux: /etc/opt/soim/default/config	c:\Program Files\Sun\ InstantMessaging\config
ACLs	For Solaris: /etc/opt/SUNWiim/default/config/acls For Linux: /etc/opt/soim/default/config/acls	c:\Program Files\Sun\ InstantMessaging\config\acls
Customizable client files, such as index.html, im.jnlp, imres.jnlp, and imbrand.jar.	For Solaris: /opt/SUNWiim/html For Linux: /opt/soim/html	c:\Program Files\Sun\ InstantMessaging\html
Any other files that you have customized.	Depends on your site’s requirement.	Depends on your site’s requirement.

Upgrading Instant Messaging

The upgrade procedure in this section is applicable for both Windows and Solaris operating systems.

Obtain Instant Messaging software.

Prepare for the installation and plan the time for shutting down the Instant Messaging server.

Inform your users ahead of time about the planned shutdown of the Instant Messaging server.

Shut down the Instant Messaging server and multiplexor.

Perform the upgrade with the setup command.

Perform the post-upgrade procedures.

To Upgrade Instant Messaging

Before beginning, download the Sun ONE Instant Messaging software from the following site:

Shut down the Instant Messaging server.

This includes both the server and the multiplexor.

To shutdown the Instant Messaging server and the multiplexor, type:

imadmin stop

Start the installer.

For Solaris:

Download and unpack Sun ONE Instant Messaging Installation program. For more information, see Downloading and Unpacking Sun ONE Instant Messaging Installer.

Log in as root to install Sun ONE Instant Messaging. In the installation directory in which you have extracted the Instant Messaging archive file, type:

For graphical user interface: ./setup

For command-line interface:

Type ./setup -nodisplay

The installation program runs in the current window.

Text displays explaining how the command-line installation works. Press Enter to continue.

For Windows:

Log in as Administrator. You must have superuser privileges (that is, be logged in with full administration rights to the system) to run the installation program.

Create a directory (such as c:\tmp\impsvr) on the machine that will host the Instant Messaging server and download (or copy) the Sun ONE Instant Messaging installation file to the directory. Make sure that the download directory has adequate disk space to store the extracted files.



Caution	Do not download the archive file to the base directory to which you will be installing Instant Messaging.

Change to the directory where you have downloaded or copied the file and extract the contents.

Launch the installer.

For launching the graphical user interface installation, double-click the setup.exe file. A message dialog is displayed to confirm whether you want to install Sun ONE Instant Messaging. Click Yes to continue.

For the command-line installation:

Open a command prompt and change to the directory in which you placed the Instant Messaging archive file. For example:

cd tmp\impsvr

Start the installer by typing the setup file name followed by the argument -nodisplay. For example:

setup.exe -nodisplay

A couple of windows are displayed, after reading the information on the window, press Enter to continue.



Note	To exit the command-line installation, press CTRL-C.

The following steps explains the graphical user interface installation procedure. The steps are identical for both the command-line and graphical user interface installation. In the command-line installation, you need to press the Enter key to select an option.

The installation program displays a Welcome Message. Click Next to continue.

Read the license agreement and click Yes to accept the license and continue. If you click No, the installation program aborts without installing Instant Messaging.

The System Requirements panel lists other product dependencies.

Before continuing with this installation, you should have installed:

Sun ONE Portal Server, for portal deployments (Solaris only).

A web server, namely Sun ONE Web Server Enterprise Edition, to serve up the Instant Messenger Resources. (Portal deployments use the web server that ships with Sun ONE Portal Server.)

A directory (LDAP) server, namely Sun ONE Directory Server, for user authentication. (Ignore this requirement if you are using Sun ONE Portal Server’s directory.)

A messaging server, namely Sun ONE Messaging Server, to send alerts by email when users are unable to receive instant messages.

If you have these products installed, click Next to continue installation. Otherwise, Click Exit to quit the installation and install the products mentioned earlier. After installing these products, restart the installation.

On most systems, the installation program automatically detects the host name and DNS domain name of the system on which you are installing the server. Click Next to continue.

If the installation program cannot detect the host name and DNS domain name, the “Unable to make network connection” window is displayed and the host name and DNS domain name fields remain blank.

Enter a valid host name and DNS domain name and click Next. The installation program then tries to establish a network connection using these values. The Host Name or Domain Name fields will remain blank if the installation program is unable to detect these values.



Note	This window only verifies the availability of network connection. The Host and Domain values entered in this step are not used in the Instant Messaging Configuration.

The Component Selection panel is displayed. The installer disables the component selection if it detects a same or a higher version of the component installed on the machine.

Click Next to continue.

A confirmation dialog box with the list of components to be added and upgraded is displayed.



Caution	Even though the upgrade does not overwrite your databases or customized files, it is advisable to take a back up of all your databases, user profiles and preferences, and any files you may have customized. For a list of files, refer to Table B-1.

Sun ONE Identity Server Instant Messaging Service Installation only. The LDAP Service Configuration panel is displayed for Solaris only. Enter the following information:

Host. The host on which the directory server is running. For example, fiat.sireo.com

Port. The port number to which the directory server listens to. For example, 389.

BaseDN.Base DN (distinguished name) is the entry in your LDAP directory used as the starting point to search for users and groups. For example, if you specify a base DN of o=i-zed.com, LDAP search operations executed by the Instant Messaging server will examine the o=i-zed.com directory tree. The installation program does not attempt to verify your entry.

BindDN. Enter the Bind DN (distinguished name) of the Directory Manager to bind to the LDAP directory server.

Password. Enter the password of the Directory Manager to bind to the LDAP directory server.



Note	If Sun ONE Identity Server Instant Messaging Service is installed then the administrator credentials of the Identity Server is used to bind to the directory server for performing user search.

The Instant Messaging Services Startup panel is displayed.

You can start the Sun ONE Instant Messaging Services after a successful installation. Click Next to continue.

A message box displays the information that the installer is verifying whether there is adequate disk space.



Note	You might not see this window on a faster system.

The Ready to Install panel is displayed.

To complete the installation, click Install Now.

When the installation procedure has completed, an installation Summary window is displayed. Click Details if you want to review the summary information on the installation. Click Dismiss to close the summary information window, then click Exit to exit the installation program.

Post-Upgrade

While upgrading the Instant Messaging with a new version, the installer creates .new files in the config and html directories. These files contain all the changes made in this version. For example, the installer creates a iim.conf.new file if the iim.conf file is customized. This iim.conf.new file would contain all the changes that needs to be incorporated in the new version of iim.conf file.

After upgrading to the new version, you need to find the .new files, and merge the changes into your existing files to preserve the customization performed on these files.

When merging the changes, compare the old files with the .new files, line by line, and edit your existing files to incorporate these changes.

Table B-2 lists the files that can be customized, and for which .new files can be created:

Table B-2 .new Files for Solaris and Windows
Type of Files	Solaris	Windows
Config	$CONFIGDIR/iim.conf $CONFIGDIR/acls/ sysAdmin.acl $CONFIGDIR/acls/ sysTopicsAdd.acl $CONFIGDIR/acls/ sysRoomsAdd.acl $CONFIGDIR/acls/ sysSendAlerts.acl $CONFIGDIR/acls/ sysWatch.acl $CONFIGDIR/acls/ sysSaveUserSettings.acl	$BASEDIR\config\iim.conf $BASEDIR\config\acls\sysAdmin.acl $BASEDIR\config\acls\sysTopicsAdd.acl $BASEDIR\config\acls\sysRoomsAdd.acl $BASEDIR\config\acls\sysSendAlerts.acl $BASEDIR\config\acls\sysWatch.acl $BASEDIR\config\acls\sysSaveUserSettings.acl
HTML	$imdocroot/im.html $imdocroot/im.jnlp $imdocroot/index.html $imdocroot/imres.jnlp $imdocroot/imbrand.jar $imdocroot/imssl.jnlp $imdocroot/imssl.html	$imdocroot\im.html $imdocroot\im.jnlp $imdocroot\index.html $imdocroot\imres.jnlp $imdocroot\imbrand.jar $imdocroot/imssl.jnlp $imdocroot/imssl.html
For Solaris the default value for $CONFIGDIR is /etc/opt/SUNWiim/default/config and $imdocroot is /opt/SUNWiim/html. For Linux the default value for $CONFIGDIR is /etc/opt/soim/default/config and $imdocroot is /opt/soim/html. For Windows the default value for $BASEDIR is c:\Program Files\Sun\InstantMessaging, and $imdocroot is c:\Program Files\Sun\InstantMessaging\html.

Appendix B
Upgrading Instant Messaging

Overview of Upgrading

.new Files

Protecting Your Files