Appendix A Instant Messaging Configuration Parameters

Appendix A
Instant Messaging Configuration Parameters

This chapter explains the Instant Messaging configuration parameters in the following sections:

Using the iim.conf file

General Configuration Parameters

User Source Configuration Parameters

Logging Configuration Parameters

Instant Messaging Server Configuration Parameters

Multiple Server Configuration Parameters

Multiplexor Configuration Parameters

Watchdog Parameters

Agent Parameters

Using the iim.conf file

Instant Messaging stores configuration settings in the iim.conf file within the Configuration Directory (im_cfg_base).

On Solaris:

/etc/opt/SUNWiim/default/config/iim.conf

On Linux:

/etc/opt/sun/im/default/config/iim.conf

This file is a plain ASCII text file, with each line defining a server parameter and its value(s):

A parameter and its value(s) are separated by an equal sign (=) with spaces and tabs allowed before or after the equal sign.

A value can be enclosed in double quotes (" "). If a parameter allows multiple values, the entire value string must be enclosed in double quotes.

A comment line must have an exclamation point (!) as the first character of the line. Comment lines are for informational purposes and are ignored by the server.

If a parameter appears more than once, the value of the last parameter listed overrides the previous value.

A backslash (\) is used for continuation and indicates the value(s) are longer than one line.

Each line is terminated by a line terminator (\n, \r, or \r\n).

The key consists of all the characters in the line starting with the first non-whitespace character and up to the first ASCII equal sign (=) or semi-colon (;). If the key is terminated by a semi-colon, it is followed by “lang-” and a tag that indicates the language in which this value is to be interpreted. The language tag is followed by an equal sign (=). All whitespace characters before and after the equal sign are ignored. All remaining characters on the line become part of the associated value string.

Multiple values in the value string are separated using commas (,).

Within a value, if any special characters like comma, space, newline, tab, double quotes, or backslash are present, the entire value needs to be within double quotes. In addition, every carriage return, line feed, tab, backslash, and double quotes within the value must specified with a backslash (\).

If you make changes to the iim.conf file, you must refresh the Instant Messaging server in order for the new configuration settings to take effect.



Note	The iim.conf file is initialized by the installation process and should be modified only as described in this guide.

General Configuration Parameters

Table A-1 lists and describes the general configuration parameters.

Table A-1 General Configuration Parameters
Parameter	Default Value	Description
iim.comm.modules	iim_server,iim_mux	The communication modules used. The possible values are iim_server and iim_mux. The default value is iim_server, iim_mux, which means both the server and multiplexor are used. The iim_mux value is useful for multiplexor.
iim.smtpserver	localhost	SMTP server to send mail to end users who have set the option for forwarding their messages as emails or to pagers.
iim.instancedir	/opt	The installation directory root.
iim.instancevardir	Solaris: /var/opt/SUNWiim Linux: /var/opt/sun/im	Sets the directory to contain runtime files, including the end-user profile database, logs, and other files created by the server and multiplexor at runtime.
iim.user	inetuser for LDAP deployments. root for portal deployment.	The end-user name with which the server processes run.
iim.group	inetgroup for LDAP deployments. root for portal deployment.	The group using which the server processes run.
iim.jvm.maxmemorysize	256	The maximum number heap size in MB the JVM running the server is allowed to use. Used to construct the -mx argument of the Java command.
iim.mail.charset	None	This parameter specifies if the headers of the mail are in ASCII and not encoded. It contains the name of the charset to be used to encode the headers of the mail message sent out for offline alerts. For example: iim.mail.charset=iso-2022-jp
iim.jvm.command	/usr/j2se/bin/java	The location of the Java Runtime Executable (JRE).
iim.identity.basedir	/opt	The default installation directory, also referred to as the base directory, for Sun Java System Access Manager.
iim.identity.jre	/usr/java_1.3.1_04	The location of the JRE used by the Access Manager to run all it's processes.
iim.portal.deployuri	/portal	The URI using which the Portal Server war files are deployed in the Access Manager.
iim.portal.host	imhostname	The host name of the server on which the Portal Server is running. Specify the port number if a non default port number is used.
iim.portal.protocol	http	The protocol used to access the Portal Server.
iim.policy.resynctime	720	The Instant Messaging server clears all cached end-user information on a regular basis in order to eliminate old end-user information. This parameter specifies the frequency, in minutes, at which the cached end-user information is cleared.

User Source Configuration Parameters

Table A-2 lists and describes the user source configuration parameters.

Table A-2 User Source Configuration Parameters
Parameter	Default Value	Description
iim_ldap.host	localhost:389	LDAP server name and port used by Instant Messaging server for end-user authentication.
iim_ldap.searchbase	o=internet	The string used as base to search for the end users and groups on the LDAP server.
iim_ldap.usergroupbinddn	None (the server performs anonymous searches)	Specifies the dn to use to bind to the LDAP server for searches.
iim_ldap.usergroupbindcred	None (the server performs anonymous searches)	Specifies the password to use with the iim_ldap.usergroupbinddn dn for LDAP searches.
iim_ldap.loginfilter	(&(\|(objectclass=inetorgperson) (objectclass=webtopuser)) (uid={0}))	Search filter used during end-user login.
iim_ldap. usergroupbyidsearchfilter	(\|(& (objectclass=groupofuniquenames) (uid={0})) (&(\|(objectclass=inetorgperson) (objectclass=webtopuser)) (uid={0})))	The search filter used to search for end users and groups in the directory, under the base specified by ID.
iim_ldap.usergroupbynamesearchfilter	(\|(&(objectclass=groupofuniquenames)(cn={0})) (&(\|(objectclass=inetorgperson) (objectclass=webtopuser)) (cn={0})))	The search filter used to search for end users and groups in the directory, under the base specified by name.
iim_ldap.allowwildcardinuid	False	Determines if wildcards should be enabled for UIDs while performing a search. As most directory installations have UIDs indexed for exact searches only, the default value is False. Setting this value to True can impact performance unless UIDs are indexed for substring search.
iim_ldap.userclass	inetOrgPerson,webtopuser	The LDAP class that indicates that an entry belongs to an end user.
iim_ldap.groupclass	groupOfUniqueNames	The LDAP class that indicates that an entry belongs to a group.
iim_ldap.groupbrowsefilter	(objectclass=groupofuniquenames)	The search filter used to browse all groups in the directory, under the specified search base.
iim_ldap.searchlimit	40	Maximum number of entries to be returned by a search. A value of -1 means search is disabled on this server and a value of 0 indicates unlimited search.
iim_ldap.userdisplay	cn	LDAP attribute to use for display name of end users.
iim_ldap.groupdisplay	cn	LDAP attribute to use for display name of groups.
im_ldap.useruidattr	uid	LDAP attribute used as end users’ UID.
im_ldap.groupmemberattr	uniquemember	LDAP attribute that gives the list of members of a group.
iim_ldap.usermailattr	mail	LDAP attribute that should contain end users’ provisioned email addresses. Used when the email message is sent to an offline end user.
iim_ldap.userattributes	None	LDAP attribute that contains the list of custom attributes from the LDAP user entry.
iim_ldap.groupattributes	None	LDAP attribute that contains the list of custom attributes from the LDAP group entry.
iim_ldap.groupmemberurlattr	None	The membership attribute of a dynamic group, which contains the LDAP filter or the LDAP URL.
iim_ldap.useidentityadmin	The default value is true, if Access Manager Instant Messaging Service Definition component is installed. The default value is false, if Access Manager Instant Messaging Service Definition component is not installed.	If the value is true then the Access Manager Administrator credentials will be used to bind to the Directory Server.

Logging Configuration Parameters

Table A-3 lists and describes the logging configuration parameters.

Table A-3 Logging Configuration Parameters
Parameter	Default Value	Description
iim.log.iim_server.severity	INFO	Level of logging required for the server module. The possible values from highest to lowest are: FATAL, ERROR, WARNING, INFO, and DEBUG. If a lower level of logging is chosen, it is implied that you get the higher levels too. That is, if you choose WARNING you get FATAL, ERROR, and WARNING.
iim.log.iim_server.url	im_runtime_base/log/xmppd.log	Location of the server log file. This file needs to be periodically trimmed to prevent disk space from filling up.
iim.log.iim_mux.severity	INFO	Level of logging required for the multiplexor module. The possible values from highest to lowest are: FATAL, ERROR, WARNING, INFO, and DEBUG. If a lower level of logging is chosen, it is implied that you get the higher levels too. That is, if you choose WARNING you get FATAL, ERROR, and WARNING.
iim.log.iim_mux.url	im_runtime_base/log/mux.log	Location of the multiplexor log file. This file needs to be periodically trimmed to prevent disk space from filling up.
iim.log.iim_server.maxlogsize		This parameter contains the maximum size of a server log file. If the log files exceeds the size specified in this parameter then server creates a new file to log in the details.
iim.log.iim_wd.severity	INFO	Level of logging required for the watchdog. The possible values from highest to lowest are: FATAL, ERROR, WARNING, INFO, and DEBUG. If a lower level of logging is chosen, it is implied that you get the higher levels too. That is, if you choose WARNING you get FATAL, ERROR, and WARNING.
iim.log.iim_calendar.severity	INFO	Level of logging required for the Calendar agent. The possible values from highest to lowest are: FATAL, ERROR, WARNING, INFO, and DEBUG. If a lower level of logging is chosen, it is implied that you get the higher levels too. That is, if you choose WARNING you get FATAL, ERROR, and WARNING.

Instant Messaging Server Configuration Parameters

Table A-4 lists and describes the Instant Messaging server configuration parameters.

Table A-4 General Instant Messaging server Configuration Parameters
Parameter	Default Value	Description
iim_server.autosubscribe	FALSE	Indicates whether subscriptions are automatically authorized by the server. The possible values are TRUE and FALSE. If TRUE, subscribe requests are automatically followed by a subscribed response generated by the server. The server then sends the modified roster to the subscriber and the user the subscriber added as a contact. The user and the contact must be in the same domain to use this feature.
iim_server.domainname	host’s domain name	The logical Instant Messaging server domain name you want this server to support. This is the name that is used by other servers in the network to identify this server. It is also the name used by this server to identify its end users to other servers. This is not necessarily the Fully Qualified Domain Name of the system running the Instant Messaging server. For example, if the system iim.xyz.com is the only Instant Messaging server for a company xyz.com, then the domain name is likely to be xyz.com.
iim_server.port	5269	IP address and port for the server to bind to, and to listen for connections from other servers. IP address setting is useful for multi homed machines when you want to use only one particular IP address. If no IP address is listed, this indicates a value of INADDR_ANY on localhost.
iim_server.useport	TRUE	Indicates whether the server should listen on the server-to-server communication port. The possible values are TRUE and FALSE. If TRUE, the server listens on the port defined by iim_server.port or on port 9919, if that is not explicitly defined.
iim_server.sslport	5223	Server’s SSL port used for secure server-to-server communication. Note: The value format is IPaddress:port. If no IP address is listed, this indicates a value of INADDR_ANY on localhost.
iim_server.usesslport	FALSE	Indicates if the server should listen on the server-to-server SSL communication port. The possible values are TRUE and FALSE. If TRUE, the server listens on the port defined by iim_server.sslport or on port 5223, if that is not explicitly defined.
iim_server.clienttimeout	15	Specifies the time, in minutes, before the server discards client connections that are no longer active. For example, when a machine is turned off. The minimum accepted value is 5.
iim_server.usesso	0	This parameter tells the server whether or not depend on the SSO provider during authentication. An SSO provider is a module which the server uses to validate a session id with a SSO service. In portal deployment, Portal Server Session API provides the IM server with the ability to validate session ids sent by the client. The value for this parameter can either be 0, 1,or -1. 0 - do not use the SSO provider (default). 1 - use the SSO provider first and default to LDAP when the SSO validation fails. -1- use SSO provider only without attempting LDAP authentication even when the SSO validation fails. The iim_server.usesso parameter is used in conjunction with the iim_server.ssoprovider parameter.
iim_server.ssoprovider	None	This parameter specifies the class implementing the SSO Provider. If iim_server.usesso is not equal to 0 and this option is not set, the server uses the default Portal Server based SSO Provider.
iim_server.msg_archive	false	This parameter specifies whether the archive provider should be enabled or disabled.
iim_server.msg_archive.provider	None	This parameter contains the list of custom archive providers. This parameter allows multiple values and each value is separated by a comma(,).
iim_server.msg_archive.auto	false	This parameter tells the server whether the end-users' archive control settings can be considered. If the value for this parameter is true, it is equivalent to selecting archive everything option in the User Settings.
iim_server.conversion	false	This parameter specifies whether message conversion should be enabled. It specifies whether the configured list of Message Conversion Providers should be used for message conversion.
iim_server.conversion.provider	None	This parameter contains the list of Message Conversion Providers to be used for message conversion. This parameter allows multiple values with each value is separated by a comma(,).
iim_server.servertimeout	-1	The server can be configured to automatically close the connection opened by a remote server, if the remote server is inactive. This is performed by periodically measuring the time the last request was made by the remote server to the server. The connection to the remote server is terminated, if the time of the last request made by the remote server exceeds the value of the iim_server.servertimeout parameter. The parameter value is in minutes.
iim_server.enable	true	This value should contain whether or not the Instant Messaging server should be enabled. This parameter is set false to enable the Instant Messaging multiplexor.
iim_server.conversion.external.command	None	This parameter contains the external command used for message conversion.
iim_server.stat_frequency	1	This parameter contains the frequency at which the server logs the summary of activities to the log file. The server logs the summary of activities to the log file only if the server minimum log severity is set to INFO or lower. The value is in minutes.
iim_server.secconfigdir	/etc/opt/SUNWiim/default/config	This directory contains the key and certificate databases. It usually contains the security module database.
iim_server.keydbprefix	None	This value should contain the key database filename prefix. The key database file name must always end with key3.db. If the Key database contains a prefix, for example This-Database-key3.db, then value of this parameter is This-Database.
iim_server.certdbprefix	None	This value should contain the certificate database filename prefix. The certificate database file name must always end with cert7.db. If the certificate database contains a prefix, for example Secret-stuff-cert7.db, then value of this parameter is Secret-stuff.
iim_server.secmodfile	secmod.db	This value should contain the name of the security module file.
iim_server.certnickname	Server-Cert	This value should contain the name of the certificate you entered while installing the certificate. The certificate name is case-sensitive.
iim_server.keystorepasswordfile	sslpassword.conf	This value should contain the relative path and the name of the file containing the password for the key database. This file should contain the following line: Internal (Software) Token:password Where password is the password protecting the key database.
iim_server.trust_all_cert	false	If this value is true than the server will trust all certificates and will also add the certificate information into the log files.

Multiple Server Configuration Parameters

For communication between multiple Instant Messaging servers in your network, you need to configure your server to identify itself with the other servers and identify itself with each coserver, or cooperating server, which will have a connection to your server. The coserver identifies itself with its Instant Messaging domain name, host and port number, serverID, and password.

Each cooperating server is given a symbolic name, which is a string consisting of letters and digits, for example, coserver1. Using the symbolic naming convention you can specify multiple servers.

When Instant Messaging servers are configured in this manner, you can form a larger Instant Messaging community. Therefore:

End users on each server can communicate with end users on every other server

Use conferences rooms on other servers

Subscribe to news channels on other servers (subject to access privileges)

Table A-5 lists and describes the multiple server configuration parameters.

Table A-5 Multiple Server Configuration Parameters
Parameter	Default Value	Description
iim_server.serverid	None	String used by this server to identify itself to all other servers.
iim_server.password	None	Password used by this server to authenticate itself to all other servers.
iim_server.coservers	None	Comma separated list containing symbolic names of the servers that can connect to this server. Any meaningful names are allowed, but they must match what you use for the .serverid, .password, and .host parameters. Examples: iim_server.coservers=coserver1,coserver2 or iim_server.coservers=abc,xyz,ntc
iim_server.coserver1.serverid	None	String that identifies the cooperating server represented by the name, coserver1 to authenticate to this server. Note: If you had used abc in the iim_server.coservers list, then the corresponding name for its serverid would be iim_server.abc.serverid.
iim_server.coserver1.password	None	Password used by cooperating server represented by the name, coserver1 to authenticate to this server. Note: If you had used abc in the iim_server.coservers list, then the corresponding name for its password would be iim_server.abc.password.
iim_server.coserver1.host	None	IP address and the port to connect to, for end users on this server to communicate to end users on the server represented by the name coserver1. Note: If you had used abc in the iim_server.coservers list, then the corresponding name for its host would be iim_server.abc.host. Note: The value format is name:port or IPaddress:port.
iim_server.coserver1.usessl	False	Indicates if this server should use SSL to talk to the server identified by coserver1. The possible values are TRUE and FALSE.

Multiplexor Configuration Parameters

Table A-6 lists and describes the multiplexor configuration parameters.

Table A-6 Multiplexor Configuration Parameters
Parameter	Default Value	Description
iim_mux.listenport	multiplexorname or IP address:5222	IP address or FQDN and listening port on which the multiplexor listens for incoming requests from Instant Messenger. The value format is IP_address:port or multiplexorname:port. If no IP address or domain name is listed, this indicates a value of INADDR_ANY on localhost. If you change this value, also change the im.html and im.jnlp files so that they match the port value.
iim_mux.serverport	45222	The IM server and port the multiplexor talks to. The value format is servername:port or IP_address:port.
iim_mux.numinstances	1	Number of instances of the multiplexor. This parameter is valid only for Solaris platforms.
iim_mux.maxthreads	5	Maximum number of threads per instance of the multiplexor.
iim_mux.maxsessions	2000	Maximum number of concurrent connections per multiplexor process.
iim_mux.usessl	off	If the value is set to on, the multiplexor requires an SSL handshake for each connection it accepts, before exchanging any application data.
iim_mux.secconfigdir	/etc/opt/SUNWiim/default/config	The /etc/opt/SUNWiim/default/config is the value of the iim_mux.secconfigdir parameter. This directory contains the key and certificate databases. It usually contains the security module database.
iim_mux.keydbprefix	None	This value should contain the key database filename prefix. The key database file name must always end with key3.db. If the Key database contains a prefix, for example This-Database-key3.db, then value of this parameter is This-Database.
iim_mux.certdbprefix	None	This value should contain the certificate database filename prefix. The certificate database file name must always end with cert7.db. If the certificate database contains a prefix, for example Secret-stuff-cert7.db, then value of this parameter is Secret-stuff.
iim_mux.secmodfile	secmod.db	This value should contain the name of the security module file.
iim_mux.certnickname	Server-Cert	This value should contain the name of the certificate you entered while installing the certificate. The certificate name is case-sensitive.
iim_mux.keystorepasswordfile	/etc/opt/SUNWiim/default/config/sslpassword.conf	This value should contain the relative path and the name of the file containing the password for the key database. This file should contain the following line: Internal (Software) Token:password Where password is the password protecting the key database.
iim_mux.stat_frequency	600	This value should contain the frequency at which the multiplexor logs the summary of activities to the log file.The minimum value is 10 seconds.
iim_mux.enable	true	If the value is true then the multiplexor will run for this instance. If the value is false then the multiplexor will not run for this instance.

Watchdog Parameters

The watchdog monitors the server process and attempts to restart the server if it determines that the server is not running. See Managing the Watchdog Process for more information about the watchdog.

Table A-7 lists and describes the watchdog configuration parameters.

Table A-7 Watchdog Configuration Parameters
Parameter	Default Value	Description
iim_wd.enable	true	Enables the watchdog feature. To reset this parameter or disable the watchdog, set this to false. To avoid conflicts, you should disable the watchdog if you are monitoring the Instant Messaging server using the operating system administration console.
iim_wd.period	300 (seconds)	The watchdog periodically polls the server to check whether it is running. This parameter sets the interval between two status polls.
iim_wd.maxRetries	3 (retries)	Sets the number of times the watchdog will attempt to contact the Instant Messaging server before shutting down and restarting the server. The maximum is ten retries.

Agent Parameters

Agents, such as the Calendar agent, enable functionality within the Instant Messaging server and enhance its interoperability with other Sun Java^TM System servers.

Table A-8 lists and describes agent configuration parameters.

Table A-8 Agent Configuration Parameters
Parameter	Default Value	Description
jms.consumers	None	Used with the Calendar agent. Contains the name of the alarm. The value for this parameter must be set to: cal_reminder
jms.consumer.cal_reminder.destination	None	Used with the Calendar agent. Destination of the alarm. This must be the same as the value of the caldb.serveralarms.url configuration parameter in the ics.conf file. For example, enp:///ics/customalarm
jms.consumer.cal_reminder.provider	None	Used with the Calendar agent. The name of the provider. Typically, this is set to ens. The value for this parameter must be the same as the name in jms.providers.
jms.consumer.cal_reminder.type	None	Used with the Calendar agent. The type of alarm to set. The value for this parameter must be set to: topic
jms.consumer.cal_reminder.param	None	Used with the Calendar agent. The alarm parameter. The value for this parameter must be set as follows including the quotes: "eventtype=calendar.alarm"
jms.consumer.cal_reminder.factory	None	Used with the Calendar agent. A listener that registers itself for the new calendar reminder messages. The value for this parameter must be set to: com.iplanet.im.server.JMSCalendarMessageListener
jms.providers	None	Used with the Calendar agent. The name of the provider. Typically, you set the value of this parameter to ens. This must be the same as the value listed for jms.consumer.cal_reminder.provider.
jms.provider.ens.broker	None	Used with the Calendar agent. Hostname of the ENS and the port number on which the ENS listens for incoming requests. Set to the port specified in the ics.conf file parameter service.ens.port. The default is 57997. For example: jms.provider.ens.broker=cal.example.com:57997
jms.provider.ens.factory	None	Used with the Calendar agent. Factory class used for creating the topic connection objects. The value for this parameter must be set to: com.iplanet.ens.jms.EnsTopicConnFactory
iim_agent.enable	None	If TRUE or absent from iim.conf, enables Instant Messaging agents. Set the value to FALSE to disable all agents.
iim_agent.agent-calendar.enable	None	Used with the Calendar agent. If TRUE or absent from iim.conf, loads a component that enables the Calendar agent specifically.
agent-calendar.jid	None	The JID of the Calendar agent.
agent-calendar.password	None	The Calendar agent password.
iim_server.components	None	Describes the Calendar agent as a component of the Instant Messaging server. The value of this parameter must be set to: agent-calendar

Previous Contents Index Next

Previous Contents Index Next
Sun Java System Instant Messaging 7 2005Q1 Administration Guide