Skip Headers
Oracle® Communications Instant Messaging Server System Administrator's Guide
Release 9.0.2

E52523-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

22 Configuring the Instant Messaging Server Calendar Agent

This chapter describes how to configure the Oracle Communications Instant Messaging Server calendar agent.

Configuring Calendar Agent with Calendar Server 7

This section describes how to configure Instant Messaging Server for Java Message Service (JMS) to support Oracle Communications Calendar Server (Calendar Server 7) Agent alerts. You can configure Instant Messaging Server either by running the configure command or by manually configuring the necessary properties with the imconfutil command. You do not need to configure Calendar Server 7 Update 2 itself to support calendar reminders.

Note:

Instant Messaging Server started using Java Message Queue as the calendar agent for calendar reminders in the 7.3 release.

Configuring Instant Messaging Server

No special steps are needed to configure Calendar Server, starting with 7 Update 2, to work with Instant Messaging Server. However, you do need to configure the Instant Messaging Server 9 Calendar Agent. This section describes the two ways in which you can configure Instant Messaging Server, and properties that need to be configured.

Topics in this section:

To Configure IM Server 9 Calendar Agent with Calendar Server 7

  1. Run the configure utility, for example:

    /opt/sun/comms/im/sbin/configure --nodisplay
    
  2. Respond to the Calendar Agent configuration prompts as follows:

    Do you want to go back to previous panel [no]:no
    
    Enable Calendar Agent [no]:yes
    
    Enable local component [no]:yes
    
    Select the type of notification
    
    1. JMQ
    
    2. ENS
    
    Enter the number corresponding to your choice: [1]:1
    
    XMPP server hostname [hostname]: host name
    
    XMPP server port [port number]: port number
    
    JMQ Username: username
    
    JMQ Password: password
    
    Notification Server Hostname: host name
    
    Notification Server Port: port number
    
    Topic: testTopic
    
  3. After running the configure utility, use the imconfutil command to set the contenttype property.

    For example:

    /opt/sun/comms/im/sbin/imconfutil --config /etc/opt/SUNWiim/default/config/iim.conf.xml set-prop agent-calendar.serveralarms.contenttype=text/plain
    

To Manually Configure IM Server 9 Calendar Agent with Calendar Server 7

If you did not configure the Calendar Agent while running the configure command, you can use the imconfutil command to manually set the properties.

  1. The following example shows how to run the imconfutil command to set the list of properties in "JMS and Calendar Agent Properties":

    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml add-component id=calagent jid=calendar.domain password=secret
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.notification.type=jmq
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.broker.address=host.domain:7676
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.consumer.topic=DavNotificationTopic
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.imadmin.enable=true
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop iim_agent.agent-calendar.enable=true
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.iim_server.host=host.domain
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.iim_server.port=5269
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop iim_agent.enable=true
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.jid=calendar.domain
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.password=secret
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.serveralarms.contenttype=text/plain
    
  2. Optional: Run the following command if your imqbrokerd is configured with a user name and password. You do not have to run the following parameter if Java Message Queue is being used from GlassFish Server.

    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.broker.user=guest
    
    imconfutil --config /opt/sun/comms/im/config/iim.conf.xml set-prop agent-calendar.broker.password=guest
    

JMS and Calendar Agent Properties

Table 22-1 and Table 22-2 list the JMS and Calendar Agent properties that you configure for Instant Messaging Server.

Table 22-1 JMS API Configuration Properties

Property Default Value Description

agent-calendar.notification.type

jmq

Specifies the notification service type, either jmq or ens.

agent-calendar.broker.
address

JMQserver:port

Specifies the host name and port on which the broker (JMQ) is running.

agent-calendar.consumer.
topic

topic

Topic on which the calendar notifications are delivered.

agent-calendar.broker.user

guest

Specifies the broker user name.

agent-calendar.broker.
password

guest

Specifies the password of the broker user name.


The parameters in the following table are available starting with Instant Messaging Server 8.0. If upgrading from a prior version, you must set the parameters manually.

Table 22-2 Instant Messaging Server Calendar Agent Configuration Properties

Property Value Description

agent-calendar.imadmin.enable

false

If set to true, you can start the agent-calendar by using the imadmin command.

iim_agent.agent-calendar.enable

false

If set to true, you can start the agent-calendar by using the imadmin command.

agent-calendar.iim_server.host

NA

Host name of the Instant Messaging server with which the agent calendar communicates.

agent-calendar.iim_server.port

NA

Port number of the Instant Messaging server with which the agent calendar communicates.

iim_agent.enable

true

Enables agents for Instant Messaging Server.

iim_agent.enable

true

Enables agents for Instant Messaging Server.

agent-calendar.password

NA

Password used by the Calendar Agent component to authenticate the Instant Messaging Server.

agent-calendar.serveralarms.contenttype

NA

Content type used to deliver calendar alerts. Can be text/plain or text/ical.


Notes:

  • No additional steps are required to configure Calendar Server 7 Update 2 and higher to work with Instant Messaging Server.

  • By default, Calendar Server 7 Update 2 and higher is configured with the DavNotificationTopic configuration parameter. Use DavNotificationTopic as the value for the agent-calendar.consumer.topic property.

  • GlassFish Server uses Java Message Queue on port 7676 independently of Messaging Server and Calendar Server. A single host installation of Calendar Server might see problems with port 7676 being occupied if GlassFish Server is already installed on that host. To avoid this problem, edit the /etc/imq/imqbrokerd.conf file in the Oracle Solaris default path and set the ARGS=-port parameter to a free port.

  • imqbrokerd should be up and running for Calendar Server alerts to work when configured with Java Message Queue.