CREATEENTITY Command

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

CREATEENTITY Command

The CREATEENTITY command creates a new entity.

This command has the following format:

ADDRESS VOX "CREATEENTITY NAME(name)
   [AVAIL(YES|NO)]  
   [BROADCAST(YES|NO)]
   [ESCTO(key|name)]  
   [KEY(key)]
   [NMGROUP(YES|NO)]
   [PASSWORD(password)]
   [UNAVAILDESC(desc)]"

NAME

The name of the entity to be created. Names can only contain uppercase and lowercase letters, numbers, blanks, and the following special characters: - _ @ # . $ % / : ; \

AVAIL

(Optional) This operand defines if the entity is available to be contacted. Values are:

YES: Notification Manager will attempt to contact this entity
NO: No attempt will be made to contact this entity.

Until the AVAIL is set to YES, Notification Manager will not attempt to contact this entity

Note: This is not a valid operand for Groups.

Default: YES

BROADCAST

(Optional) Values are:

YES: Perform all methods that are active at the current time
NO: Terminate processing for this entity as soon as one method succeeds.

Default: NO

ESCTO

(Optional) If this entity cannot be found, escalates to the entity whose key or name is specified. If 0 is specified, escalation does not take place.

KEY

(Optional) Specifies the numeric ID to be associated with this entity. The ID must be between 100001001 and 199999999.

NMGROUP

(Optional) This operand determines whether the entity being created will be designated as an individual or a group. If this is set to YES, the entity created will be a group.

Default: NO

PASSWORD

(Optional) Specifies the password for this entity. Passwords are between four and eight numeric digits.

UNAVAILDESC

(Optional) This operand is used to define the description of why an entity is unavailable.

Note: This is not a valid operand for Groups.

Return Information:

After the CREATEENTITY 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 REXX variable vox.CreateEntity.NewKey contains the key of the newly created entity.
If the command does not execute successfully, the RC variable contains a nonzero value. The VOX.ERROR variable also 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 Joe:

ADDRESS VOX "CreateEntity NAME(Joe) BROADCAST(no) PASSWORD(1111) ESCTO(Frank)"