Previous Topic: Avoiding Errors in Your REXX Programs

Next Topic: VOX Commands that Perform I/O Operations


VOX Command Summary

This section discusses the following types of commands:

For command syntax, see the Command and Keyword Reference Guide.

Notification Manager Database Maintenance Commands

Use the following commands to manage the Notification Manager database.

ALTERENTITY

Alters the characteristics of an entity.

ALTERMETHOD

Alters the characteristics of a method.

ALTERPARM

Alters the characteristics of a parameter.

ALTERTIME

Alters the characteristics of a time block.

CREATEENTITY

Creates an entity.

CREATELOGIN

Creates a login.

CREATEMETHOD

Creates a method.

CREATEPARM

Creates a parameter.

CREATETIME

Creates a time block.

DESTROYENTITY

Destroys an existing entity.

DESTROYLOGIN

Destroys an existing login.

DESTROYMETHOD

Destroys an existing method.

DESTROYPARM

Destroys an existing parameter.

DESTROYTIME

Destroys an existing time block.

EPWCHECK

Checks the password for an entity.

LISTENTITY

Lists all the data for one or more entities (except the password).

LISTFIND

Lists the time blocks that are active for one or more entities at a given date and time. The list is a tree that can contain any level of nesting.

LISTFORTO

Lists all the time blocks that forward to a given entity (regardless of the time and date). The list is a tree that can contain any level of nesting.

LISTLOGIN

Lists all the data for one or more logins.

LISTMETHOD

Lists all the data for one or more methods.

LISTPARM

Lists all of the data for one or more parameters.

LISTPERGRPS

Lists all personal groups for a specified contact.

LISTTIME

Lists all the data for one or more time blocks.

NMDBMERGE

Merges a previously exported copy of a database into the current Notification Manager database.

NMEXPORT

Creates a copy of the current Notification Manager database in a format that can be easily moved to another system.

NMIADDCALLER

Adds an entity to the list of entities that are allowed to call in on an item.

NMIANSWER

Sets or retrieves the answer for an item in the Notification Manager database.

NMICHECKCALLER

Checks to see whether an entity has been permitted to listen to/answer this item (by a call to NMIADDCALLER).

NMIGETITEM

Retrieves the ask text and tell text for an item from the Notification Manager database.

NMILISTANSWERS

Retrieves the answers that are specified using the NMFIND ASK parameter (if any) for a notification request item stored in the Notification Manager database.

NMILISTCALLERS

Retrieves status information about every notification attempt that is made during the processing of a notification request item stored in the Notification Manager database.

NMILISTITEMS

Retrieves detailed status information about notification request items stored in the Notification Manager database

NMIMPORT

Imports a copy of a Notification Manager database.

Notification Commands

Use the following commands for notification tasks.

PAGE

Issues an alphanumeric page to designated personnel using a modem-based alphanumeric paging service.

PAGE2WAY

Issues an alphanumeric page to designated personnel using an Internet-based alphanumeric paging service.

SENDMAIL

Generates an e-mail message to designated personnel.

Voice Processing Commands

Use the following commands for voice processing tasks.

ANSWER

Waits for an incoming telephone call on any available voice channel, any voice channel within a group, or a specific voice channel only.

ANSWERPLAY

Waits for an incoming telephone call (in the same way as the ANSWER command) and plays one or more prerecorded voice messages after answering.

CALL

Initiates a telephone call using an open, available voice channel.

CALLPLAY

Initiates a telephone call on an available voice channel and plays one or more prerecorded voice messages.

CLEAR

Clears the digit buffer of a voice channel or its call progress analysis (CPA) parameters.

GETCHANNEL

Serializes I/O activity on a voice channel by marking an available channel as in-use. The calling REXX program then has exclusive access to the channel.

GETCHANNELNUM

Identifies the physical voice channel number associated with a channel handle.

GETDIGITS

Retrieves tone digits-such as menu selections or access codes that a remote party enters from a telephone keypad in response to a voice prompt-from the digit buffer of a voice channel.

GETGROUP

Returns a text string containing a group name and a list of all physical voice channel numbers associated with the group.

GETSTATUS

Returns the current status of a voice channel.

GETSYSNAMES

Retrieves the system names of all connected notification servers in a distributed environment.

LOAD

Loads a voice file or voice word library index file into main memory for faster access.

PLAY

Plays a prerecorded voice message through a specified voice channel.

PLAYGETDIGITS

Plays a prerecorded voice message through a specified voice channel, and then retrieves tone digits that the remote party enters from the telephone keypad.

RECORDFILE

Records a voice message from the remote party and stores it in a disk file.

RELEASECHANNEL

Resets a voice channel marked as in-use by the GETCHANNEL command, making the channel available to other REXX programs issuing a GETCHANNEL command. Used with the GETCHANNEL command to serialize I/O activity on a channel.

SENDTONES

Sends tone digits through an already-open voice channel, useful for sending additional tones after CA Automation Point has successfully called and connected to the remote party.

SETGROUP

Associates a group name with one or more voice channels.

SETHOOK

Sets the hook state of a voice channel to on-hook or off-hook, useful in special circumstances such as multiple CALL operations within a single REXX program.

SETVOLUME

Adjusts the volume for current and subsequent PLAY operations on a specified voice channel.

STOP

Terminates an active I/O operation on a voice channel.

VERIFYUSER

Checks the validity of the user ID and password combination of the remote party.

WINK

Sends a brief "handshaking" protocol signal through a voice channel.

Utility Commands

The following commands are ADDRESS VOX utility commands.

GETTAPIDEVICELIST

Lists all the TAPI devices that are installed under Windows.

SETENGINE

Allows you to modify notification server settings.

SETMSGSTREAM

Duplicates the message stream from CA Automation Point to another queue that is accessible through PPQs, local or remote.

SETTRACE

Start and stop trace logging.

SLEEP

Causes the issuing REXX EXEC to enter a system sleep state.

STARTREXX

Starts another REXX program.

VER

Provides the version number and configuration information of the CA Automation Point notification services at your site