Pop-up Reminders Overview

This section contains information about Calendar pop-up reminders in the following topics:

• Pop-up Reminders Operation

• Pop-up Reminders Architectural Flow

• iim.conf Calendar Pop-up Configuration Parameters

Pop-up Reminders Operation

Users can receive Instant Messenger pop-up reminders for upcoming events and tasks on their calendars. To enable these pop-up reminders, the following must occur:

• The administrator must configure the Calendar server and the Instant Messaging server to allow pop-up notifications.

• The end user must specify email reminders in the Options tab of either Calendar Express or Communications Express, which sets an alarm in the Event Notification System.

• The end user must enable calendar reminders in Instant Messenger.

With pop-ups enabled, when an impending event or task nears, the alarm set in the Event Notification System causes Calendar Server to send an email notification and Instant Messaging to display a pop-up reminder.

Pop-up Reminders Architectural Flow

If configured, Instant Messaging pop-up reminders follow this architectural flow:

1. The Instant Messaging JMS subscriber subscribes to Calendar server events and notifications in the Event Notification Service (ENS).

2. Calendar server publishes an event or task notification in text/xml or text/calendar format to ENS.

3. The Instant Messaging JMS subscriber receives the calendar event or task notification and then generates a message in text/calendar format.

4. The Instant Messaging server sends the message to the calendar owner, if the end user is online.

5. If the recipient is available, Instant Messenger generates an HTML pop-up reminder on the end user’s desktop based on the message.

   If the recipient is not available, the Instant Messaging server discards the message.

iim.conf Calendar Pop-up Configuration Parameters

When you install Instant Messaging, several configuration parameters used with the Calendar agent are added by default to iim.conf. You can also enable the Calendar agent and provide associated configuration information when you run the configure utility. However, you might want to manually configure pop-ups, for example, if you have customized the resource files for Instant Messenger. If you rerun configure, you will then need to redeploy the resource files. If you choose to manually configure the Instant Messaging server for Calendar pop-ups instead of running the configure utility, you will need to provide values for these parameters. See Chapter 1, Configuring Instant Messaging After Installation for information on the configure utility.

Table 16–1 lists the configuration parameters you will use to configure the Instant Messaging server and the Calendar agent in order to use Calendar pop-ups.

Table 16–1 iim.conf Parameters for Configuring Calendar Pop-ups

Parameter or Section in iim.conf	Description and Appropriate Value
JMS Consumers Section
jms.consumers	Name of alarm.  Set the value to:  cal_reminder
jms.consumer.cal_reminder.destination	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	The name of the provider.  Set to ens. This must be the same as the name in the jms.providers parameter in the JMS Providers section.
jms.consumer.cal_reminder.type	The type of alarm to set. Set the value to:  topic
jms.consumer.cal_reminder.param	The alarm parameter. Set the value as follows including the quotes:  "eventtype=calendar.alarm"
jms.consumer.cal_reminder.factory	A listener that registers itself for the new calendar reminder messages.  Set the value to:  com.iplanet.im.server.JMSCalendarMessageListener Enter the value on a single line.
JMS Providers Section
jms.providers	The name of the provider.   Set value to ens. This must be the same as the value listed in the JMS Consumers Section for the jms.consumer.cal_reminder.provider parameter.
jms.provider.ens.broker	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 parameter service.ens.port. The default is 57997. For example:  jms.provider.ens.broker=cal.example.com:57997
jms.provider.ens.factory	Factory class used for creating the topic connection objects.  Set the value to:  com.iplanet.ens.jms.EnsTopicConnFactory
Instant Messaging General Parameters
iim_agent.enable	Enables agents for Instant Messaging. By default, this parameter is set to False. Set the value as follows including the quotes:  iim_agent.enable="true"
iim_agent.agent-calendar.enable	Loads a component that enables the Calendar agent.  Set the value as follows including the quotes:  iim_agent.agent-calendar.enable="true"
agent-calendar.jid	The JID of the Calendar agent. Set this value as follows:  agent-calendar.jid=calimbot.server.domain
agent-calendar.password	Set this parameter to a password you want the Calendar agent to use to connect to the Instant Messaging server.  Set this value as follows:  agent-calendar.password=password
iim_server.components	Set this value as follows:  iim_server.components=agent-calendar