Sun Java System Instant Messaging 7.2 Administration Guide

Configuring the Instant Messaging Portal Archive Provider

The Instant Messaging Archive Provider stores the archived messages as resource descriptors (RD) in the Portal Server Search database. The archive provider uses the following fields of the Portal Server Search schema:

Title - This field contains the names of the public conference rooms for Conference category, names of the participants in a chat session for the Chat category, subject of the Alert messages, and the names of the News Channels for alerts and news categories. The title field will contain “Poll from Sender” for the poll category, where Sender represents the display name of the sender of the poll.

Keyword - For conference and chat categories, this field contains a list of all the participants in the conference room. For a public conference room, it also contains the name of the conference room. For the Alert category, it contains the display names of the sender and the recipients. For the News category, it contains the name of the channel. For the Polls category, it contains the list of sender and recipients. For all categories, in addition to the above values this field also contains a unique ID for the categories.

Table 18–2 shows the unique ID and gives a description for each category in the archive provider.

Table 18–2 Unique ID and Description for Archive Provider Categories


Unique ID  





RoomName - Name of the public or private conference room

StartTime - Timestamp of the creation of RD




messageID - Message ID of the message which will be archived. Message ID has importance when the RD contains only one message. For example, News message and Alert message.





ReadACL - For the Conference and News categories, the value for this field is taken from the access control files of the respective conference rooms and news channels. For the Chat category, this field contains the DN of the participants. For the Alert category, this field contains the sender’s DN and the recipient’s DN. For the Poll category, the archive provides a new access control file.

The search access to the RDs is controlled by the value in the ReadACL field. If the document level security is enabled, the end user has access to the search results only if the ReadACL field has the end user’s DN.

Description - This field contains the archived message without the HTML formatting.

Full-Text - This field contains the HTML formatted archived messages.

Classification - This field contains the category of the archived message.

ProcedureTo Configure the Archive Provider

  1. Open iim.conf.

    See Appendix A, Instant Messaging Configuration Parameters in iim.conf for instructions on locating and modifying iim.conf.

  2. Add or edit the archive provider configuration parameters as desired.

    See Table A–8 for a list of parameters you can modify.

  3. Save and close iim.conf.

  4. Refresh the Instant Messaging server.

ProcedureTo Store Archived Messages in a Non-default Database

Use this procedure to configure Instant Messaging to store archived messages in a database other than the default.

  1. Open iim.conf.

    See Appendix A, Instant Messaging Configuration Parameters in iim.conf for instructions on locating and modifying iim.conf.

  2. For the default archive provider, add the following line: = database-name

    where database-name is the name of your non-default database.

  3. Save and close iim.conf.

  4. Modify the Portal Server Search Channel.

    Change the Portal Server Search Channel to add an option for searching the data in another database. See the Sun Java System Portal Server Desktop Customization Guide for more information.

  5. Change to the IMProvider directory.

    For example:

    cd /etc/opt/SUNWps/desktop/default_locale/IMProvider/

    Where locale is the locale of the language used in your deployment. For example, default_ja or en_US. Also, if you created multiple instances of Instant Messaging, the name of the /default directory will vary depending on the instance.

  6. Create a back up of the IMArchiveDisplay.jsp file.

  7. Open the IMArchiveDisplay.jsp file.

  8. Search through the IMArchiveDisplay.jsp file and locate the following two lines of code:

    <search:setQuery query = "<%= scope %>"/>
     <search:setRDMType rdmType = "rd-request"/>
  9. Between the two lines of code shown in the previous step, add the following line of code:

    <search:setDatabase database = "database-name"/>

    After you add the new line of code, that section of code should look as follows:

    <search:setQuery query = "<%= scope %>"/>
     <search:setDatabase database = "database-name"/>
    <search:setRDMType rdmType = "rd-request"/>

    where database-name is the name of the non-default database.

  10. Replace the virtual search server with the physical server hostname.

  11. Save and close IMArchiveDisplay.jsp.