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

LISTFIND Command

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

This command has the following format:

ADDRESS VOX "LISTFIND NAME(name)|KEY(key) DOW(dow)|DATE(mm/dd) TIME(hh:mm)
   [CMDRESP(destination)]      
   [MTUP (A|profile)]
   [PREFIX(varname)]"

NAME

Specifies the name of the entity for which a find tree is to be created.

KEY

Specifies the key of the entity for which a find tree is to be created.

DOW

Specifies the day for which you want to search.

Days are specified as the first three characters of their English names. You can specify only one day. If you specify this operand, you cannot specify the DATE operand.

DATE

Specifies the date (no year is specified) for which you want to search.

If you specify this operand, you cannot specify the DOW operand.

TIME

Specifies, in military time format (00:00 to 23:59), the time for which you want to search.

CMDRESP

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

Default: REXX

MTUP

(Optional) Use the Methods to Use Profile (MTUP) operand to specify which methods are attempted for a particular instance of an NMFIND notification request. The method type code for each method is defined in the Notification Manager database under the TYP parameter for the method. Before attempting to notify a contact using a scheduled method, Notification Manager compares the value its method type code with the profile specified on the MTUP operand. If the method type code is not part of the MTUP profile, notification is not attempted, and the next scheduled method is compared against the MTUP profile. If the method type code is part of the MTUP profile, then the notification is attempted using that method.

The values for this operand are:

profile

Any combination of method type codes B through W.

A

All method types specified for all active schedules. No comparisons are made, and all methods are attempted.

Default: A

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 the section ADDRESS VOX Return Information.

Default: VOX.LISTFIND

Return Information:

After LISTFIND 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.listfind.0 variable contains the number of lines of information returned. Each variable from VOX.listfind.1 to VOX.listfind.n contains a line of information. n represents the last line of return information. Consider the following REXX variables:

  VOX.ListFind.BgnTime

  The latest start time of any time block in the call tree

  VOX.ListFind.EndTime

  The earliest end time of any time block in the call tree. This allows the caller to see the range of time when this tree is valid.

• 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.

Usage Note:

For further details, refer to the sample REXX programs listfind.rex and listmtup.rex located in the CA Automation Point installation directory \sample\nm.

Example:

The following example checks the tree for Fran Smith at 10:00 a.m. on October 11:

ADDRESS VOX "LISTFIND NAME(Fran Smith) TIME(10:00) DATE(10/11)"