Previous Topic: NMPAGE2WAY MethodNext Topic: NMSPEAK Method


NMPAGE2WAY Parameter Descriptions

AnswerWait

Specifies the number of seconds that NMPAGE2WAY should wait for a reply (either through a reply to the page request or through a call-in) before allowing NMFIND to try the next method of contacting someone. Once this time interval elapses, the page recipient must place a call to NMANSWER to resolve the issue (no further page replies will be accepted).

Default: 300

CompleteStatus

Specifies the 2-way page status value that NMPAGE2WAY will use to determine both when the notification attempt has completed and whether the notification was successful. NMPAGE2WAY waits for the page request to reach the status specified by this parameter before either processing ASK parameters or returning control to NMFIND. If the time interval specified by the AnswerWait parameter elapses before the page request reaches the required status, an error is returned to NMFIND and processing continues. The possible values for this parameter are:

QUEUED

The page request was successfully submitted to the pager service

DELIVERED

The page request was sent to the pager and a positive receipt acknowledgement was received from the pager by the pager service

READ

The pager acknowledged receipt of the page request and the page request was viewed by the recipient

REPLIED

The page recipient received the page request and sent a reply to this page request back to the pager service

Note: The list of supported status indicators may vary by pager service provider. Contact your pager service provider for details.

Default: QUEUED

Debug

Determines whether Notification Manager is to generate debugging messages at the command prompt or the AXCREXX window and in the ASOTRACE log.

Default: NO

Greeting

Specifies the message to present at the top of the pager's display (before the TELL and ASK messages are presented).

Default: NM Calling

MaxMsgLen

Specifies the maximum length of the message to be sent to the pager. If the message is longer than the maximum length allowed, it is truncated (but the page is still sent). If the message is truncated and the call-in feature (NMANSWER) is configured, the message will be prefixed with call-in information so that the full message may be accessed using the call-in feature.

Note: Although the first MaxMsgLen number characters of a message are sent to the pager service, the message is still subject to message length limitations imposed by the pager service. Contact your pager service provider for message length limitation and message handling when the length limitation is exceeded.

Default: 500

NMFindWait

This parameter forces NMFIND to guarantee that the person who was paged has at least a certain additional amount of time (in seconds) after the method completes to call-in to answer the page.

Default: 300

Numeric

Specifies whether the page device is numeric or alphanumeric.

Numeric page devices are limited to messages that contain numbers 0-9, hyphens '-', parentheses '()', and commas ','.

Valid values for this parameter are:

YES

The page device is a numeric pager.

Note: When Numeric=YES, set TellExact=YES to send a valid numeric TELL message to the numeric page device.

Set TellExact=NO to send a numeric message containing a call-in phone number and the notification item number. The receipt of the page will have to use the call-in feature to retrieve the actual TELL message.

Note: When Numeric=YES, the TELL message is not prefixed with a Greeting.

NO

The page device is an alphanumeric pager.

Default: NO

PagerID

Specifies the pager ID of the page device that NMPAGE2WAY requests the pager service to page.

PagerPW

Specifies the password associated with the specified pager ID that NMPAGE2WAY uses to issue the page request. The use of pager passwords varies by pager service provider. Contact you pager service provider for details.

Default: No password

Provider

Specifies the name of the pager service that is to receive the page request (as defined in the 2-Way Paging Setup dialog).

ReplyPrefix

When a reply to a page request is sent from the 2-way messaging device, the device or the paging service itself may add additional information to the beginning of the reply (contact your paging provider for details). If this additional information is consistent for each page reply, the NMPAGE2WAY method can filter out this additional information before comparing the reply to the list of specified ASK parameters. In addition to the prefix added by the pager service, the Notification Server adds the additional prefix REPLIED to all page replies received. Since the word REPLIED always appears at the beginning of the page reply, this parameter must start with the word REPLIED, followed by any constant prefix added by the pager service.

All messages received by Notification Server from a 2-way messaging device follow this format:

REPLIED prefixed_text page_reply_message
REPLIED

The REPLIED keyword, which is added by the Notification Server, is always the first word of the reply message.

prefixed_text

A prefix text containing additional information may or may not be automatically added by the pager service or the page device. Contact your pager service provider for details.

page_reply_message

The reply message sent by the page recipient.

To filter out the beginning text of a reply message so that Notification Manager can identify the reply to the page, set ReplyPrefix to 'REPLIED prefixed_text'

Default: REPLIED

SendAck

Determines whether positive acknowledgement messages are sent to the page recipient during processing of the notification attempt. The possible values for this parameter are:

YES

Acknowledgement messages are sent to the page recipient during processing of the notification attempt.

NO

No additional messages are sent to inform the page recipient of events concerning the current notification attempt.

Default: NO

SendURL

Specifies whether the Notification Website URL is appended to the end of the notification text.

Default: NO

System

Specifies the name of the system that is running the Notification Server to which NMPAGE2WAY requests associated with the method is to be sent.

Default: The name of the Notification Server specified in the Notification Startup Options dialog.

TellExact

Determines whether Notification Manager prefixes the TELL message with a call-in number and an item number. The possible values are:

YES

Issue the page message without the header text, call-in number, and item number added.

NO

Issue the page message with a message header text, call-in number, and an item number.

Default: NO

UseMCR

Determines whether the NMPAGE2WAY method uses the MCR (Multiple Choice Response) capability of the 2-way paging device to send the specified ASK parameters to the page recipient. If the specified pager or pager service does not support MCR messages (sometimes called “programmed replies”), set this parameter to NO. The possible values for this parameter are:

YES

The ASK parameters are sent to the pager using the MCR capability of the underlying 2-way paging protocols.

NO

The ASK parameters are appended to the existing TELL message.

Note: Support for MCR messages vary by paging service provider. Contact your paging service provider for details

Default: NO