| Sun ONE Instant Messaging Release Notes |
| Last updated January 11, 2004 |
Sun™ ONE Instant Messaging 6.0
Release Notes
This document contains important information about SunTMONE Instant Messaging, available at the time of the 6.0 release. New features and enhancements, known problems, and other late-breaking issues are addressed here. Read this document before you begin using Sun ONE Instant Messaging 6.0.
This document contains the following sections:
- About Sun ONE Instant Messaging
- What's New in Sun ONE Instant Messaging 6.0
- Documentation
- Software and Hardware Requirements
- Installation and Upgrade Notes
- Troubleshooting
- Known Problems and Limitations
- How to Report Problems
- For More Information
About Sun ONE Instant Messaging
Sun ONE Instant Messaging delivers secure presence and extended real-time messaging, enabling communities of users to communicate and collaborate instantly and securely. It combines instant messaging capabilities with conferences, alerts, news, polling and file transfer to create a rich collaborative environment. It is available as a standalone product or as a fully integrated product with the Sun ONE Portal Server, leveraging its single sign-on, community management and secure remote access capabilities. Sun ONE Instant Messaging can also be used with the Sun ONE Identity Server, exploiting its service and policy management features.
What's New in Sun ONE Instant Messaging 6.0
The following lists the enhancements and new capabilities since release 3.0.1:
- Integration with Sun ONE Portal Server 6.0 which supports the following features:
- Archival of alerts, polls, news channel messages and conferences.
- End users can archive alert messages for personal reference.
- Search and retrieve capability for archived content.
- Provision of an Instant Messaging portal channel. A supplied Instant Messaging portlet allows users to view their on-line contacts and their status. A chat session can be initiated directly from the portlet, and Instant Messenger can be launched directly from the portal desktop.
- Integration with Sun ONE Identity Server 5.1. When deployed with Sun ONE Identity Server, an Instant Messaging service is added to the Sun ONE Identity Server. The Instant Messaging service, enabling the administrator to enforce policy mechanisms for accessing Sun ONE Instant Messaging.
- Calendar pop-up reminders. These enable users to receive real-time notification of upcoming calendar events through integration with the Sun ONE Calendar Server.
- UI Compliance with Section 508 of the Rehabilitation Act, for accessibility by the disabled.
- Support for Solaris 9.
- Support for Linux.
- Support for JRE 1.4.
- The Message Conversion API. This API enables integration with content filtering, anti-spam, translation, and virus protection tools.
Documentation
All product documentation for Sun Microsystems can be found at the following location:
Sun ONE Instant Messaging Documentation
In addition to these release notes, Sun ONE Instant Messaging includes a set of documentation. Online help is installed with the product, other documents can be accessed from the following location:http://docs.sun.com/db/prod/sunone
- Deployment Guide - Gives an overview of the issues involved in designing and installing an instant messaging solution with Sun ONE Instant Messaging.
- Quick Reference - Provides a quick overview of the the Instant Messenger main window and its controls.
- Installation Guide - Provides instructions for installing the Sun ONE Instant Messaging software and its components.
- Administrator's Guide - Describes how to administer Sun ONE Instant Messaging and its associated components.
Software and Hardware Requirements
This section discusses the requirements for installing the Sun ONE Instant Messaging software. Before installing, make sure you have met the minimum hardware and operating system requirements. JRE 1.3 and 1.4 are supported by both server and client.
Note A portal deployment of Sun ONE Instant Messaging requires Sun ONE Portal Server 6.0 which currently supports Solaris 8 and 9.
Supported Platforms for the Server
This release of Sun ONE Instant Messaging supports the following platforms for the server:
- Solaris 8 with recommended patches (no Java patches necessary)
- Solaris 9
- Red Hat Linux 7.2 or later (in the stand-alone mode only, does not support portal mode)
A list of recommended patches for Solaris 8 can be found at:
- Windows 2000 (in the stand-alone mode only, does not support portal mode)
http://access1.sun.com/patch.public/
Hardware Requirements for the Server
The basic minimum hardware requirements for installing Sun ONE Instant Messaging Release 6.0 are as follows:
- Approximately 300 MB of free disk space for the installation.
- Approximately 5K of disk space for each user.
- At least 256 MB of RAM. The amount of RAM needed depends on the number of concurrent client connections, and whether the server and multiplexor are deployed on the same host. For more information on calculating the amount of RAM, see the Sun ONE Instant Messaging Deployment Guide.
Supported Client Operating Systems
This release supports the following client platforms:
- Solaris 8 and 9
- Microsoft Windows 98 and later (ME, NT (SP 6a), 2000, XP)
- Mac OS X 10.1 or later
- Red Hat Linux 7.2 or later
Browser Requirements
On Windows, Instant Messenger can be run in the browser's java plugin, using Netscape 4.7x, 7 or later, Mozilla 1.2 or later, or Internet Explorer 5.0 or later.
HTML links can be exchanged over Instant Messaging and clicked-on from Instant Messenger. When a link is activated, Instant Messenger invokes a browser. The following OS/browser combinations are supported:
- Solaris / Netscape Communicator 4.7x,
- Red Hat Linux 7.x / Netscape 4.7
- Red Hat Linux 8.0 or later / Mozilla 1.2 or later
- Windows 98/ME/NT/2000/XP / default browser (no restrictions)
- Mac OS X / browser configured in Java Web Start (no restrictions)
Hardware Requirements for the Client
Instant Messenger consumes between 20 and 40 MB of memory on most platforms. Size memory by including footprint of other applications and operating systems used. In most cases, at least 128 MB RAM is recommended in order to run Instant Messaging and other applications comfortably. This number is higher when using high footprint operating systems such as Windows XP.
Note about Unix client deployments
As of this writing, the installation of Java and Java Web Start on Unix desktop systems (Linux or Solaris) is somewhat cumbersome for the average end-user. In particular, the installation of Java Web Start is a separate operation from the initial Java installation. For this reason, it is recommended that Java and Java Web Start be installed on a shared disk accessible to all users over NFS. Once this is done, a tailored version the configjavaws script may be run by each user to initialize their Java Web Start configuration. This script creates or update the javaws.cfg file with a specific java version. It also adds an entry for Java Web Start in the the ~/.mailcap and ~/.mime.types files, thereby allowing the browser to invoke Java Web Start to handle JNLP documents. Once this is done, there is no need for each user to download or install Java.
Installation and Upgrade Notes
For a complete description regarding installation please refer to the Sun ONE Instant Messaging Installation Guide. Known problems with the install and uninstall procedures are listed in the section "Known Problems and Limitations". Sometimes problems can occur during an install or uninstall of Sun ONE Instant Messaging that result in both install and uninstall being unable to complete. In this circumstance, you need to manually remove all the components so that a fresh install can be attempted. On Solaris, perform the following steps:
- Create a .uninstall file in $BASEDIR/SUNWiim. Where $BASEDIR is the directory where Sun ONE Instant Messaging was installed. The default value for this is /opt. The content of this file should be:
DS_DIRMGR_DN="$DIR_MGR"
DS_DIRMGR_PASSWORD="$PASS"
DS_HOST="$HOST"
DS_PORT="$PORT"
where $DIR_MGR is the distinguished name of the Directory Manager, $PASS is the password of the Directory Manager, $HOST is the host name of the machine where Directory server is installed and $PORT is the port on which the Directory server is running.
- pkgrm -v SUNWiimid
- pkgrm -v SUNWiimps
- pkgrm -v SUNWiimc
- pkgrm -v SUNWiimd
- pkgrm -v SUNWiimm
- pkgrm -v SUNWiimjd
- pkgrm -v SUNWiim
- rm $BASEDIR/SUNWiim/.uninstall
- rm -rf $BASEDIR/SUNWiim
- rm /var/sadm/install/productregistry
Upgrading a Standalone Deployment
With regard to client/server communication protocol, a 3.0.1 Messenger client can communicate with the 6.0 release of the server, however the 6.0 release of Instant Messenger requires the 6.0 server. Server to server communication is compatible between 3.0.1 and 6.0 releases of the server. No changes are required to the server configuration (in the file iim.conf) and no migration is required of other server-related data. Refer also to Appendix B "Upgrading Sun ONE Instant Messaging" in the Sun ONE Instant Messaging Installation Guide.Some resources for Instant Messenger have changed:
The following steps should be followed to upgrade Instant Messenger resources:
- Instant Messenger comprises a different set of jar files.
- The file names used on the applet page are changed.
- The launch descriptor file iimres.jnlp no longer exists.
- The "en" locale is no longer provided by default.
- A new customizable jar file is used: imbrand.jar
- Perform the upgrade (run the setup program).
- Reapply the customizations originally made to the iimres.jar file to the imbrand.jar file.
- Modify the index page for Instant Messenger to refer to the page containing the new applets, or use the index.html.new page that was generated during the upgrade.
- To preserve user shortcuts and bookmark links, keep the old applet pages but replace applet references in them with links to the new applet versions.
Upgrading a Deployment with Portal
Currently, Sun ONE Portal Server 6.0. must be used and the 3.0 Messenger client cannot be used with it. The following links have been changed in the application channel:The following steps should be followed to preserve portal/Instant Messaging integration:
- The Instant Messaging launch servlet functionality is now contained in the portal Instant Messaging channel.
- The Launch of Instant Messenger is configured through the portal "IM Channel" edit page.
- Applet pages are now JSP's: pluginLaunch.jsp and jnlpLaunch.jsp
- Install Sun ONE Portal Server 6.0.
- Upgrade Instant Messaging from version 3.0.1 to 6.0. The Instant Messaging channel and Archive components should be selected during this process.
- Ensure that the Identity 5.1 Authentication Provider is used for server configuration, in the iim.conf file as follows:
- iim_server.usesso=-1
- iim_server.ssoprovider=com.iplanet.im.server.DSAMESSOProvider
- iim_ldap.useidentityadmin="true"
API Changes
Applications built using the iPlanet Collaboration API 3.0 will work with the 6.0 release of the server, however the 6.0 version of the API jar files cannot be used with an application built using the iPlanet Collaboration API. For applications that have been built using the iPlanet Collaboration API, note that it has been rebranded as the Sun ONE Instant Messaging Service API. The following package name changes have been made:To migrate an application to release 6.0, change the package names in import statements as necessary and recompile.
- com.iplanet.collaboration is rebranded as com.sun.im.service.
- com.iplanet.collaboration.helpers is now in com.sun.im.service.
- icapi.jar is replaced by imservice.jar.
Troubleshooting
This section documents some common problems that can occur during installation and after reconfiguring a deployment. Various system components log their operation which can be extremely useful when trying to isolate a problem. For details, refer to the section titled: Managing Logging, in Chapter 2 of the Administrator's Guide: Administering Sun ONE Instant Messaging Server and Multiplexor. The various log files are listed here (with their default locations on Solaris).
The multiplexor and server logs are in mux.log and server.log, by default in the directory /var/opt/SUNWiim/default/log. The logging level is controlled in the iim.conf configuration file via the properties iim.log.iim_mux.severity and iim.log.iim_mux.severity. These can have the values: fatal, error, warning, notice, info and debug.
For portal deployments, logging configuration is determined by the com.iplanet.services.debug.level property (its values are: message, warning, error and off).
The locations for the desktop and archive log files are:
Logging information for Instant Messenger can be obtained by enabling logging output from the Java Web Start application manager or the Java plug-in manager.
- /var/opt/SUNWam/debug/desktop.debug
- /var/opt/SUNWam/debug/IMArchiveSearch.log
- /var/opt/SUNWam/debug/IMArchiveSubmit.log
Below some symptoms and possible causes and advice are listed for some common problems:
Problem: Instant Messenger does not load or start
Possible causes:
Where to find clues:
- Wrong codebase in applet page.
- Application/x-java-jnlp-file MIME type not defined in the web server configuration.
- Plug-in of Java Web Start not installed or functional.
- No compatible Java version available.
Problem: Connection refused, timed out
- From the Java Web Start or plug-in errors (exception stack trace, launch page).
- Applet page source on the browser.
Possible causes:
Where to find clues:
- Either server or multiplexor is not running.
- Incorrect multiplexor host or port names used in applet descriptor file (.jnlp or .html).
- Different SSL setting used in Instant Messenger versus the multiplexor.
- Client/server version mismatch.
Problem: Authentication errors
- Instant Messaging server and multiplexor logs.
Possible causes:
Where to find clues:
- Problems with accessing the LDAP server.
- User not found.
- Invalid credentials.
- Invalid Identity Server session.
- Instant Messaging server, Identity authentication and LDAP logs.
Problem: Instant Messaging channel display errorPossible causes:
Where to find clues:
- Authentication error (server cannot validate the session token).
- Instant Messaging channel is misconfigured. For example, the incorrect Instant Messaging server and/or port were provided.
- Plug-in or Java Web Start is not installed or is not functional.
- User not found; the Instant Messaging server cannot find the user in the directory.
Problem: Instant Messaging content is not archived
- Instant Messaging server and and Instant Messaging channel logs.
Possible causes:
Where to find clues:
- Content is actually archived but the user has insufficient rights to access it.
- The content has not yet been committed to the (Compass) database.
- The archive provider has been disabled in the Instant Messaging server.
Instant Messaging server and archive logs.
Problem: Server-to-server communication fails to startPossible causes:
Where to find clues:
- Incorrect server identification.
- Mismatch in SSL settings.
- The two Instant Messaging server logs.
Known Problems and Limitations
As of the writing of this document, the following defects were known.
Attention! Patches are issued on a frequent basis. If you encounter one of these problems, contact Sun Support to enquire about the availability of a fix.
How to Report Problems
If you have problems using the software, contact customer support using one of the following mechanisms:
- The online support web site at:
http://www.sun.com/supportraining/
- The telephone dispatch number associated with your maintenance contract.
Please have the following information available prior to contacting support. This helps to ensure that our support staff can best assist you in resolving problems:
- Description of the problem, including the situation where the problem occurs and its impact on your operation
- Machine type, operating system version, and product version, including any patches and other software that might be affecting the problem
- Detailed steps on the methods you have used to reproduce the problem
- Any error logs or core dumps
For More Information
Useful Sun ONE information can be found at the following Internet locations:
- Sun ONE products and services information
http://www.sun.com/service/sunps/sunone/index.html
- Sun ONE developer information
http://developer.sun.com/
- Sun ONE learning solutions
http://wwws.sun.com/software/training/
- Sun ONE product data sheets
http://wwws.sun.com/software/
- Sun ONE product documentation
http://docs.sun.com/prod/sunone