Sun Java System Instant Messaging 7 2005Q1 Administration Guide |
Appendix A
Instant Messaging Configuration ParametersThis chapter explains the Instant Messaging configuration parameters in the following sections:
Using the iim.conf fileInstant Messaging stores configuration settings in the iim.conf file within the Configuration Directory (im_cfg_base).
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.
General Configuration ParametersTable A-1 lists and describes the general configuration parameters.
User Source Configuration ParametersTable A-2 lists and describes the user source configuration parameters.
Logging Configuration ParametersTable A-3 lists and describes the logging configuration parameters.
Instant Messaging Server Configuration ParametersTable A-4 lists and describes the Instant Messaging server configuration parameters.
Multiple Server Configuration ParametersFor 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:
Table A-5 lists and describes the multiple server configuration parameters.
Multiplexor Configuration ParametersTable A-6 lists and describes the multiplexor configuration parameters.
Watchdog ParametersThe 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.
Agent ParametersAgents, such as the Calendar agent, enable functionality within the Instant Messaging server and enhance its interoperability with other Sun JavaTM 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