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

DESTROYENTITY Command

The DESTROYENTITY command destroys an existing entity. However, you cannot destroy an entity if it contains associated data or if other entities forward or escalate to this entity.

Associated data includes method level parameters, parameter overrides at the entity level or time block level, and the time blocks themselves. Delete associated data in this order:

• All parameter overrides
• Method level parameters
• All time blocks

You can change the destination of or delete those entities that forward or escalate to this entity. For more information, see the descriptions of the DESTROYPARM and DESTROYTIME commands.

This command has the following format:

ADDRESS VOX "DESTROYENTITY KEY(key)
[CASCADE(YES|NO)]" 

KEY

Specifies the key of the entity to be deleted.

CASCADE

(Optional) Values are:

YES

Destroy all other items in the database that refer to this item.

NO

Do not destroy any other items in the database that refer to this item.

Default: NO

For example, if you specify CASCADE(YES) when deleting an entity, all of the data associated with the entity (time blocks, methods, personal and time block-specific parameter overrides) are deleted. If you specify CASCADE(NO) for an entity that has associated data, the command fails.

Return Information:

After DESTROYENTITY 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.

Usage Notes:

For additional information about obtaining associated data and entities that forward and escalate to this entity, see the following REXX programs that are located in the CA Automation Point installation directory \sample\nm:

• listent.rex
• listparm.rex
• lstforto.rex
• listtime.rex

Example:

Assume that Joe's entity key is 100001111. The following example removes the entry for entity Joe from the database:

ADDRESS VOX "DestroyEntity KEY(100001111)"