ADDRESS VOX Commands › Notification Manager Database Maintenance Commands › NMILISTITEMS Command

NMILISTITEMS Command

This command lists detailed status information about previously issued notification requests. Each command operand is optional, and the combination of operands is used to define and restrict the items the query returns.

This command has the following format:

ADDRESS VOX "NMILISTITEMS 
  [ITEM(item)] 
  [ITEMSTATUS(status)]
  [NOTIFIER(name)]
  [RECENTITY(name)]
  [ANSENTITY(name)]
  [BGNTST(timestamp)]
  [ENDTST(timestamp)]
  [MAXITEMS(number)]
  [CMDRESP(destination)]
  [PREFIX(varname)]"

ITEM

(Optional) Specifies the item number.

ITEMSTATUS

(Optional) This operand is used to specify the notification request status that is used to restrict the query results. By specifying an item status, only those notification requests that are currently in the specified status are returned by this query. This operand accepts the following status values:

0

Initializing status

1

Sending status

2

Sent status

3

Awaiting Response status

4

Responded status

5

Late Response status

6

No Response status

7

Failed status

NOTIFIER

(Optional) This operand is used to specify the name of the login that is used to initiate the notification request. By specifying a value for this operand, the query is restricted to show only those notification requests initiated by the specified login. You can specify one or more wildcard characters to match more than one login name.

RECENTITY

(Optional) This operand is used to specify the name of the contact that is used as the target for the notification request. By specifying a value for this operand, the query is restricted to show only those notification requests for which the specified contact was the initial recipient. You can specify one or more wildcard characters to match more than one contact name.

ANSENTITY

(Optional) This operand is used to specify the exact name of the contact that has permission to provide an answer to a notification request. By specifying a value for this operand, the query is restricted to show only those notification requests that the specified contact has permission to answer.

BGNTST

(Optional) This operand is used to specify the beginning timestamp for retrieving notification requests. By specifying a value for this operand, the query is restricted to show only those notification requests initiated after the date and time reflected by the specified timestamp. The timestamp value reflects the number of seconds elapsed since midnight, January 1, 1970.

ENDTST

(Optional) This operand is used to specify the ending timestamp for retrieving notification requests. By specifying a value for this operand, the query is restricted to show only those notification requests initiated before the date and time reflected by the specified timestamp. The timestamp value reflects the number of seconds elapsed since midnight, January 1, 1970.

MAXITEMS

(Optional) This operand is used to specify the maximum number of notification requests to retrieve from the database. By specifying a value for this operand, the query is restricted to show no more than the number of items that are reflected by the value of this operand.

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

PREFIX

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

For information about changing the default variable name, see ADDRESS VOX Return Information.

Default: VOX.NMILISTITEMS

Usage Note:

For more information on this command, see the sample REXX program listitems.rex in the CA Automation Point installation folder \sample\nm.

Return Information:

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

• If the command executes successfully, the RC variable contains a value of zero. The VOX.nmilistitems.0 variable contains the number of lines of information returned. Each variable from VOX. nmilistitems.1 to VOX. nmilistitems.n contains a line of information. n represents the last line of return information.
• If the command does not execute successfully, the RC variable contains a nonzero value. The VOX.ERROR variable contains the complete VOX error message, which includes the four-digit return code and error message text.

Example:

This example shows all notification requests currently in the Awaiting Response state that were sent to the contact “Joe”:

ADDRESS VOX “NMILISTITEMS ITEMSTATUS(3) RECENTITY(Joe)"