EXECs and object start and stop commands

When defining an object, you can associate an EXEC to be scheduled for any of the following situations:

  • Before TOM starts an object
  • After TOM starts an object
  • Before TOM stops an object
  • After TOM stops an object
  • When TOM starts an object
  • When TOM stops an object
  • When an abnormal termination event occurs
  • When using the Active Check Program for object detection
  • When TOM connects an object to its server
  • When TOM disconnects an object from its server

You can associate an EXEC to be scheduled for any of these events, which allows you to create automation to occur based on TOM object processing.

Note

When you specify EXEC as part of an object’s definition, and you change the status of the object, you must also specify whether the associated EXECs are also scheduled.

Special considerations for EXECs

When using an EXEC with an object stop or start command, follow these guidelines:

  • If you specify an EXEC that does not exist, the command fails and TOM sets the object status on that system to a FAILURE-* status.
  • To use mixed-case characters for any EXEC parameter values, specify UCPARMS=NO in BBPARM member AAOEXPxx in the MainView AutoOPERATOR PAS that is associated with TOM.
  • To specify that the EXEC produces return codes, you must include the IMFEXEC EXIT CODE() statement at the end of the EXEC.

MainView AutoOPERATOR variables created for EXECs

The following shared variables are created when scheduling an EXEC with a start or stop command and these variables are available to the EXEC:

Shared variable

Description

TOM_EXECTYPE

Can be one of the following values: PRESTRT, PRESTOP, START, STOP, POSTSTRT, POSTSTOP, RECOVERY, ACTCHECK, CONNECT, DISCONNECT, or UNKNOWN

TOM_ID

ID of the TOM scheduling the EXEC for execution

TOM_OBJECT

Object name for which the EXEC has been scheduled

TOM_TOBJTYPE

Type of object (currently STM, UPM, or WRM)

TOM_REQUEST

Can be one of the following values: Bounce, Disconnect, Connect, Initialize (start command), Termination, POSTSTRT, POSTSTOP, Initiation (prestart command), Recovery ACTIVECHECK

TOM_SYSNAME

Name of the MVS system on which TOM is running

TOM_XCFGROUP

TOMPLEX name, this is the XCF group that registry communication uses and is only created for compatibility with version

TOM_TOMPLEX

Name of the local TOMPLEX

 

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