ACTBASE function


The ACTBASE function corresponds to the ACTivate line command for Definition Bases from the TDEFBS view.

Use the ACTBASE function to activate an object or calendar Definition Base.

You can specify either an object Definition Base or a calendar Definition Base. An object Definition Base is a collection of information about objects and sets and their attributes. A calendar Definition Base is a collection of periods of time during which objects should be ACTIVE or STOPPED.

When you activate a Definition Base, TOM begins to use the Definition Base you specified, and manages the objects based on their definitions in the activated Definition Base.

Every member of the TOMPLEX must run using the same base. When a new Definition Base is activated, all of the TOMs within the TOMPLEX begin to use the new Definition Base.

When an object Definition Base is activated, TOM monitors and manages objects based upon the objects and their definitions in the new Definition Base. Therefore, you might have objects defined in the original Definition Base that have different definitions or, are not even defined, in the newly activated Definition Base.

For example, in the original Definition Base named DEFBASE1, TOM is managing an object named CICSTEST. The following list describes what can happen to CICSTEST when you activate a new Definition Base named DEFBASE2:

  • If CICSTEST is defined in DEFBASE2, TOM continues to manage the object according to the definition in DEFBASE2.
  • If CICSTEST was not started in DEFBASE1 but its status is not LOCKED or BLOCKED in DEFBASE2, TOM issues the start command that is defined for the CICSTEST object and manages the object according to its definition in DEFBASE2.

In addition, the following conditions also apply when a new Definition Base is activated:

  • TOM does not reset the status of the objects in the Definition Base.
    For example, if an object has a status of LOCKED in DEFBASE2, TOM stops the object if it is ACTIVE.
  • TOM can also start transient objects when a Definition Base is activated if the object does not have a status of COMPLETE in the new Definition Base.
    This can occur even if the object was already active in another Definition Base during the life of the IPL.
  • TOM does not stop objects in the base being deactivated if they are not defined in the base being activated.

    For example, in DEFBASE1, CICSTEST has a status of ACTIVE. When you activate DEFBASE2, if CICSTEST is not defined in DEFBASE2, TOM does not issue the stop commands for CICSTEST before DEFBASE2 is activated and CICSTEST continues to be active, but outside of TOM’s control.

The following table shows the command and parameters:

Command

Parameters

TOMEXEC FUNCTION(ACTBASE)

BASE(name)

TYPE(DEF| CAL)

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

The following table describes the parameters:

Parameter

Function

BASE

Specify the base name to be activated.

Enclose the name within single quotation marks (’).

TYPE

Specify the type of base to be activated as either DEF for object and set definitions or CAL for calendar entries.

TOMID

Specify the ID of the TOM PAS on which you want the command issued.

TOMPLEX

Specify the name of the TOMPLEX for which the request should be issued.

See Specifying-the-TOMID-and-TOMPLEX-parameters for usage information.

You must specify the TOMID and TOMPLEX parameters only when there are multiple TOMs running on the system where the ACTBASE function is issued.

The TOMEXEC FUNC(ACTBASE) TYPE(DEF) API request allows the RESETOPT() parameter to be specified with the following values:

RESETOPT ( [IPL|LOCKED|RUNSTAT]  [TRANS]  [SUSPEND] )

  • IPL set/resets all object statuses and states as if an IPL is being performed.
  • LOCKED sets all LOCKED VSL entries to STOPPED for each object.
  • RUNSTAT sets the status to STOPPED on all VSL entries for each object, unless LOCKED or BLOCKED.
  • TRANS sets the status to COMPLETE on all VSL entries for each transient object.
  • SUSPEND un-SUSPENDs control mode for all objects.

Important

IPL, LOCKED, and RUNSTAT are mutually exclusive. If IPL is specified, the only other value allowed is SUSPEND

This section contains the following topics:

 

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