ADD function

The ADD function corresponds to the ADD line command, which can be issued for objects from any view which displays a list of objects (such as the TOBJ, TOBJOR, TST, TUPS, and so on).

Use the ADD function to add an object, set, system layer, sysplex layer, layer system pool, or a layer sysplex to an object Definition Base. You can also add a new Definition Base.

Related topic

Using-the-TOM-programming-interface

You can also add a date, time, period of time, or calendar set to a calendar Definition Base. The ADD function allows you to create automation processes to add one, or more items as a batch, to the Registry from an EXEC.

The ADD function corresponds to the ADD object line command which allows you to add objects from selected views in the user interface. This function is very useful because sometimes adding objects in a batch takes less time than updating many items in the definitions base from the user interface. You can also review your changes in a single place before scheduling the EXEC.

When adding an object through a REXX EXEC, you must specify stem variables to represent the object’s attributes before specifying the TOMEXEC ADD statement in the EXEC. LINE is the default prefix for the stem variables if the STEM keyword is not specified on the TOMEXEC request.

You must specify the stem variable LINE.PRODUCT to identify the managed object type to STM (for started tasks), UPM (for USS processes), GSM (for generic/stateless items/interfaces), or WRM (for Work Load Manager resources) before the TOMEXEC FUNC(ADD) statement in the EXEC.

The following table shows the command and parameters:

Command

Parameters

TOMEXEC FUNCTION(ADD)

OBJECT(name) | SET(name) | DAY(name) | TIME(name) | PERIOD(name) | CALSET(name) | CALBASE(name) | DEFBASE(name)| SYSLAYER(name) | PLEXLAYER(name) |LAYERPLEX(name)|SYSPOOL(syspoolName)

[STEM(LINE)]

SYSPLEX(name)

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

Note: The XCFGROUP(XCF group name) parameter is supported for compatibility with earlier versions of TOM, but BMC recommends that you use the TOMPLEX parameter.

Important

When you specify the DEFBASE keyword with the keywords OBJECT, SET, SYSLAYER, PLEXLAYER, LAYERPLEX, or SYSPOOL, the DEFBASE value determines which Definition Base to add the object, set, (and so on) to.

To add a new Definition Base, specify the DEFBASE keyword without specifying the OBJECT, SET, SYSLAYER, PLEXLAYER, LAYERPLEX. or SYSPOOL keywords.

If you specify the CALBASE keyword with the DAY, TIME, PERIOD, or CALSET keywords, the CALBASE value determines which calendar base to add the DAY, TIME, and so on to.

To add a new 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 added (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 added (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 added.

TIME

Specify the calendar entry name for the time type to be added.

PERIOD

Specify the calendar entry name for the period type to be added.

CALSET

Specify the calendar entry name for the set type to be added.

CALBASE

Specify the calendar Definition Base where the added item should be stored in the Registry or the name of the calendar base to be added.

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 where the added item should be stored in the Registry or the name of the Definition Base to be added.

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 added.

PLEXLAYER

Specify the sysplex layer name to be added.

You must include the stem variables LINE.SYSLAYERS.0 and LINE.SYSLAYERS.n.NAME to add System Layers to the Sysplex Layer at the time of ADD. You can also add System Layers to the Sysplex Layer with the CHANGE function.

LAYERPLEX

Specify the layer sysplex to be added.

This parameter is also referred to as the sysplex matrix in the layer that is used to generate objects and sets for other sysplexes.

To add systems to the Layer Sysplex during the ADD function, you must specify the following stem variables

  • LINE.SYSTEMS.0
  • LINE.SYSTEMS.n.NAME
  • LINE.SYSTEMS.n.DESCR
  • LINE.SYSTEMS.n.CLONEID
  • LINE.SYSTEMS.n.LAYERID

You can also add system to the Sysplex Layer with the CHANGE function.

SYSPOOL

Specify the system pool name to be added. 


STEM

Specify the prefix of the REXX stem variables that contain the properties of the item to be added.

The default REXX stem value is LINE.

You must set stem variables for the object attributes before issuing the TOMEXEC ADD function.

When adding an OBJECT, you must specify the variable LINE.PRODUCT as either STM, UPM, WRM, or GSM.

SYSPLEX

Specify the sysplex associated with the Definition Base (object or calendar) where the added item should be stored in the Registry.

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-parameters for usage information.

Important

To specify attributes for the item you are adding, see the FUNC(ADD) REXX variables and sample values in Object-REXX-stem-variables-for-ADD-CHANGE-and-GET.

This section contains the following topics:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*