Instant Messaging Configuration Parameters in iim.conf

Skip to end of metadata
Go to start of metadata

Oracle Communications Instant Messaging Server Configuration Parameters in iim.conf

This chapter explains the Instant Messaging configuration parameters in the iim.conf file in the following sections:

iim.conf File Location

Instant Messaging stores configuration settings in the iim.conf file within the Configuration Directory (im-cfg-base).

  • On Solaris OS:
    /etc/opt/SUNWiim/default/config/iim.conf
  • On Red Hat 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. See Creating Multiple Instances from a Single Instant Messaging Installation for more information.

iim.conf File Syntax

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 iim.conf, 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/default
Linux: /var/opt/sun/im/default
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. The name of the /default directory may vary if you created multiple instances of Instant Messaging.
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 character set 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 its 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.cache.validity 10 Defines the cache validity interval (in minutes) for a single user's information. The Instant Messaging server saves the last date a single end-user's information was cached. If the end-user's information is accessed after the interval determined by this parameter, the server will recache the end user's information and reset the cache date on the LocalUser object.
iim.policy.modules iim_ldap

Starting with Instant Messaging 8 Update 3, the value identity which indicates that the Sun Java System Access Manager is used for policy storage, has been deprecated.

By default, LDAP is used for policy storage. The property iim.policy.modules must be set to iim_ldap_schema1 or iim_ldap_schema2 only if hosted domain support is required. If you configure Instant Messaging via the configurator, the possible values are identity and iim_ldap. The allowed values which can be manually set for iim.policy.modules are, identity, iim_ldap, iim_ldap_schema1, and iim_ldap_schema2. Only in the absence of hosted domain support, can iim_ldap be used as a value for iim.policy.modules for both schema1 and schema2 of the LDAP server.
Note
The iim_ldap_schema1 and iim_ldap_schema2 properties must be set in conjunction with other parameters mentioned in Configuring Hosted Domain Support.
iim.policy.resynctime 720 Defines the cache validity interval (in minutes) for all end-user information. 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 at which the cached end-user information is cleared.
iim.userprops.store file By default, user properties are stored in a user properties file if you chose not to use Access Manager for policy when you ran the configure utility. If you chose to use Access Manager for policy, the default is ldap. Change the value to change the location where user properties are stored. If you change this from file to ldap, you need to run imadmin assign_services to add required objectclasses to user entries in the directory. This parameter is only significant when the service definitions for the Presence and Instant Messaging services have been installed.
Note

In Convergence, if the Instant Messaging server is configured with a user properties file, end users are unable to upload Avatars. When using Instant Messaging in Convergence, the iim.userprops.store parameter should be set to ldap not file in iim.conf.

iim_wd.jvm.maxmemorysize 256 The maximum heap size in MB the JVM running the watchdog is allowed to use. Used to construct the -mx argument of the Java command.
iim_mux.jvm.maxmemorysize 256 The maximum heap size in MB the JVM running the multiplexor is allowed to use. Used to construct the -mx argument of the Java command.
iim_server.classpath custom classpath used by imadmin Can be used to append any additional jar files to the existing classpath of the server process.

LDAP and User Registration Configuration Parameters

Table A-2 lists and describes the parameters used by Instant Messaging for LDAP, user registration, and user source configuration.

Table A-2 LDAP, User Registration, and 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. The entire filter is entered as one line.
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. The entire filter is entered as one line.
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.user.attributes None LDAP attribute that contains the list of custom attributes from the LDAP user entry.
iim_ldap.group.attributes 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 you chose to leverage an Access Manager deployment for policy when you ran the configure utility. Otherwise, the default value is false. If the value is true then the Access Manager Administrator credentials will be used to bind to the Directory
Server.
iim.register.enable None 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 None 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 None The domain to which new users will be added. For example, directory.siroe.com.

Logging Configuration Parameters

Table A-3 lists and describes the logging configuration parameters for both log4j-based logging and iim.conf parameter-based logging.

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. For example, 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. For example, 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_mux.maxlogfiles 10 The maximum number of log files to store for the multiplexor. Once this number is exceeded, the oldest multiplexor log file is deleted.
iim.log.iim_mux.maxlogfilesize 10 MB This parameter contains the maximum size of a multiplexor log file. If the log files exceeds the size specified in this parameter then a new log file is created.
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 a new log file is created.
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. For example, if you choose WARNING you get FATAL, ERROR, and WARNING.
iim.log.agent-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. For example, if you choose WARNING you get FATAL, ERROR, and WARNING.
iim.log4j.config im-cfg-base Specifies the location and name of the log4j configuration file. If no value exists for this parameter, the logger will look for log4j.conf in im-cfg-base. If the logger does not find log4j.conf in im-cfg-base, it uses the parameter-based logging method, instead of log4j.

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 5269, 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 The default value is 1, if you chose to leverage an Access Manager deployment for SSO when you ran the configure utility. Otherwise, the default value is 0. This parameter tells the server whether or not to depend on the SSO provider during authentication. An SSO provider is a module the server uses to validate a session ID with a SSO service.The Access Manager Session API provides the Instant Messaging server with the ability to validate session IDs sent by the client.The value for this parameter can either be 0 or 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 Specifies the class implementing the com.sun.im.provider.SSOProvider interface. If iim_server.usesso is not equal to 0 and this option is not set, the server uses the default Access Manager-based SSO Provider.
iim.policy.modules The default value is identity, if you chose to leverage an Access Manager deployment for policy when you ran the configure utility. Otherwise, the default value is iim_ldap. If the value is identity, indicates that Sun Java System Access Manager is used for policy storage. If the value is iim_ldap, directory is used.
iim.userprops.store file If the value is file, indicates that the user properties are stored in a user properties file. If the value is ldap, directory is used.
iim_server.msg_archive false This parameter specifies whether the archive provider should be enabled or disabled. Set this value to false to disable all archiving. Set the value to true to enable all archiving, including Portal, email, and any custom archive provider you want to use.
iim_server.msg_archive.provider None This parameter contains the list of archive providers. This parameter allows multiple values and each value is separated by a comma (,). If you are using the Portal Server Search based archive, the value should be com.iplanet.im.server.IMPSArchive. If you are using email archiving, the value should be com.iplanet.im.server.EmailIMArchive.
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.conversion.external.command None Contains the external command used for message conversion. The iim_server.conversion.external.command parameter is used only in the default implementation of the Message Conversion API, which is com.iplanet.im.server.ExternalDocumentConverter. This implementation invokes an external third party application. To use this parameter, you must set the class com.iplanet.im.server.ExternalDocumentConverter as the provider class, and set the parameter iim_server.conversion.external.command="your_external_app_command %i %o", where %i and %o will automatically be replaced by the actual input/output file names generated dynamically by ExternalDocumentConverter. For example, if a conversion application is located at /usr/local/bin/convert, use iim_server.conversion.external.command="/usr/local/bin/convert %i %o.
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 defines whether or not the Instant Messaging server is enabled. This parameter is set false to enable the Instant Messaging multiplexor.
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.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.sslkeystore None Contains the relative path and filename for the server's Java keystore (JKS). For example,
/im-cfg-base/server-keystore.jks
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.requiressl false If true, the server will terminate any connection that does not request a TLS connection after the initial stream session is set up. This includes connections from clients, other servers, and server components, such as the XMPP/HTTP Gateway and agents, except the multiplexor.
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.
iim_server.deliverofflinechat false Determines whether the capability is on or off. To enable the feature for the entire deployment, set the iim_server.deliverofflinechat parameter to true, and do not set deliverofflinechat.domain parameter. To disable the feature for the entire deployment, set the iim_server.deliverofflinechat parameter to false, and do not set deliverofflinechat.domain parameter.
deliverofflinechat.domain None This parameter is used to blacklist or whitelist a domain. To blacklist a domain, set the iim_server.deliverofflinechat parameter to true, and set the deliverofflinechat.domain parameter to list of domains to be blacklisted. To whitelist a domain, set the iim_server.deliverofflinechat parameter to false, and set the deliverofflinechat.domain parameter to list of domains to be whitelisted.
deliverofflinechat.maxsize 50 This parameter is used to determine the maximum queue size related to the Receiver, and must be a positive integer.

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, server ID, 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 do the following:

  • 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. For example, if you 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. For example,
if you 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. For example, if you used abc in the iim_server.coservers
list, then the corresponding name for its host would be
iim_server.abc.host. The format is name:port or IPaddress:port.
iim_server.{}coserver1{}.requiressl False Indicates if this server should require TLS
when communicating with the server identified by coserver1.
The possible values are TRUE and FALSE.
Note : This parameter can be used only with Server to Server Communication and Static ServerPool Configurations. It cannot be used with Shoal configuration since the co-servers are discovered on the fly with Shoal.
iim_server.coservers.requiressl False Indicates if this server should require TLS when communicating with the co-servers. The possible values are TRUE and FALSE.
iim_server.openfederation.enabled None To enable open federation, set the parameter to true. To disable open federation, set the parameter to false. For example:
iim_server.openfederation.enabled = "true"
By default, open federation is not enabled. If the parameter is not in iim.conf, add it. Once configured, the server's users will be able to communicate with users on any other Instant Messaging server that is likewise configured.

Shoal Configuration Parameters

You can use the Shoal clustering framework to automatically discover and add peer servers in a server pool.
Table A-6 lists and describes the shoal configuration parameters.

Table A-6 Shoal Configuration Parameters
Parameter Default Required? Description
iim_server.peer.autodiscover false No The parameter that enables auto-discovery using Shoal. It is recommended to delete all static co-server definitions before setting this to true.
iim_server.serverid None Yes The ID that uniquely identifies the server instance within the pool. It could be an identifier such as server1, or a host name.
iim_server.password None Yes The password that is shared across the pool and enables identification of members of one pool from the other. Also ensures that unidentified members of a Shoal group can not join the pool.
iim_server.hostname local-hostname:5269 No The connection string that the other pool members can establish connections with. It is the host name and port of the specified server.
iim_server.pool.groupname iim.server.pool No The Shoal group name that the peers will attempt to join. You will need to change the default only if multiple clusters of peer servers need to run on the same subnet.

For Shoal Across Subnets

Parameter Default Required? Description
relay.imadmin.enable true Yes Starts the relay server.
relay.listen_address=<address of relay server> None Optional Specifies the address of the relay server.
relay.uri_list None Yes Displays the list of relay servers added.

Multiplexor Configuration Parameters

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

Table A-7 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 IPaddress:port or multiplexorname:port.
If no IP address or domain name is listed, INADDR_ANY on localhost
is assumed.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 Instant Messaging server and port the multiplexor
communicates to. The value format is
servername:port or IPaddress: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 This directory contains the key and certificate databases.
In addition, it also usually contains the security module
database. The name of the /default directory may vary if you
created multiple instances of Instant Messaging.
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 Multiplexor-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. The name of the
/default directory may vary if you created multiple
instances of Instant Messaging.
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.

Redirect Server Parameters

Table A-8 lists the parameters you use to administer the Instant Messaging redirect server.

Table A-8 Redirect Server Parameters
Parameter Default Value Description
iim_server.redirect.provider None Comma-separated list of redirect provider names or classes that implement the com.sun.im.provider.Redirector interface. Any value for this parameter defines the server instance as a redirect server. Supported values include db, roundrobin, regex, and class names that implement the com.sun.im.provider.Redirector interface.
iim_server.redirect.to None Comma-separated list of nodes to which this redirect server may redirect client connections. Node names can be any alphanumeric string. This list may be a superset of the hosts defined in iim_server.redirect.to.nodename.host.
iim_server.redirect.to.nodename.host None Where nodename is the name of the node as it exists in iim_server.redirect.to. This attribute is required for nodename to be used by the redirect server.
iim_server.redirect.to.nodename.usessl False If true, then nodename is configured to use legacy SSL. See Overview of Using TLS and Legacy SSL in Instant Messaging for more information.
iim_server.redirect.db.users im-db-base/redirect.db Name and location of the redirect database.
iim_server.redirect.db.partitions im-cfg-base/redirect.partitions Name and location of the redirect partitions file.
iim_server.redirect.db.partitionsize 5000 The maximum number of users in a partition.
iim_server.redirect.roundrobin.partitions im-cfg-base/redirect.partitions Name and location of the redirect partitions file.
iim_server.redirect.pollfrequency   The interval between connections made by the redirect server to the hosts defined in the redirect.hosts file. The redirect server polls these hosts to determine if they are online and able to accept client connections.

Archive Parameters

Table A-9 lists the parameters you use to manage Instant Messaging archiving.

Table A-9 Archive Parameters
Parameter Default Value Description
iim_arch.title.attr Title This parameter contains the name of the field equivalent to the Title field in the default schema of the Portal Server Search.
iim_arch.keyword.attr Keyword This parameter contains the name of the field equivalent to the Keyword field in the default schema of the Portal Server Search.
iim_arch.readacl.attr ReadACL This parameter contains the name of the field equivalent to the ReadACL field in the default schema of the Portal ServerSearch.
iim_arch.description.attr Description This parameter contains the name of the field equivalent to the Description field in the default schema of the Portal Server Search.
iim_arch.fulltext.attr Full-Text This parameter contains the name of the field equivalent to the Full-Text field in the default schema of the Portal Server Search.
iim_arch.category.attr Category This parameter contains the name of the field equivalent to the Category field in the default schema of the Portal Server Search.
iim_arch.readacl.admin None This parameter contains the administrator's DN. Multiple values should be separated by a semi colon ( ; ).
iim_arch.readacl.adminonly false This parameter will contain true or false.
true - Only the administrator's DN specified by the parameter iim_arch.readacl.admin will be added to the ReadACL field overwriting the default behavior of the ReadACL field.
false - The administrator's DN specified by the parameter iim_arch.readacl.admin will be added to the ReadACL field in addition to the default behavior.
iim_arch.categories all This parameter contains a list of message types that can be archived.The value can be:pollalertchatconference{{news}}Multiple values can be specified separated by commas (,).
iim_arch.categoryname None If a category name is not assigned for any of the categories then the value of this parameter is used as the category name.
iim_arch.alert.categoryname None This parameter contains the name of the category containing the archived alert messages.It is not required to dedicate a category to alert messages.
iim_arch.poll.categoryname None This parameter contains the name of the category containing the archived poll messages.It is not required to dedicate a category to poll messages.
iim_arch.conference.categoryname None This parameter contains the name of the category containing the archived conference messages.It is not required to dedicate a category to conference messages.
iim_arch.chat.categoryname Name This parameter contains the name of the category containing the archived chat messages.It is not required to dedicate a category to chat messages.
iim_arch.news.categoryname None This parameter contains the name of the category containing the archived news messages.It is not required to dedicate a category to news messages.
iim_arch.conference.quiettime 5 This parameter contains the maximum duration of silence between two consecutive messages in a room (both public and private) after which the RD expires and a new RD is created for archiving the message. The value is in minutes.
iim_arch.poll.maxwaittime 15 This parameter contains the (maximum) time for which poll data is buffered in the server. The value is in minutes.
iim_arch.ignoreexplicitdeny true This parameter will contain true or false.
true - For Poll and Conference category the data with explicit deny access will not be archived. Each time when these messages are not archived this information will be logged into the xmppd.log file.
false - For Poll and Conference category the data with explicit deny access will not be archived and the message will be added to the Portal Server Search database.Note: If you do not explicitly deny access to a room or a news channel then the default access is either READ or WRITE or MANAGE. Some end users can also be granted NONE access.
iim_arch.portal.search None The value of the this parameter should be the URL of the Portal Server Search servlet. For example: http://www.example.com/portal/search. If this parameter is not present then the Archive Provider determines the value of the Portal Server Search URL based on the AMConfig.properties file present on the system.
iim_arch.portal.admindn None The value of this parameter should be the DN of the admin user. For example: uid=amadmin,ou=People,o=internet. This parameter is required when the Document level Security in the Portal Server Server is on.
iim_arch.portal.adminpassword None The value of this parameter should be the password of the administrative user as specified by the iim_arch.portal.admindn parameter. This parameter is required when the Document level Security in the Portal Search Server is on.
iim_arch.portal.search.database None The value of this parameter should be the name of the database where the Instant Messaging server stores archived messages. If this parameter is not defined then all messages are stored in the default database of Portal Server Search.
iim_arch.admin.email Empty String Comma-separated list of administrator email addresses.
iim_arch.alert.admin.email None Comma-separated list of administrator email addresses to which all archived alert messages will be sent. This parameter overrides iim_arch.admin.email for alert messages.
iim_arch.chat.admin.email None Comma-separated list of administrator email addresses to which all archived chat messages will be sent. This parameter overrides iim_arch.admin.email for chat messages.
iim_arch.conference.admin.email None Comma-separated list of administrator email addresses to which all archived conference messages will be sent. This parameter overrides iim_arch.admin.email for conference messages.
iim_arch.poll.admin.email None Comma-separated list of administrator email addresses to which all archived poll messages will be sent. This parameter overrides iim_arch.admin.email for poll messages.
iim_arch.news.admin.email None Comma-separated list of administrator email addresses to which all archived news messages will be sent. This parameter overrides iim_arch.admin.email for news messages.
iim_arch.email.archiveheader.name None Name of the extended RFC 822 header.
iim_arch.email.archiveheader.value all Value corresponding to the header name for iim_arch.email.archiveheader.name.

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

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

Table A-10 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 Sets the number of retries, times the watchdog will attempt to contact the Instant Messaging server, before shutting down and restarting the server. The maximum is ten retries.

Monitoring Parameters

The parameter in Table A-11 configures how the server interacts with the Sun Java Enterprise System Monitoring Framework.

Table A-11 Monitoring Parameters
Parameter Default Value Description
iim_server.monitor.enable false Used by the Sun Java Enterprise System Monitoring Framework. If true, configures the server to make its activities available to mfwk. Otherwise, the server does not make its activities available.
iim_server.monitor.htmlport None If specified, opens the JMX HTML adaptor port on the specified port. By default, this port is not enabled as opening this port can present a security risk.

Agent Parameters

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

Table A-12 lists and describes agent configuration parameters.

Table A-12 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 the jms.providers parameter.
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 for the jms.consumer.cal_reminder.provider parameter.
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 service.ens.port parameter. 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 as follows. Enter the value on a single line:com.iplanet.ens.jms.EnsTopicConnFactory
iim_agent.enable False If TRUE, iim.conf, enables Instant Messaging agents. Set the value to FALSE, or remove the parameter from iim.conf 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 Defines the password with which the Calendar agent connects to the Instant Messaging server.
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
agent-calendar.imadmin.enable false Start the agent-calendar by using the imadmin command if set to true.
agent-calendar.iim_server.host   Host name of the Instant Messaging server with which the agent calendar
communicates.
agent-calendar.iim_server.port   Port number of the Instant Messaging server with which the agent calendar
communicates.

HTTP/XMPP Gateway Parameters

Table A-13 lists the parameters you use to bind to the HTTP/XMPP gateway.

Table A-13 HTTP/XMPP Gateway Parameters
Parameter Default Value Description
iim_agent.httpbind.enable false Set to true to enable the HTTP/XMPP gateway.
httpbind.jid   A jabber ID (JID) to bind the HTTP/XMPP gateway.
httpbind.password   Password to authenticate the HTTP/XMPP gateway to the Instant Messaging server.

SMS Integration Parameters

Table A-14 lists the SMS integration parameters.

Table A-14 SMS Integration Parameters
Parameter Default Value Description
smsgw.imadmin.enable false Enables or disables the SMS gateway. If set to true, you can start the SMS gateway by using the imadmin command.
smsgw.jid None A jabber ID (JID) to bind the SMS gateway to the Instant Messaging server. The value of this parameter should be the same as the value that you define for the smppbind.jid parameter.
smsgw.password   Password to authenticate the SMS gateway to the Instant Messaging server. The value of this parameter should be the same as the value that you define for the smppbind.password parameter.
smsgw.iim_server None Hostname and port number of the Instant Messaging server.
smsgw.sms_limit -1 Number of messages that can be sent per hour. The default value is -1 and it indicates that unlimited number of SMS messages that can be sent per hour.
smsgw.sms_queue_capacity 512 Maximum number of messages that can be queued for SMS delivery.
smsgw.im_char_limit 500 Maximum number of characters that you can specify in one message. If the number of characters is greater than the specified value, the message is rejected.
smpp.smsc_ip_address None IP address or hostname of the SMSC.
smpp.smsc_port 2775 Port number of the SMSC.
smpp.bind_id None Identifier used to bind the SMS gateway to the SMSC.
smpp.bind_password   Password to authenticate the SMS gateway to the SMSC.
smpp.sender_id None Sender ID of the outgoing SMS.
iim_server.components None List of component identifiers that should have smppbind. For example, httpbind, smppbind.
iim_agent.smppbind.enable false Enables the Instant Messaging server to identify the SMS gateway.
smppbind.jid None A jabber ID (JID) for binding the SMS gateway to the Instant Messaging server.
smppbind.password   Password to authenticate the SMS gateway to the Instant Messaging server.

MSN Gateway Integration Parameters

As of Instant Messaging 9.0.1.4.0, the MSN gateway is deprecated: it may be removed in a future release.

Table A-15 lists the MSN gateway integration parameters.

Table A-15 MSN Gateway Integration Parameters
Parameter Default Value Description
iim_agent.msn_gateway.enable false Set to true to enable the MSN gateway on IM server.
msn_gateway.jid msn.$domainname A jabber ID (JID) for binding the MSN gateway to the Instant Messaging server.
msn_gateway.password random Password to authenticate the MSN gateway to the Instant Messaging server.
msn_gateway.imadmin.enable false If set to true, you can start the MSN gateway by using the imadmin start command.

AIM Gateway Integration Parameters

As of Instant Messaging 9.0.1.4.0, the AIM gateway is deprecated; it may be removed in a future release.

Table A-16 lists the AIM gateway integration parameters.

Table A-16 AIM Gateway Integration Parameters
Parameter Default Value Description
iim_agent.aim_gateway.enable false Set to true to enable the AIM gateway on IM server.
aim_gateway.jid aim.$domainname A jabber ID (JID) for binding the AIM gateway to the Instant Messaging server.
aim_gateway.password random Password to authenticate the AIM gateway to the Instant Messaging server.
aim_gateway.imadmin.enable false If set to true, you can start the AIM gateway by using the imadmin start command.

Yahoo Gateway Integration Parameters

As of Instant Messaging 9.0.1.4.0, the Yahoo gateway is deprecated; it may be removed in a future release.

Table A-17 lists the Yahoo gateway parameters.

Table A-17 Yahoo Gateway Parameters
Parameter Default Value Description
iim_agent.yim_gateway.enable false Set to true to enable the Yahoo gateway on IM server.
yim_gateway.jid yim.$domainname A jabber ID (JID) for binding the Yahoo gateway to the Instant Messaging server.
yim_gateway.password random Password to authenticate the Yahoo gateway to the Instant Messaging server.
yim_gateway.imadmin.enable false If set to true, you can start the Yahoo gateway by using the imadmin start command.

IMPS Gateway Parameters

Table A-18 lists the IMPS gateway parameters.

Table A-18 IMPS Gateway Parameters
Parameter Default Value Description
iim_ldap.sasl.mechanism.factories "com.iplanet.im.server.sasl.IMPSSASLProviderFactory" Parameter to specify the mechanism that will be used for authentication.
iim_ldap.userpasswordattr "userpassword" Specifies the field that should be used for authentication. By default, "userpassword" is used for authentication.

Java Message Queue (JMQ) Parameters

Table A-19a lists the JMQ parameters
This table lists some of the Java Message Queue (JMQ) parameters that need to be specified.

Table A-19a JMQ Parameters
Parameter Value
(including the quotation mark)
Description
JMS Consumers section    
jms.consumers "cal_reminder2" Name of the alarm. By default, jms.consumers is commented out in the iim.conf file. Make sure to uncomment this line.
jms.consumer.cal_reminder2.provider "jmq" Name of the provider. Java Message Queue should be mentioned as a provider. The string jmq is used in the agent code to instantiate the Java Message Queue specific classes.
jms.consumer.cal_reminder2.type "topic" The type of the alarm to set.
jms.consumer.cal_reminder2.factory "com.iplanet.im.server.JMSCalendarMessageListener" The name of the C++ factory.
jms.consumer.cal_reminder2.destination "testTopic" Destination of the alarm. The destination type is topic. The topic can be administratively created or the Java Message Queue provider can be configured to create a topic for publishing a message to it. When the Calendar agent starts, it tries to subscribe to the configured topic. If the topic is not already present in the Java Message Queue broker, the Calendar agent fails to subscribe to the topic. Therefore, it is necessary to start the Java Message Queue broker and create the topic before starting the Calendar agent. For the commands to start the Java Message Queue broker and create a topic, see Some Useful Java Message Queue Commands.
JMS Providers section    
jms.providers "jmq" The name of the provider.
jms.provider.jmq.broker "yourJMQserver:port" Port number that the Java Message Queue server listens to. jms.provider.jmq.broker should be the fully qualified host name or IP address and port that your Java Message Queue server is listening on. For example, localhost:7676 or jmqhost.beta.comms.com
jms.provider.jmq.factory "com.sun.messaging.TopicConnectionFactory" Name of the C++ factory.
jms.provider.jmq.jmsuser "guest" The user ID of the JMS user. A Java Message Queue user is created in the Java Message Queue provider user database. If access to the Java Message Queue provider or the topic is controlled, specify the username. The username is provided by the Calendar agent while establishing connection with the Java Message Queue provider. If this parameter is not specified, the agent tries to connect anonymously.
jms.provider.jmq.jmspswd "passwd" The password of the JMS user.
iim_agent.enable "true" Enables agents for Instant Messaging. Set the value to iim_agent.enable="true".
iim_agent.agent-calendar.enable "true" Loads a component that enables the Calendar agent. Set the value to iim_agent.agent-calendar.enable="true".
agent-calendar.jid calendar.siroe.com Java ID of the Calendar agent. Set the value to agent-calendar.jid=calimbot.server.domain.
agent-calendar.password   Password you want the Calendar agent to use to connect to the Instant Messaging server. Set the value to agent-calendar.password=password.
iim_server.components agent-calendar,httpbind Set the value to iim_server.components=agent-calendar.
agent-calendar.imadmin.enable "false" Start the agent-calendar by using the imadmin command if set to true.
agent-calendar.iim_server.host   Host name of the Instant Messaging server with which the agent calendar communicates.
agent-calendar.iim_server.port   Port number of the Instant Messaging server with which the agent calendar communicates.

Conference History Parameters

Table A-20 Conference History Parameters
Parameter Default Value Description
iim_server.conference.history.maxstanzas 10 Maximum number of stanzas persisted by the server for a given conference.
iim_server.conference.history.maxstanzas.default 0 Number of stanzas sent to joining user.
iim_server.conference.history.persist true Enables conference history and stores it on persistent storage.
Labels:
ldap ldap Delete
reference reference Delete
monitoring monitoring Delete
logging logging Delete
watchdog watchdog Delete
multiplexor multiplexor Delete
instantmessaging instantmessaging Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. May 25, 2011

    The maxstanzas setting restrict the number of complete conference history messages that are sent to the client:

    http://xmpp.org/extensions/xep-0045.html#enter-managehistory

    Further details (default/valid settings, other related undocumented conference room settings) will need to be provided by the developers. I don't have access to the code/internal documentation anymore.

    Thanks,

    Shane.

  2. Aug 01, 2012

    I see two available values for iim.policy,modules: "identity" and "iim_ldap". But, when you install CommSuite 7u2, this property is set to "iim_ldap_schema2". This should be documented (including the difference between "iim_ldap" and "iim_ldap_schema2").

    What are all possible values for the iim.policy.modules parameter?

    Thank you,

    Ivan

    1. Aug 10, 2012

      Hi Ivan,

       The property iim.policy.modules must be set to "iim_ldap_schema2" or "iim_ldap_schema1" only if hosted domain support is needed.See this document for more details  - https://wikis.oracle.com/display/CommSuite/Configuring+Hosted+Domain+Support .

      When you configure IM via configurator the possible values are "identity" and "iim_ldap" depending on your choice.

      Otherwise the allowed values which can be set manually for the property iim.policy.modules is "identity","iim_ldap","iim_ldap_schema1" and "iim_ldap_schema2".

      Note: "iim_ldap_schema1" and "iim_ldap_schema2" must be set in conjunction with other parameters mentioned in https://wikis.oracle.com/display/CommSuite/Configuring+Hosted+Domain+Support .

      HTH,

      Swetha

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Oracle community and they might not be employed or in any way formally affiliated with Oracle. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Oracle nor any other party necessarily agrees with them.