| Oracle® Communications Instant Messaging Server System Administrator's Guide Release 9.0.2 E52523-01 |
|
|
PDF · Mobi · ePub |
| Oracle® Communications Instant Messaging Server System Administrator's Guide Release 9.0.2 E52523-01 |
|
|
PDF · Mobi · ePub |
This chapter covers the Oracle Communications Instant Messaging Server configuration properties that are stored in the iim.conf.xml file.
Instant Messaging Server stores configuration settings in the iim.conf.xml file within the configuration directory (InstantMessaging_cfg). The default is: /etc/opt/sun/comms/im/default/config/iim.conf.xml.
If you created multiple instances of Instant Messaging Server, the name of the /default directory varies depending on the instance. See the topic on creating multiple instances from a single Instant Messaging Server installation in Instant Messaging Server Installation and Configuration Guide.
Instant Messaging Server 9 merges its multiple configuration files into one file, the iim.conf.xml file.
A set of common properties is used across the Instant Messaging Server deployment or instance, including instancedir, installdir, and so on.
Each component has its own configuration section in the file, for example, a server section, a mux section, and so on.
Some configuration properties are complex, in the sense that they have more than one instance, and each instance has one or more keys.
When you run the imconfutil command, the iim.conf.xml file is updated. You must refresh Instant Messaging Server for the new configuration settings to take effect.
Note:
The iim.conf.xml file is initialized by the installation process and should be modified only as described in this documentation.Note:
The new configuration system has backward compatibility. If support for any key is not available with imconfutil, or if a property is not found in the iim.conf.xml file, it uses the old iim.conf as a fallback. If you want to upgrade from releases prior to Instant Messaging Server 9, you must copy im.conf-pre9 to iim.conf for the fallback to work.Table 27-1 lists and describes the general configuration properties.
Table 27-1 General Configuration Properties
| Property | Default Value | Description |
|---|---|---|
|
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/sun/comms/im/ Red Hat Linux and Oracle 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 Server. |
|
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 |
Specifies whether the headers of the mail are in ASCII and not encoded. It contains the name of the character set to use to encode the headers of the mail message sent out for offline alerts. For example: iim.mail.charset=iso-2022-jp |
|
iim.jvm.command |
None |
The location of the Java Runtime Executable (JRE). |
|
iim.policy.cachevalidity |
10 |
Defines the cache validity interval (in seconds) for a single user's information. 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 property, the server will recache the end user's information and reset the cache date on the LocalUser object. |
|
iim.policy.modules |
iim_ldap |
By default, LDAP is used for policy storage. |
|
iim.userprops.store |
ldap |
Indicates whether the user properties are in a user properties file or stored in LDAP. Only significant when the service definitions for the Presence and Instant Messaging services have been installed. Value can be one of the following:
In Convergence, if Instant Messaging Server is configured with a user properties file, end users are unable to upload Avatars. When using Instant Messaging Server in Convergence, the iim.userprops.store property should be set to ldap, not file. |
|
iim_server.db_path |
iim.instancevardir/db |
File system location for the server to store user properties. Used by the propstore file. |
|
iim_server.scratch_directory |
iim.instancevardir/scratch |
Specifies the directory in which Instant Messaging Server can store transient data. |
|
iim_gwc.enable |
no |
Controls whether the imadmin command starts the Gateway Connector process. |
|
iim_gwc.hostport |
Hostname:55222 |
Specifies the host and port of the Gateway Connector process. |
|
iim_gwc.maxchannels |
10000 |
Specifies the maximum number of channels for the Gateway Connector process. |
|
iim_gwc.jvm.options |
None |
Specifies the options to be passed to the Java virtual machine when starting the Gateway Connector process. |
|
iim_.jid.encoding. |
true |
Controls whether the server uses the standard JID encoding scheme or an older scheme that is compatible with older server versions. |
|
iim_server.jvm.options |
None |
Specifies the options to be passed to the Java VM when starting the server. |
|
iim_server.maxsessions |
Equal to iim_mux.maxsessions by default. If iim_mux. |
The maximum number of client sessions that the server can handle. Needs to be equal to at least the sum of all the multiplexor maxsessions. |
|
iim_server.maxthreads |
50 |
The maximum number of threads used by the server. |
|
iim_server.memory.user. |
false |
Specifies whether user cache count is enabled. |
|
iim_server.component.requiressl |
false |
Specifies whether all component connections must be encrypted. |
|
iim_server.classpath |
Includes custom paths in the classpath of the server. |
No description |
|
iim_server.conference.servicename |
muc |
Sets the conference service name. |
|
iim_server.sasl.usemechanism. |
false |
Enables the DIGEST-MD5 authentication mechanism. |
|
iim_server.filter.enable |
false |
Specifies whether the file filter providers should be enabled or disabled. |
|
iim_server.filters |
false |
Specifies the list of file filter providers. |
|
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 property to true, and do not set deliverofflinechat.domain property. To disable the feature for the entire deployment, set the iim_server.deliverofflinechat property to false, and do not set deliverofflinechat.domain property. |
|
iim_server.peerpingtimeout |
300 |
Specifies the time in seconds that the server waits for a ping response from the peer. If set to a value less than or equal to 0, ping between the peers is disabled. |
|
iim_server.enablegroupsinconference |
false |
Enables and disables the use of groups in multi-user chat rooms. |
|
deliverofflinechat.domain |
None |
Used to blacklist or whitelist a domain. To blacklist a domain, set the iim_server.deliverofflinechat property to true, and set the deliverofflinechat.domain property to the list of domains to be blacklisted. To whitelist a domain, set the iim_server.deliverofflinechat property to false, and set the deliverofflinechat.domain property to the list of domains to be whitelisted. |
|
deliverofflinechat.maxsize |
50 |
Determines the maximum queue size related to the Receiver. |
|
iim_ldap.sasl.mechanism.factories |
None |
Specifies 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. |
Table 27-2 lists and describes the properties used by Instant for LDAP, user registration, and user source configuration.
Table 27-2 LDAP, User Registration, and Source Configuration Properties
| Property | Default Value | Description |
|---|---|---|
|
iim_ldap.host |
localhost:389 |
LDAP server name and port used by Instant 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.userbrowsefilter |
(objectclass=inetorgperson) |
Specifies LDAP filter to be applied when browsing users. |
|
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.usergroupbymailsearchfilter |
(|(&(objectclass=groupofuniquenames)(mail={0}))(&(objectclass=inetorgperson)(mail={0}))) |
The search filter that returns a group, given a mail address. |
|
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)(cn={0})) |
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.resynctime |
720 |
Maximum time in seconds that data fetched from LDAP is held before resyncing. |
|
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 |
|
LDAP attribute that should contain end users' provisioned email addresses. Used when the email message is sent to an offline end user. |
|
iim_ldap.usermobileattr |
mobile |
LDAP attribute that contains end users' mobile phone numbers. |
|
iim_ldap.groupmemberattr |
uniquemember |
LDAP attribute that contains the group member DNs. |
|
iim_ldap.groupmemberurlattr |
memberurl |
The membership attribute of a dynamic group, which contains the LDAP filter or the LDAP URL. |
|
iim.register.enable |
None |
If TRUE, the server allows new Instant 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 property 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. |
|
iim_ldap.firstnameattr |
givenname |
The LDAP attribute that stores the user's first name. |
|
iim_ldap.user.attributes |
None |
The LDAP attribute that contains the list of custom attributes from the LDAP user entry. |
|
iim_ldap.group.attributes |
None |
The LDAP attribute that contains the list of custom attributes from the LDAP group entry. |
|
iim_ldap.lastnameattr |
sn |
The LDAP attribute that stores the user's last name. |
|
iim_ldap.managedroleobjectclass |
nsManagedRoleDefinition |
The LDAP object class that represents managed-role objects. |
|
iim_ldap.usessl |
false |
Specifies whether to use SSL when connecting to the primary LDAP server. |
|
iim_ldap.schema1.domain_config_root |
None |
Specifies the base DN for looking up schema 1 domains. |
|
iim_ldap.schema2.domain_config_root |
None |
Specifies the base DN for looking up schema 1 domains. |
|
iim_ldap.debugPool |
false |
Enables extra debugging log messages for LDAP pool failover. |
|
iim_ldap.groupchatstorage. |
10000 if no value set, 1000 if value set and is less than 1000. |
Specifies queuesize for group chat. |
|
iim_ldap.plaintextpasswords |
false |
Specifies whether the passwords in LDAP are stored in clear text |
Table 27-3 lists and describes the logging configuration properties for log4j-based logging.
Table 27-3 Logging Configuration Properties
| Property | Default Value | Description |
|---|---|---|
|
agent-calendar.log4j. |
60 |
Specifies in seconds how often the calendar agent rereads the log4j configuration. |
|
agent-calendar.log4j. |
InstantMessaging_cfg |
Specifies the location and name of the log4j configuration file. If no value exists for this property, the logger will look for log4j.conf in InstantMessaging_cfg. If the logger does not find log4j.conf in InstantMessaging_cfg, it uses the property-based logging method, instead of log4j. |
|
iim_mux.log4j.refresh |
60 |
Specifies in seconds how often the multiplexor rereads its log4j configuration. |
|
iim_server.log4j.refresh |
60 |
Specifies in seconds how often the server rereads its log4j configuration. |
|
iim_wd.log4j.refresh |
60 |
Specifies in seconds how often the watchdog rereads its log4j configuration. |
|
iim_smppbind.log4j.refresh |
60 |
Specifies in seconds how often the SMS gateway rereads its log4j configuration. |
Table 27-4 lists and describes the general configuration properties.
Table 27-4 General Instant Messaging Server Configuration Properties
| Property | Default Value | Description |
|---|---|---|
|
iim_server.autosubscribe |
iim_server.clienttimeout |
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 instance 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. |
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 Instant Messaging Server with the ability to validate session IDs sent by the client. The value can either be 0 or 1. Use SSO provider only without attempting LDAP authentication even when the SSO validation fails. The iim_server.usesso property is used in conjunction with the iim_server.ssoprovider property. |
|
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 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 |
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 |
Contains the list of archive providers. 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.msg_archive.auto |
false |
Specifies whether messages are automatically archived. |
|
iim_server.enable |
true |
This value determines whether or not Instant Messaging Server is enabled. Set to false to enable the Instant Messaging multiplexor. |
|
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 file name for the server's Java keystore (JKS), for example, InstantMessaging_cfg/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 terminates 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, the server trusts all certificates and also adds the certificate information into the log files. |
|
iim_server.dialback.key |
None |
Defines a static dialback key. |
|
iim_server.conversion.provider |
None |
Contains the list of Message Conversion Providers to be used for message conversion. It allows multiple values ,with each value separated by a comma (,). |
|
iim_server.conversion.external.command |
None |
Contains the external command used for message conversion. The iim_server.conversion.external.command property 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 property, you must set the class com.iplanet.im.server.ExternalDocumentConverter as the provider class, and set the property 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.conversion |
iim_server.conversion |
Specifies whether message conversion should be enabled. Also specifies whether the configured list of Message Conversion Providers should be used for message conversion. |
To enable communication between multiple Instant Messaging Server instances 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 has a connection to your server. The coserver identifies itself with its Instant Messaging Server 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 Server 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 27-5 lists and describes the multiple server configuration properties.
Table 27-5 Multiple Server Configuration Properties
Property |
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.federation.policy |
None |
To enable open federation, set to open. To disable open federation, set to closed. For example: iim_server.federation.policy = "open" By default, iim_server.federation.policy is not enabled. |
|
iim_server.federation.exceptions |
None |
Specifies a blacklist of domains where federation is denied. |
|
iim_server.c2s.requiressl |
false |
Specifies whether all client-to-server communication must be encrypted. |
|
iim_server.conference.history. |
10 |
Specifies the maximum history stanzas sent to the client by default. |
|
iim_server.s2s.requiressl |
false |
Specifies whether all server-to-server communications must be encrypted. |
|
iim_server.conference.history. |
0 |
Specifies the maximum history stanzas stored by the server in memory. |
|
iim_server.conference.history. |
false |
Specifies whether the server stores conference history in persistent storage. |
|
iim_server.conference.distributeall |
false |
Specifies whether the server distributes conference room messages to all peers in a server-pool. |
You can use the Shoal clustering framework to automatically discover and add peer servers in a server pool. Table 27-6 lists and describes the shoal configuration properties.
Table 27-6 Shoal Configuration Properties
| Property | Default | Required | Description |
|---|---|---|---|
|
iim_server.peer.autodiscover |
false |
No |
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 are not able to join the pool. |
|
iim_server.hostname |
local-hostname: |
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. |
|
iim_server.peer.conferences. |
false |
No |
Enables the use of the shoal P2P framework to distribute conference messages across the server pool. |
Table 27-7 lists the properties for Shoal access across subnets.
Table 27-7 Properties for Shoal Access Across Subnets
| Property | Default Value | 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. |
Table 27-8 lists and describes the multiplexor configuration properties.
Table 27-8 Multiplexor Configuration Properties
| Property | 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 instance and port the multiplexor communicates to. The value format is servername:port or IPaddress:port. |
|
iim_server.usemuxport |
true |
Enables the multiplexor listen port on the server. |
|
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.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 property 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 property is Secret-stuff. |
|
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.enable |
true |
If the value is true, the multiplexor will run for this instance. If the value is false, the multiplexor will not run for this instance. |
|
iim_mux.log4j.refresh |
60 |
Specifies the number of seconds in which the multiplexor rereads its log4j configuration. |
|
iim_mux.threadpool.capacity |
-1 |
Specifies the queue size for the multiplexor's default thread pool. |
|
iim_mux.trust_all_cert |
false |
Determines whether the multiplexor trusts all certificates that are presented, even if a certificate fails verification. |
|
iim_mux.jvm.maxmemorysize |
256 |
The maximum heap size, in MB, that the JVM running the multiplexor is allowed to use. Used to construct the -mx argument of the Java command. |
Table 27-9 lists the properties you use to manage Instant Messaging Server archiving.
| Property | Default Value | Description |
|---|---|---|
|
iim_arch.title.attr |
Title |
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 |
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 |
Contains the name of the field equivalent to the ReadACL field in the default schema of the Portal ServerSearch. |
|
iim_arch.description.attr |
Description |
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 |
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 |
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 |
Contains the administrator's DN. Multiple values should be separated by a semi colon ( ; ). |
|
iim_arch.readacl.adminonly |
false |
Contains true or false. true: Only the administrator's DN, as specified by the property iim_arch.readacl.admin is added to the ReadACL field, overwriting the default behavior of the ReadACL field. false: The administrator's DN, as specified by the property iim_arch.readacl.admin is added to the ReadACL field in addition to the default behavior. |
|
iim_arch.categories |
all |
Contains a comma-separated list of message types that can be archived. The following types are available:
|
|
iim_arch.categoryname |
None |
If a category name is not assigned for any of the categories, the value of this property is used as the category name. |
|
iim_arch.alert.categoryname |
None |
Contains the name of the category containing the archived alert messages. There is no requirement to dedicate a category to alert messages. |
|
iim_arch.poll.categoryname |
None |
Contains the name of the category containing the archived poll messages. There is no requirement to dedicate a category to poll messages. |
|
iim_arch.conference.categoryname |
None |
Contains the name of the category containing the archived conference messages. There is no requirement to dedicate a category to conference messages. |
|
iim_arch.chat.categoryname |
Name |
Contains the name of the category containing the archived chat messages. There is no requirement to dedicate a category to chat messages. |
|
iim_arch.news.categoryname |
None |
Contains the name of the category containing the archived news messages. There is no requirement to dedicate a category to news messages. |
|
iim_arch.conference.quiettime |
5 |
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 |
Contains the maximum time for which poll data is buffered in the server. The value is in minutes. |
|
iim_arch.ignoreexplicitdeny |
true |
Contains true or false. true: For the Poll and Conference categories, data with explicitly denied access is not archived. Each time such a message is denied access, this information is logged in the xmppd.log file. false: For the Poll and Conference categories, data with explicitly denied access is not archived and the message is added to the Portal Server Search database. If you do not explicitly deny access to a room or a news channel, the default access is READ or WRITE or MANAGE. Some end users can also be given NONE access. |
|
iim_arch.portal.search |
None |
The URL of the Portal Server Search servlet. For example:
If this property is not present, 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 DN of the admin user. For example: uid=amadmin,ou=People,o=internet This property is required when the Document level Security in the Portal Server is on. |
|
iim_arch.portal.adminpassword |
None |
The password of the administrative user, as specified by the iim_arch.portal.admindn property. This property is required when the Document level Security in the Portal Server is on. |
|
iim_arch.portal.search.database |
None |
The name of the database in which the Instant Messaging Server instance stores archived messages. If this property is not defined, all messages are stored in the default database of Portal Server Search. |
|
iim_arch.admin.email |
None |
A comma-separated list of administrator email addresses. |
|
iim_arch.alert.admin.email |
None |
A comma-separated list of administrator email addresses to which all archived alert messages are sent. This property overrides iim_arch.admin.email for alert messages. |
|
iim_arch.chat.admin.email |
None |
A comma-separated list of administrator email addresses to which all archived chat messages are sent. This property overrides iim_arch.admin.email for chat messages. |
|
iim_arch.conference.admin.email |
None |
A comma-separated list of administrator email addresses to which all archived conference messages are sent. This property overrides iim_arch.admin.email for conference messages. |
|
iim_arch.poll.admin.email |
None |
A comma-separated list of administrator email addresses to which all archived poll messages are sent. This property overrides iim_arch.admin.email for poll messages. |
|
iim_arch.news.admin.email |
None |
A comma-separated list of administrator email addresses to which all archived news messages are sent. This property overrides iim_arch.admin.email for news messages. |
|
iim_arch.email.archiveheader. |
None |
Name of the extended RFC 822 header. |
|
iim_arch.email.archiveheader. |
all |
Value corresponding to the header name for iim_arch.email.archiveheader.name. |
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 27-10 lists and describes the watchdog configuration properties.
Table 27-10 Watchdog Configuration Properties
| Property | Default Value | Description |
|---|---|---|
|
iim_wd.enable |
true |
Enables the watchdog feature. To reset this property 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 property 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. |
|
iim_wd.log4j.refresh |
60 |
Specifies in seconds how often the watchdog rereads its log4j configuration. |
|
iim_wd.pidfile |
None |
The file that stores the watch dog's PID. |
|
iim_wd.jvm.maxmemorysize |
256 (MB) |
The maximum heap size, in MB, that the JVM running the watchdog is allowed to use. Used to construct the -mx argument of the Java command. |
|
iim_wd.debug_on_restart |
true |
When a server is unresponsive, and if the property iim_wd.debug_on_restart is set to true, it captures a jstack dump of the server process in the log directory, when the server is hung. |
The properties in Table 27-11 configure the way the server interacts with the Oracle Enterprise System Monitoring Framework.
Table 27-11 Monitoring Properties
| Property | Default Value | Description |
|---|---|---|
|
iim_server.monitor.enable |
false |
Used by the Oracle 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 the port can present a security risk. |
Agents, such as the Calendar agent, enable functionality within Instant Messaging Server and enhance its interoperability with other Unified Communications Suite servers.
Table 27-12 lists and describes agent configuration properties.
Table 27-12 Agent Configuration Properties
| Property | Default Value | Description |
|---|---|---|
|
agent-calendar.broker.address |
None |
Specifies the host name and port on which the broker is running. |
|
agent-calendar.broker. |
None |
Specifies the password of the broker user name. |
|
agent-calendar.broker.user |
None |
Specifies the broker user name. |
|
agent-calendar.consumer. |
None |
Specifies any extra properties required by the calendar notifications consumer. |
|
agent-calendar.consumer.topic |
None |
Topic on which the calendar notifications are delivered. |
|
agent-calendar.iim_server.host |
localhost |
Host name of the Instant Messaging server with which the agent calendar communicates. |
|
agent-calendar.iim_server.port |
$iim_server.port |
Port number of the Instant Messaging server with which the agent calendar communicates. |
|
agent-calendar.imadmin.enable |
false |
If set to true, you can start the agent-calendar by using the imadmin command. |
|
agent-calendar.log4j.refresh |
60 |
Specifies in seconds how often the calendar agent rereads the log4j configuration. |
|
agent-calendar.serveralarms. |
text/calendar |
Specifies the content type used to deliver calendar alerts. Can be text/plain or text/ical. |
|
iim_agent.enable |
false |
If TRUE, iim.conf, enables Instant Messaging Server agents. Set the value to FALSE, or remove the property from iim.conf to disable all agents. |
|
iim_agent.agent-calendar.enable |
false |
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. |
|
agent-calendar.imadmin.enable |
false |
Start the agent-calendar by using the imadmin command if set to true. |
Table 27-13 lists the calendar agent properties.
| Property | Default Value | Description |
|---|---|---|
|
agent-calendar.broker.address |
None |
Specifies the host name and port on which the broker is running. |
|
agent-calendar.broker.password |
None |
Specifies the password of the broker user name. |
|
agent-calendar.broker.user |
None |
Specifies the broker user name. |
|
agent-calendar.consumer.params |
None |
Specifies any extra properties required by the calendar notifications consumer. |
|
agent-calendar.consumer.topic |
None |
Topic on which the calendar notifications are delivered. |
|
agent-calendar.iim_server.host |
localhost |
Host name of the Instant Messaging server with which the agent calendar communicates. |
|
agent-calendar.iim_server.port |
$iim_server.port |
Port number of the Instant Messaging server with which the agent calendar communicates. |
|
agent-calendar.imadmin.enable |
false |
Start the agent-calendar by using the imadmin command if set to true. |
|
agent-calendar.log4j.refresh |
60 |
Specifies in seconds how often the calendar agent rereads the log4j configuration. |
|
agent-calendar.serveralarms. |
text/calendar |
Specifies the content type used to deliver calendar alerts. Can be text/plain or text/ical. |
|
iim_agent.enable |
false |
If TRUE, iim.conf, enables Instant Messaging Server agents. Set the value to FALSE, or remove the property 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. |
|
agent-calendar.imadmin.enable |
None |
Start the agent-calendar by using the imadmin command, if set to true. |
Table 27-14 lists the properties you use to bind to the HTTP/XMPP gateway.
Table 27-15 lists the SMS integration properties.
Table 27-15 SMS Integration Properties
| Property | 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 JID to bind the SMS gateway to the Instant Messaging server. The value of this property should be the same as the value that you define for the smppbind.jid property. |
|
smsgw.password |
random |
Password to authenticate the SMS gateway to the Instant Messaging server. The value of this property should be the same as the value that you define for the smppbind.password property. |
|
smsgw.iim_server |
None |
Host name 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 host name 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 |
random |
Password to authenticate the SMS gateway to the SMSC. |
|
smpp.sender_id |
None |
Sender ID of the outgoing SMS. |
|
iim_agent.smppbind.enable |
false |
Enables the Instant Messaging server to identify the SMS gateway. |
|
smppbind.jid |
None |
A JID for binding the SMS gateway to the Instant Messaging server. |
|
smppbind.password |
random |
Password to authenticate the SMS gateway to the Instant Messaging server. |
|
smpp.bind_usessl |
false |
Specifies whether to use SSL when connecting to the SMSC. |
|
smppbind.log4j.refresh |
60 |
Specifies in seconds how often the SMS gateway rereads its log4j configuration. |
|
smsgw.im_char_limit |
500 |
The maximum number of characters permitted in an SMS message. |
Table 27-16 lists the Facebook Gateway properties.
Table 27-16 Facebook Gateway Properties
| Property | Default Value | Description |
|---|---|---|
|
fim.enable |
false |
Facebook Gateway plug-in entry. |
|
fim.iim_gw_name |
Facebook Gateway |
Facebook Gateway name. |
|
fim.iim_gw_type |
|
Facebook Gateway type. |
|
iim.gwconnectorentries |
IMSHost:55222 |
The fully-qualified host names (FQHN) and ports (host:port) that the Gateway Connector uses for Gateway plug-ins. |
|
iim.gwplugins |
NA |
Plug-in for the Facebook Gateway. Must be set to fim. |
|
fim.serverjid |
chat.facebook.com |
Facebook Gateway server JID. |
|
fim.host |
chat.facebook.com |
Facebook Gateway host name. |
|
fim.port |
5222 |
Facebook Gateway port. |
|
fim.apikey |
None |
Facebook Gateway apikey. |
|
fim.apisecret |
None |
Facebook Gateway apisecret. |
|
fim.usetls |
false |
Enables the Facebook Gateway to use TLS while connecting to the Facebook server. |
Table 27-17 lists properties of the Gateway Connector used by the Facebook Gateway.
Table 27-17 Gateway Connector Properties
| Property | Default Value | Description |
|---|---|---|
|
iim_gwc.enable |
false |
Controls whether the imadmin command starts the Gateway Connector process. |
|
iim_gwc.hostport |
IMSHost:55222 |
Fully-qualified Host name and port (host:port) for the Gateway Connector process. |
|
iim_gwc.maxchannels |
10000 |
Maximum number of channels for the Gateway Connector process. |
|
iim_gwc.jvm.options |
NA |
Options to be passed to the Java VM when starting the Gateway Connector. |
|
 Copyright © 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
