Automation SHARED variables for TOM
TOM-specific SHARED variables created when TOM starts up
SHARED variable | Resolves to |
|---|---|
QTOMJOBN | TOM PAS jobname |
QTOMID | The TOM ID of the TOM PAS |
QTOMREL | The TOM release and version number which is a 7-character field in format v.r.mm |
QTOM.ACTIVEFLAG | The connection status: either YES or NO |
QTOMJOBID | The TOM PAS job identifier |
QTOMCASCT | The CAS connection status: either YES or NO |
| QTOM.SHUTSYS | INPROGRESS if SHUTSYS is in progress COMPLETED if SHUTSYS has successfully completed FAILED if SHUTSYS has failed Blank if SHUTSYS has not been performed |
| TOMIPLL.OPTION | ENABLED or DISABLED indicating the status of the IPL level option |
| TOMIPLL.IPLORDER | List of IPL level names as defined in MAMINIxx IPLORDER= parameter, blank separated. If IPLORDER= is not specified the value will be blanks |
| TOMIPLL.CURRENT | Current active IPL level. If IPL levels are disabled the value will be DISABLED |
| TOMIPLL.STATUS.level | There is one variable created for each defined IPL level including the <null> level which will show a ‘level’ of #NULL#. The value is the status of the level. If IPL levels are disabled the value will be DISABLED. Otherwise, the value will be one of the following:
|
Object-specific automation variables
TOM can generate BMC AMI Ops Automation variables in the SHARED variable pool that describe the status and attributes for objects in the active Definition Base. These are referred to as object-specific automation variables.
The object-specific automation variables are created when TOM is initialized and deleted when TOM is terminated. These automation variables are not deleted if you specify VARIABLES_KEEP=YES in BBPARM member MAMINIxx.
The value of these object-specific automation variables are updated to match the state of the objects throughout TOM processing. You can use these automation variables (see Object-specific automation variables) in Rules and EXECs without first performing a TOMEXEC FUNC(GET) API call.
Object-specific automation variables that indicate status and attributes of objects are only created for objects when:
- The object is defined with a short name
- The associated parameter is set to YES in BBPARM member MAMINIxx
The creation of these automation variables is optional. Review the comments in BBPARM member MAMINI00 for an explanation of each parameter. If the parameter is not specified or commented out, the object-specific automation variables associated with the parameter are not generated for any object in the active Definition Base.
When TOM creates or updates an object-specific automation variable, it is completed asynchronously, so any automation based upon the variable cannot take immediate effect. If you need immediate automation, use a TOM message with the event type JRNL Rule.
The following table lists the SHARED variable that indicates the state of object-specific automation variables listed in the table Object-specific automation variables below.
SHARED variable | Resolves to |
|---|---|
QTOMAV | The current refresh state of TOM object-specific automation variables. The value of QTOMAV can be:
The value INPROGRESS yyyymmdd hhmmss indicates the date and time when the refresh process began. The value COMPLETED yyyymmdd hhmmss number-of-seconds-to-refresh-vars indicates the date and time when the refresh process completed and the number of seconds of elapsed time that it took to complete the process. |
The following table lists automation variables created when you specify YES for these optional parameters in BBPARM member MAMINIxx. For example, VARIABLES_STATE=YES or VARIABLES_STATE(YES).
Object-specific automation variables
BBPARM member MAMINIxx parameter for object-specific automation variables | Associated variables |
|---|---|
VARIABLES_STATE=YES | Active and required status for the object similar to what is displayed on the TOBJO view The following list shows the variables associated with VARIABLES_STATE:
|
VARIABLES_GENERAL=YES | Attributes entered on the General Object Information dialog used to define or modify the object definition The following list shows the variables associated with VARIABLES_GENERAL:
|
VARIABLES_PRODUCT=YES | Attributes entered on the STM-specific dialog panel The following list shows the variables associated with VARIABLES_PRODUCT:
|
VARIABLES_PRODUCT=YES | Attributes entered on the UPM-specific dialog panel The following list shows the variables associated with VARIABLES_PRODUCT:
|
VARIABLES_PRODUCT=YES
| Attributes entered on the WRM-specific dialog panel The following list shows the variables associated with VARIABLES_PRODUCT:
|
VARIABLES_PRODUCT=YES | Attributes specific for GSM Extension objects
|
VARIABLES_START=YES | Attributes entered on the Start Command Information dialog The following list shows the variables associated with VARIABLES_START:
|
VARIABLES_PRESTART=YES | Attributes entered to identify the object’s pre-start commands The following list shows the variables associated with VARIABLES_PRESTART:
|
VARIABLES_STARETRY=YES | attributes entered to identify the object's START RETRY commands The following list shows the variables associated with VARIABLES_STARETRY:
|
VARIABLES_POSTSTRT=YES | Attributes entered to identify the object's post-start commands The following list shows the variables associated with VARIABLES_POSTSTART:
|
VARIABLES_STOP=YES | Attributes entered on the Stop Command Information dialog The following list shows the variables associated with VARIABLES_STOP:
|
VARIABLES_PRESTOP=YES | Attributes entered to identify the object's pre-stop commands The following list shows the variables associated with VARIABLES_PRESTOP:
|
VARIABLES_STPRETRY=YES | Attributes entered to identify the object's STOP RETRY commands The following list shows the variables associated with VARIABLES_STPRETRY:
|
VARIABLES_POSTSTOP=YES | Attributes entered to identify the object's post-stop commands The following list shows the variables associated with VARIABLES_POSTSTOP:
|
VARIABLES_DEPCLNT=YES | Attributes entered on the Dependency, Client-Server Information dialog The following list shows the variables associated with VARIABLES_DEPCLNT:
|
VARIABLES_START |
|