Sun Java System Calendar Server 6.3 Administration Guide

Chapter 20 Using Instant Messaging Pop-up Reminders

Calendar Server is integrated with Sun Java System Instant Messaging 6.0 (or later) to provide automatic pop-up reminders for both calendar events and tasks.

This chapter contains conceptual information and instructions on how to configure pop-up reminders.

This chapter contains the following sections:

20.1 Pop-up Reminders Overview

This section contains the conceptual information you need to understand how pop-up reminders work in Calendar Server software.

This section contains the following topics:

20.1.1 Configuration Concepts for Calendar Pop-up Reminders

This section describes what must be configured to make pop-up reminders work.

Users can receive Instant Messenger pop-up reminders for upcoming events and tasks on their calendars.

To enable these pop-up reminders, two things must happen:

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.

A Calendar Server administrator can choose to configure either email notifications or pop-up reminders or both for end users. For example, to turn email reminders off, set the following parameter in the ics.conf file:

caldb.serveralarms.binary.enable= "no"

20.1.2 How Pop-up Reminders Work

This section describes how pop-up reminders work.

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.

20.2 Configuring Pop-up Reminders

This section contains instructions for configuring pop-up reminders for Calendar Server software.

This section includes the following configuration instructions:

ProcedureTo Configure Instant Messaging Server

The high level list of tasks necessary to configure Instant Messaging for Pop-ups that follows is for your convenience. To configure Instant Messaging, refer to the Instant Messaging documentation available at:

  1. Install the new package SUNWiimag.

    Before you can use Instant Messaging for Pop-ups, the Instant Messaging package must be installed using the Java Enterprise System installer.

  2. On the machine where Instant Messaging is installed, change to the following directory:

    cd /etc/opt/SUNWiim/default/config

  3. Edit one or more of the parameters in the iim.conf file as shown in the following table.

    The parameter values shown assume you want pop-up reminders for both events and tasks. If these parameters do not already exist in your iim.conf file, add them.


    Description and Appropriate Value to Use 

    JMS Consumers Section 



    Name of alarm. Set the value to cal_reminder.


    Destination of the alarm. Set the value to enp:///ics/customalarm 


    The name of the provider. Set to ens. This must be the same as the name in jms.providers in the JMS Providers section.


    The type of alarm to set. Set the value to topic.


    The alarm parameter. Set the value to "eventtype=calendar.alarm" (including the quotes)


    C++ factory name. Set the value to:

    JMS Providers Section 



    The name of the provider. Set value to ens. This must be the same as the value listed in the JMS Consumers Section for jms.consumer.cal_reminder.provider.

    Port number that ENS listens on. Set to the port specified in the ics.conf file parameter service.ens.port. The default is 57997.


    C++ factory to use. Set to com.iplanet.ens.jms.EnsTopicConnFactory

    Calendar Server General Parameters 



    Enables the Calendar agent. Set the value as follows including the quotes: 



    Loads a component that enables the Calendar agent. Set the value as follows including the quotes: 



    The JID of the Calendar agent. Set this value as follows: 



    The Calendar agent password. Set this value as follows: 



    Set this value as follows: 


  4. Change to the directory where the imadmin command-line utility is located:

    cd /opt/SUNWiim/sbin

  5. Start the Calendar agent using imadmin:

    imadmin start agent-calendar

    The Calendar agent is an Instant Messaging component that provides pop-up functionality to Calendar Server users. Using tools provided with Instant Messaging, you can start, stop, restart, or check the status of the Calendar agent as well as monitor its activity through log files.

    Note –

    If you have scripts that include the stop, start, and refresh commands, add the calendar agent to them.

    For more information about imadmin and the Calendar agent, see the Sun Java System Instant Messaging 7 2005Q1 Administration Guide.

ProcedureTo Configure Calendar Server

Before You Begin

Confirm that the ics.conf parameters shown in the following table have the values shown. If they do not, or you wish to customize them, perform the following steps:

  1. Log in as an administrator with configuration privileges.

  2. Stop Calendar Server services by issuing the stop-cal command.

  3. Change to the /etc/opt/SUNWics5/cal/config directory.

  4. Save your old ics.conf file by copying and renaming it.

  5. Edit the ics.conf parameters as shown in the following table:


    Description and Default Value  


    Enables calendar alarms to be queued. The default is “yes” (enabled).


    Output format for alarm content. The default is "text/xml".


    Enables calendar alarms to be dispatched. The default is “yes”.


    The type of server alarm to dispatch. The default is "ens".


    This is the URL for alarm retrieving alarm contents. The default is "enp:///ics/customalarm".

  6. Save the file as ics.conf.

  7. Restart Calendar Server.


ProcedureTo Configure Instant Messenger

To receive pop-up reminders for Calendar Server events and tasks, end users must configure their Instant Messenger as follows:

  1. On the Main window, from the Tools menu, select Settings.

  2. On the Settings window, click the Alerts tab.

  3. Check the Show Calendar Reminders option.

  4. Click OK.