Previous Topic: PAGE CommandNext Topic: SENDMAIL Command

ADDRESS VOX Commands › Notification Commands › PAGE2WAY Command

PAGE2WAY Command

The PAGE2WAY command is a notification command that issues an alphanumeric page to a designated page device using the Internet to relay these requests to the appropriate paging service. To receive page requests using this command, the paging service must support either the SNPP (Simple Network Paging Protocol) or WCTP (Wireless Communication Transfer Protocol) protocols.

This command has the following format:

ADDRESS VOX "PAGE2WAY
  PAGERID(number)
  PROVIDER(paging service name)
  {MESSAGE(message) | STATUS(message ID) | EXPIRE(message ID)}
  [ PAGERPW(password) ]
  [ MCRESPONSE(rsp1;rsp2;rsp3 ...) ]
  [ WAITSTATUS(QUEUED|DELIVERED|READ|REPLIED) ]
  [ WAIT(statuswait) ]
  [ SYSTEM(sysname) ]
  [ PREFIX(varname) ]
  [ CMDRESP(destination) ]"
PAGERID

Specifies the pager ID number (up to 15 digits).

PROVIDER

Specifies the user-defined name of the paging service (up to 256 characters). Paging service names are defined using the 2-Way Paging Setup dialog (located inside Configuration Manager) that will associate the paging service name with the required parameters used to connect to the paging service gateway system.

MESSAGE

Specifies the text message to be displayed on the 2-way pager device. Although this message can be up to 500 characters long, the message is still subject to message length limitations imposed by the pager service. Contact your pager service provider for details.

The MESSAGE, STATUS, and EXPIRE keywords are mutually exclusive.

STATUS

A text message ID assigned by the paging service (up to 128 characters). This message ID is returned with the initial MESSAGE request in the VOX.PAGE2WAY variable (by default) and is used to query the paging service for the status of a previously issued page request. The results of this STATUS request will also be placed in the VOX.PAGE2WAY variable (by default) and will be one of the following four values: QUEUED, DELIVERED, READ, or REPLIED <Full Text Response>. The <Full Text Response> section of the REPLIED value will be the text of the response sent from the 2-way device that corresponds to the page request. The MESSAGE, STATUS, and EXPIRE keywords are mutually exclusive.

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

EXPIRE

A text message ID assigned by the paging service (up to 128 characters). This message ID is returned with the initial MESSAGE request in the VOX.PAGE2WAY variable (by default) and is used to remove the associated page item from the page item list maintained by the Notification Server. The Notification Server will periodically query the defined paging services for status updates to the previously issued page requests contained within the page item list. If no further status updates are required for a specific 2-way page request, you may use this keyword to manually remove (or expire) the associated page item. If this keyword is not used, the page item will remain active until either the reply to the page request has been returned in response to a STATUS request or the age of the page item exceeds the expire time. The MESSAGE, STATUS, and EXPIRE keywords are mutually exclusive.

PAGERPW

(Optional) Specifies the alphanumeric access code provided by the paging service, if required (up to 15 characters). Contact your paging service provider for details.

This operand is valid only in combination with the MESSAGE operand.

MCRESPONSE

(Optional) An optional list of alphanumeric multiple-choice responses (MCR) that, if specified, will be sent to the 2-way device in addition to the message text. The recipient can then choose one of these pre-programmed responses when sending a reply back to the paging service. The responses specified using this operand must be separated using a semicolon (";"), and the total length of the value of this operand must not exceed 512 characters (including separation characters). This operand is valid only in combination with the MESSAGE operand. It is at the discretion of the paging service to determine how many MCR responses are allowed, if the paging service supports this functionality.

WAITSTATUS

(Optional) Specifies the status text used to determine when the associated STATUS request should return with a page status value. This operand can be used to delay execution of your REXX program until either the status of the specified page request matches the status text specified for this operand, or the wait interval specified in the WAIT operand expires. This operand is only valid in combination with the STATUS operand.

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

WAIT

(Optional) Specifies the amount of time to wait, in 1/10-second intervals, for the status of the specified page request to match the status specified by the WAITSTATUS operand. This operand is only valid in combination with both the WAITSTATUS operand and the STATUS operand.

Default: WAIT(6000) (Ten minutes)

SYSTEM

(Optional) Specifies the alphanumeric name of the system that is running the Notification Server to which you want to direct the command (up to 8 characters).

Default: The local system name.

PREFIX

(Optional) Specifies the name of a REXX stem variable (other than the default name) that contains the return information for the command.

Default: VOX.PAGE2WAY

CMDRESP

(Optional) Directs return information, if any, to a specific destination. For a list of valid destination values, see ADDRESS VOX Return Information in this chapter.

Default: REXX

Return Information:

After the PAGE2WAY command executes, it sets the special REXX return code variable RC.

Usage Notes:

The CA Automation Point server machine must have the ability to access the Internet in order to submit 2-way page requests to the configured paging service providers.

Examples: