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

ALTERENTITY Command

The ALTERENTITY command changes the characteristics of an entity.

This command has the following format:

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

KEY

Specifies the key of the entity whose characteristics are to be altered.

AVAIL

(Optional) Specifies if the entity is available to be contacted. If the value is set to 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 times and methods that are active at the current time.

NO

Terminate processing for this entity as soon as one time or method succeeds.

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.

NAME

(Optional) Specifies the new name to be assigned to this entity. Names can only contain uppercase and lowercase letters, numbers, blanks, and the following special characters: - _ @ # . $ % / ; : \

PASSWORD

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

UNAVAILDESC

(Optional) Defines the description of why an entity is unavailable.

Note: This operand is not valid for Groups.

Return Information:

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

• If the command executes successfully, the RC variable contains a value of zero.
• 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 changes the escalation entity for the entity with key 100001009 to Mary Jones:

ADDRESS VOX "AlterEntity KEY(100001009) ESCTO(Mary Jones)"