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

CREATEPARM Command

The CREATEPARM command creates a new parameter.

This command has the following format:

ADDRESS VOX "CREATEPARM NAME(parm name) METHOD(method name or key) 
   ITEM(time key|entity name or key) VALUE(value) [DESC(desc)]"

NAME

Specifies the name of the parameter to be created.

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

METHOD

Specifies the name or key of the method that owns this parameter.

ITEM

Specifies the name or key of the entity that owns this parameter or the key of the time block that owns it.

You specify this parameter when you want to create a parameter at the entity or time block level. Do not specify this parameter if you want to create a parameter at the method level.

Note: To create a parameter at the entity or time-block level, you must first create a parameter with the same name at the method level.

VALUE

Specifies the actual value of this parameter for the specified method and item. This data is passed to the methods. The maximum length of this operand is 240 characters.

DESC

(Optional) Describes the use and meaning of this parameter.

When you create a parameter at the method level, you must specify a description of the parameter. When you create a parameter at the entity or time block level, you cannot specify a description of the parameter. This data is not passed to the methods. The maximum length of this operand is 1000 characters.

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.

You cannot create (specify) a parameter value at the entity or time block level unless you first create a parameter with the same name at the method level. For instance, if the REXX program that performs the MyPage method has a PagerID parameter and you want to specify the pager ID for Chris, you must issue the following commands:

CreateParm Name(PagerID) Method(MyPage) Value() Desc(Pager ID)
CreateParm Name(PagerID) Method(MyPage) Item(Chris) Value(123)

Return Information:

After CREATEPARM 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.CreateParm.NewKey contains the key of the newly created parameter.
• If the command does not execute successfully, the RC variable contains a nonzero value. Additionally, 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 that defines 131 as the value for the parameter WAIT whenever the MyMethod method is used to tell Joe something:

ADDRESS VOX "CreateParm Method(MyMethod) ITEM(Joe) NAME(WAIT) VALUE(131)"