Newer version of documentation BMC provides a newer version of the documentation for this version of the product. As a result, BMC no longer accepts comments in this space.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see bao8301.

CHANGE function


The CHANGE function corresponds to the Edit line command which can be issued on most views of the TOM UI.

The CHANGE function allows you to create automation processes to change the attributes for the following items in the registry with an EXEC:

  • An object, set, system layer, sysplex layer, layer system pool, or a layer sysplex in the object definition base
  • A date, time, time period, or calendar set in a calendar definition base

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

Using an EXEC to add, change, or delete objects or sets from the definition base can also provide an audit trail for change management purposes.

The following table shows the command and parameters:

Command

Parameters

TOMEXEC FUNCTION(CHANGE)

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)]

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

Note

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

To change the attributes of a 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 calendar entry to be changed.

To change the attributes of 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 changed (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 changed (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 changed.

TIME

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

PERIOD

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

CALSET

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

CALBASE

Specify the calendar definition base where the changed item should be stored in the registry or the name of the calendar base that contains the calendar entry to be changed.

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 definition base that contains the item to be changed or the name of the definition base to be changed.

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

PLEXLAYER

Specify the sysplex layer name to be changed.

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

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.

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


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.

STEM

Specify the prefix of the REXX stem variables that contain the properties of the item to be changed. The default REXX stem value is LINE.

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

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.

Note

In the EXEC, you must first specify stem variables for the attributes that you want to change before issuing FUNC(CHANGE).

To specify attributes for the item you are adding, see the FUNC(CHANGE) REXX variables and sample values in REXX-stem-variables-and-sample-values-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*