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

LISTPARM Command

The LISTPARM command lists all the data for one or more parameters. Specify at least one of the NAME, KEY, METHOD, and ITEM operands. If you specify more than one operand, the search becomes more restrictive.

This command has the following format:

ADDRESS VOX "LISTPARM NAME(parm name)|KEY(parm key) METHOD(method name or key)
    ITEM(entity name or entity key) [CMDRESP(destination)] [PREFIX(varname)]"

NAME

Specifies the name of the parameter to be listed. An asterisk (*) indicates that you want data for all parameters to be listed.

KEY

Specifies the key of the parameter to be listed.

METHOD

Specifies the name or the key of the method to which the parameters are to belong.

ITEM

Specifies the key or name of the entity to which the parameters are to belong.

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

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

Usage Notes:

Parameter entries are divided into three increasingly specific classes:

• The method class-Those entries that apply any time the method is used.
• The entity class-Those entries that apply any time a method is used for a particular entity.
• The time class-Those entries that apply only for a particular time block, which implies a specific entity and method.

Here are some procedures for retrieving data from LISTPARM:

• If you specify a method and nothing else, you will receive all entries in all three classes for that method.
• If you want just the entries in the method class for the method, specify ITEM(-1).
• If you specify a method and an entity, you receive all entries in the entity and time classes.
• If you want just the entries in the entity class, specify the negation of the key of the entity in the ITEM() operand.
• If the method key is negative, the item key is for a time block, and the parameter name is *, the output will be the format that NMFIND needs (all time block-level entries, then all the entity-level entries for the entity that owns the time block, then all the method-level entries for the method).

Return Information:

After the LISTPARM 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.listparm.0 variable contains the number of lines of information returned. Each variable from VOX.listparm.1 to VOX.listparm.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:

The following example lists the data for PAGERID for VOICE1 for Fran Smith:

ADDRESS VOX "LISTPARM NAME(PAGERID) METHOD(VOICE1) ITEM(FRAN SMITH)"

For further details, refer to the sample REXX program listparm.rex, located in the CA Automation Point installation directory \sample\nm.