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

CREATEMETHOD Command

The CREATEMETHOD command creates a new method.

This command has the following format:

ADDRESS VOX "CREATEMETHOD "NAME(name)
  INVOKE(invocation string)
  USE(TELL|ASK|BOTH)
  [TYP(B|C|D|...|W)]"

NAME

Specifies the name of the entity to be created.

Note: Names can only contain uppercase and lowercase letters, numbers, blanks, and the following special characters: - _ @ # . $ % / ; : \

INVOKE

Specifies the string that is used to invoke this method.

The invocation string must begin with the name of the command or REXX script to be invoked. Parameters that never change can follow. (Parameters can also be added to the invocation by using the PARMS features of this database.)

USE

Specifies what this method is used for. Values are:

TELL

The method may only be used to pass data to the entity.

ASK

The method may only be used to receive data from the entity.

Note: The ASK value on the USE operand is not applicable if you are using the CA Automation Point DBMS.

BOTH

The method may be used to ask, tell, or both.

TYP

(Optional) A one-letter designation that specifies the method type code for the method. When NMFIND is invoked with the MTUP parameter and if the TYP character is a member of the MTUP list, then the method is attempted.

Return Information:

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

• If the command executes successfully, the RC variable contains a value of zero. The REXX variable vox.CreateMethod.NewKey contains the key of the newly created method.
• 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 creates an entry in the database for method MyMethod:

ADDRESS VOX "CreateMethod NAME(MyMethod) INVOKE(XREXX1) USE(both)"