Sun Java System Communications Services 2005Q4 Release Notes

Documentation Updates

This section contains information about changes to and errors in the documentation in the following sections:

Documentation Set

The 2005Q4 release of Instant Messaging uses the following version of the Administration Guide:

Sun Java System Instant Messaging 7 2005Q1 Administration Guide

Administration Guide

This section lists the following changes to the Sun Java System Instant Messaging 7 2005Q1 Administration Guide.

Starting, Stopping, and Refreshing Components in an HA Environment

Do not use the imadmin start, imadmin stop, or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

Additional Post-Installation Step for Deployments with Access Manager

(Issue Number: 6189148) If you install Access Manager on a different host from the Instant Messaging server, you need to manually copy the imServices_* files from the Instant Messaging server host to the Access Manager host after you run the configure utility.

To do this:

Locate the imService_*.properties files on the Instant Messaging server host. By default, these files are located under /opt/SUNWiim/lib/ on Solaris and /opt/sun/im/lib/ on Linux.
Copy the files to the locale directory on the Access Manager host. By default this directory is /opt/SUNWam/locale on Solaris and /opt/sun/identity/locale on Linux.

Change to Default Value for `iim_agent.enable` Parameter

(Issue Number: 5102072) In this release, the default value of the iim_agent.enable parameter has been changed to false. This change is not reflected in the Administration Guide.

Configuring Calendar Pop-up Reminders for Instant Messenger

Step 1 of the procedure “To Configure Instant Messaging Server” is incorrect. No package named SUNWiimag exists. Skip this step.

Parameter Removed From `iim.conf`

The iim_server.msg_archive.auto configuration parameter is no longer supported although it is incorrectly included in the list of parameters in the Administration Guide.

Enabling the Instant Messenger Archive Control Component for Java Plug-in

(Issue Number: 6244099) The Administration Guide procedure for enabling the Instant Messenger Archive Control component for the Java Plug-in is incorrect. Use the procedure described in Changes for HTML applet pages and pluginLaunch.jsp files instead.

Changes for HTML applet pages and `pluginLaunch.jsp` files

If you are using Java Plug-in to launch the Instant Messenger, perform the following steps to enable the Instant Messenger Archive Control feature in the Instant Messenger.

To Enable Instant Messenger Archive Control for Java Plug-in

Go to the Instant Messenger documentation root directory and locate the im.html and imssl.html files

By default, the files are installed in the following location:

/etc/opt/SUNWps/desktop/default/IMProvider

Open the .html files in a text editor.

Add or edit the following line as required:

<PARAM NAME="archive_control" VALUE="true" />
<EMBED archive_control=true;/>

Storing Archived Messages in a Non-default Portal Server Search Database

An error occurs in the procedure. Specifically, the following directory:

/etc/opt/SUNWps/desktop/default/IMProvider/

should be:

/etc/opt/SUNWps/desktop/default_locale/IMProvider/

For example:

/etc/opt/SUNWps/desktop/default_ja/IMProvider/

Configuring the Server to Allow New User Registration

The new user registration feature is not completely described in the Administration Guide. In addition to customizing Instant Messenger, you also need to configure the server to allow new user registration.

To do this, you need to add four configuration parameters to iim.conf then refresh the server configuration. Table 3–4 describes the configuration parameters.

Table 3–4 New User Registration Server Configuration Parameters


Parameter	Description
`iim.register.enable`	If `TRUE`, the server allows new Instant Messaging end users to register themselves (add themselves to the directory) using Instant Messenger.
`iim_ldap.register.enable`	If `TRUE`, the server allows new Instant Messaging end users to register themselves (add themselves to the directory) using Instant Messenger.
`iim_ldap.register.basedn`	If self-registration is enabled, the value of this parameter is the DN of the location in the LDAP directory in which person entries are stored. For example: `"ou=people,dc=siroe,dc=com"`
`iim_ldap.register.domain`	The domain to which new users will be added. For example: `directory.siroe.com`

To Configure the Server to Allow New User Registration

Open iim.conf in a text editor.

Add the configuration parameters and appropriate values as described in Table 3–4.

Save and close iim.conf.

Refresh the server configuration using the imadmin command-line utility.

imadmin refresh server

Caution –
Do not use the imadmin start, imadmin stop , or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

Additional Logging Parameter for XMPP Traffic

(Issue Number: 5070998) An additional undocumented logging parameter has been added to this release to collect XMPP messages in a separate log file.

To Configure the Server to Create the XMPP Message Log

Open iim.conf.

By default, the iim.conf file is installed in the configuration directory as follows:
- On Solaris:
  
  /etc/opt/SUNWiim/default/config/iim.conf
- On Linux:
  
  /etc/opt/sun/im/default/config/iim.conf
If you created multiple instances of Instant Messaging, the name of the /default directory will vary depending on the instance.

Enable the following line by removing the comment characters:
iim.log4j.config=log4j.conf
If the line does not exist, add it.

Save and close iim.conf.

Create a file named log4j.conf and save it to the configuration directory.

Add the following to log4j.conf:

log4j.logger.xmppd=INFO, A1

# DEFAULT TO RollingFileAppender
log4j.appender.A1=org.apache.log4j.RollingFileAppender
log4j.appender.A1.file=${logdir}/xmppd.log
log4j.appender.A1.append=true
log4j.appender.A1.maxBackupIndex=7
log4j.appender.A1.maxFileSize=5mb
# More example appenders..
# Straight to console..
# log4j.appender.A1=org.apache.log4j.ConsoleAppender
# log4j.appender.A1.ImmediateFlush=true
# Rollover at midnight..
# log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
# log4j.appender.A1.DatePattern='.'yyyy-MM-dd
# log4j.appender.A1.file=${logdir}/xmppd.log
# log4j.appender.A1.ImmediateFlush=true
# log4j.appender.A1.append=true
# Send to SMTP..
# log4j.appender.A1=org.apache.log4j.SMTPAppender

# PATTERN LAYOUT AND OPTIONS

# DEFAULT TO PatternLayout
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
# For full dates..
log4j.appender.A1.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n
# IM traditional output format..
#log4j.appender.A1.layout.ConversionPattern=%d{HH:mm:ss,SSS} %-5p %c [%t] %m%n
# More example layouts
# XMLLayout for chainsaw consumption
# log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout
# TTCCLayout for NDC information
# log4j.appender.A1.layout=org.apache.log4j.xml.TTCCLayout
# log4j.appender.A1.layout.DateFormat=ISO8601
# log4j.appender.A1.layout.TimeZoneID=GMT-8:00
# log4j.appender.A1.layout.CategoryPrefixing=false
# log4j.appender.A1.layout.ThreadPrinting=false
# log4j.appender.A1.layout.ContextPrinting=false

# Now we list logger/appender/layout for the other default loggers, but
# only the defaults..
log4j.logger.iim_wd=ERROR, A2
log4j.appender.A2=org.apache.log4j.RollingFileAppender
log4j.appender.A2.file=${logdir}/iim_wd.log
log4j.appender.A2.append=true
log4j.appender.A2.maxBackupIndex=7
log4j.appender.A2.maxFileSize=5mb
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n

# For separate xmpp traffic log, disabled by default.
log4j.logger.xmppd.xfer=DEBUG, A3
#log4j.appender.A3=org.apache.log4j.varia.NullAppender
# Select next block instead of previous line to enable separate transfer log
log4j.appender.A3=org.apache.log4j.RollingFileAppender
# log4j.appender.A3.file=${logdir}/xfer.log
# log4j.appender.A3.append=true
# log4j.appender.A3.maxBackupIndex=7
# log4j.appender.A3.maxFileSize=5mb
# log4j.appender.A3.layout=org.apache.log4j.PatternLayout
# # Note, simpler default output than above 3 loggers:
# log4j.appender.A3.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n

log4j.logger.agent-calendar=ERROR, A4
log4j.appender.A4=org.apache.log4j.RollingFileAppender
log4j.appender.A4.file=${logdir}/agent-calendar.log
log4j.appender.A4.append=true
log4j.appender.A4.maxBackupIndex=7
log4j.appender.A4.maxFileSize=5mb
log4j.appender.A4.layout=org.apache.log4j.PatternLayout
log4j.appender.A4.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n

log4j.logger.net.outer_planes.jso.BasicStream=OFF, A5
log4j.appender.A5=org.apache.log4j.RollingFileAppender
log4j.appender.A5.file=${logdir}/jso.log
log4j.appender.A5.append=true
log4j.appender.A5.maxBackupIndex=7
log4j.appender.A5.maxFileSize=5mb
log4j.appender.A5.layout=org.apache.log4j.PatternLayout
log4j.appender.A5.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n

Save and close log4j.conf.

Refresh the server:
imadmin refresh server
Caution –
Do not use the imadmin start, imadmin stop , or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

To Disable Separate XMPP Log File Creation

Disabling separate log file creation does not stop XMPP messages from being written to the server log.

Open log4j.conf.

Comment out the following line:
log4j.logger.xmppd.xfer=DEBUG, A3

High Availability for Instant Messaging

Documentation for this feature is available in Configuring Instant Messaging for High Availability (Solaris Only).

Online Help

The following information is not described in either the product online help or the quick reference.

Start Screen

The Start Screen launches Instant Messenger. If you are using Java Web Start, press the Start button in the middle of the screen. If you are using Java Plug-in (for Windows users only), click the Java Plug-in button at the top of the screen. The Online Help and Quick Reference buttons display end user product help.