Administering MWI/Pager Notification Services

How Message Notification Works

Administering MWI/Pager Notification Services

The three types of MWI/Pager message notification services available to uOne subscribers are notification by pager, by stutter dial tone , or by Message Waiting Light . In addition, SMS Notification is available (see "Administering SMS Notification Services").

Note If there is no MWI present in your system, you should configure MWI off. Otherwise, the UM application agent log errors will occur. You can configure MWI off in one of two ways. You can configure MWI off in the defaultData.ini file, or you can set the Message Waiting Indicator COS attribute to off via the uOne Administration tool.

System defaults for MWI/Pager message notification are defined in the defaultData.ini file on the Gateserver on which uOne Administration resides. System Administrators can change these defaults whenever it is necessary.

Subscribers can customize their notification options through Personal Mailbox Administration. For example, they might choose to set their mailbox up to page them on all urgent messages and normal fax messages, to light the light on their phone (Message Waiting Light ) on normal voice messages, and have no notification on e-mail messages.

How Message Notification Works

The two components of message notification that reside on the Gateserver are:

MWI_Notify —Receives notification records from MWI_PassOff and sends these records via LACS to MWI_OnOff .
MWI_OnOff —Turns on the Message Waiting Indicators (such as MWI lights on a telephone and stutter dial tone ) or sends a notification page. (This does not turn off MWI. The "Off" is in the name for historical reasons.)

There is also software on the messaging server that supports message notification. If your uOne system is configured with a Netscape Messaging Server, there two additional plugins:

MWI_PlugIn —Used to create a notification record for each e-mail, voice, or fax message for each recipient of the message. Also, used to send the notification records to MWI_PassOff .
MWI_PassOff —Receives notification records for e-mail, voice, and fax messages from MWI_PlugIn via a FIFO file and sends these records to MWI_Notify via a TCP connection, typically on port 4077.

If a Software.com messaging server is configured, a Perl script called mwi_parse.pl creates notification records and sends them to the Gateserver.

When a new SMTP message arrives on the messaging server , the SMTP process on the messaging server performs an SMTP_Accept operation.

If a Netscape Messaging Server is configured on your uOne system, MWI_PlugIn is called for every SMTP_Accept. MWI_PlugIn writes to a local FIFO file. MWI_PassOff receives the request for notification via this FIFO and sends the notification records through a TCP connection to the Gateserver where MWI_Notify and MWI_OnOff are located. (MWI_PassOff and MWI_Notify are "partner" applications that are responsible for network communications between the messaging server and the Gateserver.)

If a Software.com messaging server is configured, mwi_parse.pl looks for messages in the mwi\spool directory every minute. For each message, mwi_parse.pl checks the type of message from the MIME headers, creates a notification record, and sends it to the Gateserver.

On the Gateserver, MWI_Notify receives the notification records and passes them to MWI_OnOff . MWI_OnOff handles the LDAP lookup and configuration logic to determine the type of notification defined for the subscriber. After MWI_OnOff has the subscriber's notification options from the LDAP database, it sends a request to the CMA agent for SMSI signaling (MWI light or Stutter). If paging is enabled, MWI_OnOff sends a request to an SNPP paging server for a numeric page or sends an SMTP message to the defined paging e-mail address for a text page. The CMA agent sends SMSI notifications to turn on the MWI light or stutter dial tone , and/or the SNPP paging server sends numeric pages.

Note The MWI_OnOff application does not turn MWI off. The UM application agent turns MWI off.

Prerequisites

Before you start administering Notification Services, ensure that the following tasks have been completed.

If stutter dial tone is required , the Gateserver that will handle SMSI notification must have a CMA agent with SMSI resource and an RS-232 connection to a switch with the ability to access the Public Switched Telephone Network. Arrangements for stutter dial tone must be in place with the Local Exchange Carrier. (See the Gateserver Installation and Configuration Manual.)
For Message Waiting Light , the Gateserver that will handle SMSI notification must have a CMA agent with an RS-232 connection to an SMSI Converter (e.g. Voice Bridge II Switch Integration Unit) or switch. (See the Gateserver Installation and Configuration Manual.)
If numeric paging is required, an SNPP paging server must be installed and administered properly and must be accessible by the Gateserver running MWI_OnOff. (See Backend Servers Reference Manual.)
The Gateserver on which the MWI_OnOff
application will reside must have ACB administered appropriately. This includes the following files:
- Attrib.<hostname>
- Route.<hostname>
- Schedule.<hostname>
  (See theGateserver Installation and Configuration Manual.)
MWI_Notify and MWI_OnOff are installed on the appropriate Gateserver. (See the Gateserver Installation and Configuration Manual.)
MWI_PlugIn and MWI_PassOff are installed and configured on the appropriate Netscape Messaging Server . (See Backend Servers Reference Manual.)
The mwi_parse.pl script is installed on the appropriate Intermail server (See Backend Servers Reference Manual.)

Managing Notification Services

You can perform the following tasks for Notification Services:

Administer MWI_OnOff.ini
Administer MWI_Notify.ini
Administer the Application Agent Routing Table
Update the Schedule Table
Set the system level defaults for message notification preferences

Administering MWI_OnOff .ini

The following steps provide the MWI_OnOff application with the information to communicate with the directory and paging servers. This information is required for message notification and paging, and is set up during the initial configuration of your system.

Step 1 Go to the Gateserver where the MWI_OnOff application resides.

Step 2 Type: cd $PARMLIB/apps/MWI_OnOff

Step 3 Edit the MWI_OnOff .ini file as desired (Table 5-1).

Note The LDAP parameters are required. The SNPP parameters are required for numeric paging notification to work. The ReturnPath and SMTPHosts parameters are required for text paging to work.

Note Multiple language support is provided for text paging. See"Multiple Language Support" in this chapter for parameter set up.

Table 5-1: MWI_OnOff Parameters

Parameter Description Valid Values

Ldapdn

The LDAP distinguished name of the LDAP "superuser." This name can be found on the LDAP server; it is the rootdn entry in the slapd.conf file.

Default: cn=Directory Manager, o=Organization

Ldappw

LDAP password for the LDAP "superuser."

This password resides on the LDAP server; it is the rootpw entry in the slapd.conf file. This value must be entered as plain text, but it may be encrypted in slapd.conf.

Ldaphost

LDAP server host name.

A valid host name.

Ldapport

LDAP server port number.

This TCP port number can be found on the LDAP server; it is the port entry in the slapd.conf file.

By convention, use 389.

Ldapsearchbase

The LDAP search base below which all subscriber entries reside.

Default: o=Organization

SNPPuser

SNPP user name.

Used for numeric paging.

SNPP_USERNAME or blank

defaults to spmaster

SNPPhost

SNPP host name.

Used for numeric paging.

The host name of the SNPP server or blank for paging disabled.

SNPPpw

SNPP password.

Used for numeric paging.

SNPP_PASSWORD or blank

SNPPport

SNPP port number.

Used for numeric paging.

The TCP port number used by the SNPP server or blank.

defaults to 444

ReturnPath

Specifies the e-mail account to which returned mail should be sent.

Used for text paging.

Valid e-mail address.

<Postmaster e-mail address>

SMTPHosts

Hosts used for text paging.

One or more valid host name(s).

If multiple host names are specified, a comma, space, or TAB must separate each host name.

Parameter	Description	Valid Values
Ldapdn	The LDAP distinguished name of the LDAP "superuser." This name can be found on the LDAP server; it is the rootdn entry in the slapd.conf file.	Default: cn=Directory Manager, o=Organization
Ldappw	LDAP password for the LDAP "superuser."	This password resides on the LDAP server; it is the rootpw entry in the slapd.conf file. This value must be entered as plain text, but it may be encrypted in slapd.conf.
Ldaphost	LDAP server host name.	A valid host name.
Ldapport	LDAP server port number. This TCP port number can be found on the LDAP server; it is the port entry in the slapd.conf file.	By convention, use 389.
Ldapsearchbase	The LDAP search base below which all subscriber entries reside.	Default: o=Organization
SNPPuser	SNPP user name. Used for numeric paging.	SNPP_USERNAME or blank defaults to spmaster
SNPPhost	SNPP host name. Used for numeric paging.	The host name of the SNPP server or blank for paging disabled.
SNPPpw	SNPP password. Used for numeric paging.	SNPP_PASSWORD or blank
SNPPport	SNPP port number. Used for numeric paging.	The TCP port number used by the SNPP server or blank. defaults to 444
ReturnPath	Specifies the e-mail account to which returned mail should be sent. Used for text paging.	Valid e-mail address. <Postmaster e-mail address>
SMTPHosts	Hosts used for text paging.	One or more valid host name(s). If multiple host names are specified, a comma, space, or TAB must separate each host name.

Multiple Language Support

To support multiple languages for text paging, the MWI_OnOff.ini file must contain a language section for each supported language similar to the default [eng] section provided in the MWI_OnOff sample file (see Figure 5-1). The language name must be ISO639 standard. Each language section must have an entry for each notification type that will contain text for the page e-mail subject.

Figure 5-1: Language Support Section in MWI_OnOff.ini

[<supported language>]

VoiceUrgentMessage=<Urgent voice text in supported language>

VoiceNormalMessage=<Voice text in supported language>

FaxUrgentMessage=<Urgent fax text in supported language>

FaxNormalMessage=<Fax text in supported language>

EmailUrgentMessage=<Urgent e-mail text in supported language>

EmailNormalMessage=<E-mail text in supported language>

Administering MWI_Notify .ini

The MWI_Notify.ini file is configured during the initial installation of your system. You can administer it, if necessary.

Step 1 Go to the Gateserver on which the MWI_Notify application resides.

Step 2 Type: cd $PARMLIB/apps/MWI_Notify

Step 3 Edit the MWI_Notify .ini file as desired (Table 5-2).

Note You must have the Port parameter for Message Notification to work.

Table 5-2: MWI_Notify Parameters

Parameter Description Valid Values

Port

The TCP Port number is used for a socket connection between MWI_PassOff and MWI_Notify . This is how the two applications communicate. MWI_Notify listens on this port.

Specifying a value less than 1024 will require the application to have super-user privileges.

The Port value cannot be specified as zero. By convention, use 4077 as the port number.

FIFO

The Fifo parameter should not be used. It is for internal Cisco testing only.

/tmp/sp_mwi

Parameter	Description	Valid Values
Port	The TCP Port number is used for a socket connection between MWI_PassOff and MWI_Notify . This is how the two applications communicate. MWI_Notify listens on this port. Specifying a value less than 1024 will require the application to have super-user privileges.	The Port value cannot be specified as zero. By convention, use 4077 as the port number.
FIFO	The Fifo parameter should not be used. It is for internal Cisco testing only.	/tmp/sp_mwi

Administering the Application Routing Table for MWI

The uOne product requires that the same Gateserver turn MWI on and off. This is accomplished by administering the Application Routing table appropriately.

Step 1 The $PARMLIB/parms/APP/Route.<hostname> file needs to contain SERVICE entries that specify a CMA agent host with which to send SMSI (on/off), given a search token of the form "MWI<subscriber_mailbox_id>." These entries have the following format:

SERVICE TNT <host> <MWI>

Note The Route.<hostname> file is searched from the top down for matches. MWI should be placed before any entries with a wildcard such as * (see the Gateserver Installation and Configuration Manual).

Figure 5-2: Example of Route.<hostname> (Gateserver)

SERVICE TNT host804 MWI804

SERVICE TNT host703 MWI703

SERVICE APP host *

Administering the Schedule Table for MWI

The MWI_Notify and MWI_OnOff applications are added to the Schedule.<hostname> file during the initial installation of your system. The following procedure shows how these applications can be administered.

Step 1 Go to the Gateserver on which the MWI_Notify and MWI_OnOff applications should reside. Type:

$PARMLIB/parms/APP

Step 2 Modify the MWI_Notify and MWI_OnOff lines in the Schedule.<hostname> file as desired. See the uOne Gateserver Installation and Configuration Manual for information on that file.

Figure 5-3: Example of Schedule.<hostname>

DATATOKEN 100 1 * * 8049354629 amisain/amisain DATATOKEN 100 1 * * 804 UM/UM UM.ini STATIC_NOWAIT 100 1 * * * MWI_Notify MWI_Notify/MWI_Notify DATATOKEN 100 1 * * MWI_OnOff MWI_OnOff/MWI_OnOff STATIC_NOWAIT 100 1 * * * FaxPrint UM/FaxPrint

Step 3 Shutdown MWI_PassOff and MWI_Notify in an orderly fashion to ensure that notification events are not dropped:

a. Shutdown MWI_PassOff first on the messaging server host:

: kill <pid of MWI_PassOff>

b. Then shutdown MWI_Notify (if it exists):

: kill <pid of MWI_Notify>

Caution MWI shutdown can cause notification events to be dropped. Shutting down MWI_PassOff and MWI_Notify will cause notification events to accumulate in the FIFO file. If the file fills up, then events can be dropped. You should bring MWI up immediately after MWI shutdown.

Step 4 Reload the schedule table. Type:

umcli

reload sched all

Step 5 As superuser on the messaging server , start MWI_PassOff :

/opt/local/bin/MWI_PassOff -h <Gateserver>

where Gateserver is the host name of the Gateserver where MWI_Notify is running.

Setting the System Level Defaults for Message Notification Preferences

Message notification is based on the message type (voice, fax - optional, and e-mail - optional) and the message urgency (normal or urgent). For example, the system can be set up to page on all urgent messages of all types, have MWI (stutter dialtone or light indicator) for all voice and fax messages, and have no message notification on normal e-mails.

Note You can have MWI and paging on the same message.

The following steps will provide uOne Administration with the default (initial) notification values that will be set when a new subscriber and a pager (optional) are added through uOne Administration. Subscribers have the ability to tailor message notification to their own preferences by using the Personal Mailbox Administration, the subscriber web administration tool.

Step 1 Go to the Gateserver on which uOne Administration resides and log in as spmaster.

Step 2 Type:
cd /home2/spmaster/ADMIN/cgi-bin/MSGadmin/MSGdata

Step 3 Edit defaultData.ini files and set the following parameters (Table 5-3).

[addNotifyforNewSub]
numOfAttrs=<XX>
attr<YY>=<Value>
referenceAttr=<NotificationMethod>

Note You must add these parameters for Message Notification to work.

.
Table 5-3: defaultData.ini Parameters

Parameter Description Valid Values

[<section>]

This is a section label.

addNotifyforNewPager

addNotifyforNewSub

numOfAttrs=XX

The number of attributes parameter can be changed as long as it matches the number of attributes.

XX=Integer Value

attrYY=Value

YY is a numeric value corresponding to its position within the attribute list. There must be no gaps in the numbering of options.

Value specifies an LDAP attribute that describes what message type and urgency will apply to this type of Message Notification (e.g. pager or MWI).

YY = Integer Value

Value =

notifyvoicenormal

notifyvoiceurgent

notifyfaxnormal

notifyfaxurgent

notifyemailnormal

notifyemailurgent

ReferenceAttr=
<NotificationMethod>

Describes the notification method to be used for messages defined by the attribute list.

This field can be edited, but should not be removed.

NotificationMethod=

pager—sends a page on every message defined by the attribute list.

cn—sends an MWI signal on every message as defined by the attribute list.

Parameter	Description	Valid Values
[<section>]	This is a section label.	addNotifyforNewPager addNotifyforNewSub
numOfAttrs=XX	The number of attributes parameter can be changed as long as it matches the number of attributes.	XX=Integer Value
attrYY=Value	YY is a numeric value corresponding to its position within the attribute list. There must be no gaps in the numbering of options. Value specifies an LDAP attribute that describes what message type and urgency will apply to this type of Message Notification (e.g. pager or MWI).	YY = Integer Value Value = notifyvoicenormal notifyvoiceurgent notifyfaxnormal notifyfaxurgent notifyemailnormal notifyemailurgent
ReferenceAttr= <NotificationMethod>	Describes the notification method to be used for messages defined by the attribute list. This field can be edited, but should not be removed.	NotificationMethod= pager—sends a page on every message defined by the attribute list. cn—sends an MWI signal on every message as defined by the attribute list.

Figure 5-4: Example of a defaultData.ini file

[addNotifyforNewSub] numOfAttrs=2 attr1=notifyvoicenormal attr2=notifyvoiceurgent referenceAttr=cn

Table of Contents