Verify installation with Installation Verification Procedure (IVP)

You can use the Installation Verification Procedure (IVP) to verify if TOM is properly installed and activated. The IVP feature comprises nine EXECs and a sample JCL. The EXECs use the TOM programming interface (TOMEXEC API) to perform product verification. The EXECs and JCL must be made available to the SYSPROC DD concatenation of the BMC AMI Ops Automation PAS JCL before you invoke the IVP procedure.

The IVP can be invoked by scheduling EXEC MAMIVP from BMC AMI Ops Automation. The results of the IVP procedure are displayed in the Journal, WTO messages, or both.

Note

The IVP EXECs utilize BMC AMI Ops Automation SHARED pool variables to assist in testing and verification of various features. The variables used for testing are prefixed with TOM_IVP and are deleted at the start and the completion of the IVP process. If you are using SHARED pool variables prefixed with TOM_IVP in your automation, they might be modified and deleted by the IVP procedure.

To enable the IVP

Make the TOM BBPROC data set available to the SYSPROC DD of your BMC AMI Ops Automation JCL, or copy the following EXECs to your UBBPROC data set. If you need to modify the defaults in the MAMIVP EXEC, you must first copy it to your UBBPROC data set.
- MAMIVP
- MAMIVIMP
- MAMIVPRM
- MAMIVPST
- MAMIVSTR
- MAMIVSST
- MAMIVPSP
- MAMIVSPR
- MAMIVSSP
From the BMC AMI Ops Automation BBSAMP data set, copy the TOMCSMOB sample JCL to your PROCLIB data set. Update the STEPLIB DD of the JCL to specify the BMC AMI Ops AutomationLoad library, which contains the AATWAIT load module. You may optionally make other changes as documented in the JCL. You need to note the name of the PROCLIB member. For more information about the JCL and the available parameters, see Using the AATWAIT program for testing Continuous State Manager or the Total Object Manager.
Update the MAMIVP EXEC to specify the PROCLIB member from the previous step or pass it as input parameter OBJPROC (member-name) when scheduling the EXEC.
(Optional) Modify the other default parameters in the MAMIVP EXEC.

The MAMIVP EXEC can now be scheduled from BMC AMI Ops Automation.

Running EXEC MAMIVP

The IVP procedure is initiated with the MAMIVP driver EXEC. MAMIVP accepts the following input parameters:

OBJPROC– specifies the PROCLIB member that contains the TOMCSMOB JCL
MSGDEST– specifies the destination of the result messages to be Journal, WTO or ALL
ALERT– optionally specifies an Alert queue for generating Alerts for failed tests
VERBOSE– specifies the level of progress reported by the verification procedure
KEEPBASE – specifies whether to keep or delete the test Definition Bases created by the IVP.
HELP– displays information about the IVP EXEC

Running the MAMIVP EXEC results in Journal or WTO messages (or both) indicating the result of each test. The results display the status of PASS, WARN, or FAIL.

Any failed IMFEXEC or TOMEXEC functions are displayed with a return code. For more information about return codes of IMFEXEC functions, see Using the IMFEXEC Statements and for the return codes of TOMEXEC functions, see Using the TOM Programming Interface.

The following string is an example of the keyword parameters that can be passed to MAMIVP.

%MAMIVP OBJPROC(MYPROC) MSGDEST(ALL) ALERT(MAMIVP) VERBOSE(Y) HELP

MAMIVP input parameters

Parameter	Required/Optional	Description
OBJPROC	Optional	Specifies the name of the PROCLIB member which contains the AATWAIT program JCL. The proc will be used for generating test TOM objects. The default value is TOMCSMOB.
MSGDEST	Optional	Specifies the destination of the messages that will be issued from the IVP EXECs. The following values are valid: JRNL causes the output messages to be issued as Journal messages WTO causes the output messages to be issued as WTOs ALL causes the output messages to be issued in all supported formats (currently only two) The default for this parameter is: JRNL
ALERT	Optional	Specifies an ALERT queue name and causes ALERTs to be generated for all WARN and FAIL test results on that queue. There is no default for this parameter. If not specified, there will be no ALERTs. The following values are valid: Queue_name – 1 to 8 alphabetical characters Alert queue name. The queue does not have to pre-exist. Example ALERT(MAIN) Note The IVP procedure will not delete these Alerts upon completion. There is no default for this parameter. If not specified, there will be no ALERTs.
VERBOSE	Optional	Specifies the level of progress messages written. Valid values are Y or N. A value of Y displays all progress messages. The default value of N displays only messages indicating errors, program-waits, and the verification report summary.
KEEPBASE	Optional	Specifies whether to keep or delete the test Definition Bases created by the IVP. KEEPBASE(Y) or default.KeepBase=Y can be useful for customers to experiment with various TOM commands, as well as edit dialogs and other features of TOM.
HELP	Optional	Specifies that information about this EXEC is written to the BBI-SS PAS Journal Log.

The default values for the configuration parameters can also be specified by updating the following section of the beginning of the MAMIVP EXEC:

/*-------------------------------------------------------------------*/
/* The
following defaults may be modified here, or overridden by     */
/*
using the input parameters when scheduling this EXEC.             */
/*-------------------------------------------------------------------*/
default.ObjProc='TOMCSMOB'
default.MsgDest='JRNL'
default.Alert=''
default.Verbose=’N’
default.KeepBase=’N’

You can also modify the following default values in the MAMIVP EXEC. These defaults are used when generating objects and sets:

default.ObjBase=’MAMIVPOB’     /* Definition base name to be created */
default.CalBase=’MAMIVPCB’       /* Calendar base name to be created */
default.ObjPrefix=’MAMIVO’   /* Prefix of object names to be created */
default.SetPrefix=’MAMIVS’      /* Prefix of set names to be created */
default.STCPrefix=’MAMIVP’/* Prefix of object STC name to be created */
default.LayerPlex=’MAMIVPLX’        /* Sysplex name to test layering */
default.LayerSys1=’SYS1’                /* System 1 to test layering */
default.LayerSys2=’SYS2’                /* System 2 to test layering */
/* The value specified with VARIABLE_PREFIX in MAMINIxx. If provided,*/
/* Automation Variables will be displayed.                           */
default.VarPrefix=’TOM’

Using EXECs MAMIVPST, MAMIVSTR, MAMIVSST, MAMIVPSP, MAMIVSPR, and MAMIVSSP

These EXECs are REXX EXECs that are used to define Pre-start, Start-retry, Post-start, Pre-stop, Stop-retry and Post-stop attributes of the test objects. The EXECs issue a message, set a variable and exit with return code = 0.

Results of the IVP

The results from the IVP procedure are displayed in the Journal or the Syslog (or both) depending on the value of the MSGDEST parameter when the EXEC MAMIVP was scheduled.

For each performed test, a message is issued indicating the result status. The status value can be PASS, WARN or FAIL.

PASS: Indicates that the specific test is completed successfully.

WARN: Indicates that the specific test is failed, but it does not indicate a critical problem. This result may indicate that an optional feature is not activated or that a wait timed out.
You must review the feature being tested and determine if you need to activate it.

FAIL: Indicates that the specific test is failed and this is a critical problem. It requires you to take some action so that the test can pass.