Sun Java System Instant Messaging 7.2 Administration Guide

Archive Parameters

Table A–8 lists the parameters you use to manage Instant Messaging archiving.

Table A–8 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 “;

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: 

poll

alert

chat

conference

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.