DELETE function

The DELETE function corresponds to the DELETE line command, which can be issued from most views.

The DELETE function can delete the following items:

An object, set, TOM system, layer system pool, system layer, sysplex layer, or a layer sysplex from the object Definition Base
A date, time, time period, or calendar set from a calendar Definition Base
An entire object Definition Base or a calendar Definition Base from the Registry

Related topic

This function is useful because sometimes deleting multiple objects in an EXEC takes less time than deleting each object individually from the UI. Once the changes are specified in the EXEC, you can also review your changes in a single place before scheduling the EXEC.

The following table shows the command and parameters:

Command	Parameters
TOMEXEC FUNCTION(DELETE)	OBJECT(name) \| SET(name) \| DAY(name) \| TIME(name) \| PERIOD(name) \| CALSET(name)\|CALBASE(name) \| DEFBASE(name)\| SYSLAYER(name) \| PLEXLAYER(name) \| LAYERPLEX(name) \| SYSPOOL(syspoolName) \| TOMSYSTEM (tomid) REALTIME [STEM(LINE)] SYSPLEX(name) [TOMID tom ID) \| TOMPLEX(tomplex name)] The parameter XCFGROUP(XCF group name) is still supported for compatibility with previous versions, but BMC recommends that you use the TOMPLEX parameter.

Command

Parameters

TOMEXEC FUNCTION(DELETE)

REALTIME

[STEM(LINE)]

SYSPLEX(name)

[TOMID tom ID) | TOMPLEX(tomplex name)]

The parameter XCFGROUP(XCF group name) is still supported for compatibility with previous versions, but BMC recommends that you use the TOMPLEX parameter.

Important

When you specify the DEFBASE keyword in conjunction with the following keywords OBJECT, SET, SYSLAYER, PLEXLAYER, LAYERPLEX, or SYSPOOL, the DEFBASE value specifies which Definition Base contains the item to be deleted.

To delete an object Definition Base, specify the DEFBASE keyword without specifying the OBJECT, SET, SYSLAYER, PLEXLAYER, LAYERPLEX, or SYSPOOL keywords.

If you specify the CALBASE keyword in conjunction with the DAY, TIME, PERIOD, or CALSET keywords, the CALBASE value specifies which calendar base contains the item to be deleted.

To delete a calendar base, specify the CALBASE keyword without specifying the DAY, TIME, PERIOD, or CALSET keywords.

The following table describes the parameters:

Parameter	Function
OBJECT	Specify the object name to be deleted (mutually exclusive with the SET parameter). For information about specifying the object name, see Object-and-set-naming-restrictions.
SET	Specify the set name to be deleted (mutually exclusive with the OBJECT parameter). For information about specifying the set name, see Object-and-set-naming-restrictions.
DAY	Specify the calendar entry name for the day type to be deleted.
TIME	Specify the calendar entry name for the time type to be deleted.
PERIOD	Specify the calendar entry name for the period type to be deleted.
CALSET	Specify the calendar entry name for the set type to be deleted.
CALBASE	Specify the calendar Definition Base the item is to be deleted from, or the calendar base to be deleted. This value is associated with the sysplex keyword value. If it is not specified, the currently active calendar Definition Base is used.
DEFBASE	Specify the object Definition Base the item is to be deleted from, or the object Definition Base to be deleted. This value is associated with the sysplex keyword value. If it is not specified, the currently active object base is used.
SYSLAYER	Specify the system layer name to be deleted.
PLEXLAYER	Specify the sysplex layer name to be deleted.
LAYERPLEX	Specify the layer sysplex to be deleted. This parameter is also referred to as the sysplex matrix that is used to generate objects and sets for other sysplexes.
SYSPOOL	Specify the system pool name to be deleted.
REALTIME	Specify the REALTIME keyword so that after inheriting and resolving dependency and server variable names, TOM processing checks to see if the object to be deleted is a parent or server object to any other object; if so, the object cannot be deleted.
STEM	Specify the prefix of the REXX stem variables that might be returned from the DELETE function. The default REXX stem value is LINE.
SYSPLEX	Specify the sysplex associated with the Definition Base (object or calendar). If it is not specified, the sysplex of the system where the TOM PAS is running will be used.
TOMID	Specify the ID of the TOM PAS on which you want the command issued.
TOMPLEX	Specify the name of the TOMPLEX where you want to issue the function. See Specifying-the-TOMID-and-TOMPLEX-parameters1 for usage information.
TOMSYSTEM	Specify the TOM system to be deleted. Important Setting local variables line.tomplex and line.sysplex is required to use this parameter. This function does not delete a TOM system but it deletes any history and information about the specified TOM from the Registry. Tip Use DELETE TOMSYSTEM(tomID) only when you intend to delete any history that was maintained previously from an inactive TOM system that you are no longer using. This function does not work for a currently active TOM system.

This section contains the following topics:

DELETE function

On this page