Installing, Enabling, Disabling, Reinitializing and Dynamic Control

SMF Extensions › Features and Benefits › Installing, Enabling, Disabling, Reinitializing and Dynamic Control

Installing, Enabling, Disabling, Reinitializing and Dynamic Control

This section documents the installation, enabling, disabling, reinitializing, and dynamic control features of SMF/E. Please note that enable means to initialize startup or activate the product and conversely disable simply means to terminate, shutdown or deactivate the product. These words are used interchangeably in this text. Reinitialization means that a new copy of the SMF/E processing module is loaded into memory. Use this option to apply or back out maintenance. SMF/E uses the CA Common Services for z/OS Services Resource Initialization Manager (CAIRIM) to prepare your operating system environment. Executing CAIRIM does not enable SMF/E. The enabling of SMF/E is discussed later in this chapter.

The CAIRIM PARM required for the CA JARS product family is:

PRODUCT (CA JARS)   VERSION (JRC6)   INIT (JARSINIT)

To reduce required resources in an environment where the CA JARS Resource Management for CICS product is not installed, use this statement instead:

PRODUCT (CA JARS)   VERSION (JRC6)   INIT (JARSINIT)  PARM (,JARS)

When the PARM specified at the end of the statement is passed to the JARSINIT program JARS, installation actions specific to CA JARS Resource Management for CICS are not performed. This reduces the resources required for installation in an environment without CA JARS Resource Management for CICS. If necessary, a subsequent CAIRIM initialization for CA JARS Resource Management for CICS will install its components.

The following is a sample job that can be used to execute CAIRIM and prepare the system for the enabling of SMF/E:

//CAIRIM    EXEC PGM=CAIRIM
//PARMLIB DD *
  PRODUCT(CA JARS) VERSION(JRC6) INIT(JARSINIT) PARM(,JARS)
//*

The CAIRIM routine is intended to be invoked as a stand-alone started task that can be optionally defined as a z/OS subsystem. See your CA Common Services for z/OS documentation for more information. The CAIRIM routine can also be used to reinitialize the global environment in order to apply maintenance. Once maintenance has been applied, run the following sample job to dynamically reinitialize the global environment:

//CAIRIM    EXEC    PGM=CAIRIM
//PARMLIB DD *
  PRODUCT(CA JARS) VERSION(JRC6) INIT(JARSINIT) PARM(REINIT,JARS)
//*

Specifying JARS as the second parameter (PARM(,JARS) and PARM(REINIT,JARS) in the sample code above) tells JARSINIT to only install the components required by the CA JARS Resource Accounting product. This reduces common storage use.

SMF/E is enabled and disabled by running a batch job, examples of which follow this discussion. The SMF/E control program accepts startup and shutdown specifications through the program PARM field. The PARM options are:

PARM=('LOAD(customization-table-name)',
      'ENABLE(exit-name)',
      'DISABLE(exit-name)',
      'REINIT(exit-name)',
      'OUT(default-output-format)',
      'ACCT(0|n)',
      'GNRC(YES|NO)',
      'TSO(YES|NO|userid)',
      'HCPY(NO|YES)',

where:

LOAD(customization-table-name) - required parameter, no default
Indicates the load module name of the customization table to be loaded at system activation. If this is specified while SMF/E is active, the table is reloaded and the new table is used.

ENABLE(exit-name) or DISABLE(exit-name) - required parameter, no default
Currently, the exit name must be JARSTATS since this is the only routine implemented. When ENABLE (JARSTATS) is specified and this startup run is completed, the next address space going through step-termination receives SMF/E output in accordance with these startup options. The ENABLE process is a very quick operation that can facilitate the experimentation and benchmarking of various customization tables.

When DISABLE is specified and the run is complete, the next address space going through step termination does not receive SMF/E output. When REINIT is specified, a new copy of the SMF/E processing module is loaded in the system. As in the previous cases, the new maintenance is executed after the run ends by the next address space going through step termination. Use the REINIT option only to apply or back out maintenance to the SMF/E processing module.

Note: This option should only be used for maintenance changes. Feature and rate table changes should be made with the ENABLE option.

OUT(output-format)
Indicates the report types that are produced in output listings. There are six different formats. The formats are listed below from most to least detailed. Each specification coded implies the inclusion of all report levels for which less detail is available.

For instance, requesting a STEP report implies that you will receive the JOB and SYSMSG reports.

STEPP - Step Detail and Job Summary Reports (compressed format - default)
STEP - Step Detail and Job Summary Reports (expanded format)
JOBP - Job Summary Report (compressed format)
JOB - Job Summary Report (expanded format)
NONE - JOB LOG Summary Report only
IVP - used during installation verification or testing to limit output to only those jobs that request output via a valid job card ACCT code. Specifying IVP in the "nth" ACCT code position produces output like STEPP, but it includes RATE and FACTORS.

ACCT(0|n)
Indicates the positional JOB card accounting field to be used for overriding the default output format. Individual users can override the system startup OUT parameter in this JOB card accounting field. The default is 0.

GNRC(YES|NO)
This option determines how generic or specific the classification of device types is in the output formats. GNRC(YES) indicates that the data collection routine for SMF/E determines the device type from the UCB attributes in the type 30 record before using the supplied CONFIG specification in the customization table. GNRC(NO) indicates that only the CONFIG table is used to classify device types.

TSO(YES|NO|userid)
TSO(YES) activates TSO session accounting for all TSO users. TSO(NO) deactivates the feature. TSO(userid) can be used to test TSO session accounting during the installation verification process. The indicated TSO user is the only one to receive the TSO Session Utilization Summary.

HCPY(YES|NO)
HCPY(NO), the default, prevents all WTO messages issued by SMF/E from being written to the System Log (SYSLOG). HCPY(YES) allows all Write-To-Operator (WTO) messages, issued from SMF/E to be written to the SYSLOG. Exceptions: for those jobs (notably started tasks) that have no RPL for the Job Log data set, SMF/E messages appear in the SYSLOG prefixed by message number IEF170I.

Note that the WTO messages are issued by SMF/E with ROUTCDE=11, which may show up on various system consoles. The value for HCPY controls SYSLOG only and other means are available to suppress or allow output to the consoles.

The following is a sample procedure you can use to activate SMF/E:

//SMFE  PROC RT=JSYJ2000,          SMF/E RATE TABLE
//          X=JARSTATS,            EXIT TO ENABLE (JARSTATS)
//          O=STEPP,               OUTPUT FORMAT REQUESTED
//          G=YES,                 GENERIC DEVICE ACCOUNTING
//          A=4,                   JOBCARD ACCT'G DATA PARM POSITION
//          T=YES
//SMFE  EXEC PGM=JSYJ1000,
// PARM=('LOAD(&RT.)','ENABLE(&X.)','GNRC(&G.)','OUT(&O.)',
//  'ACCT(&A.)', 'TSO(&T.)')
//SYSMDUMP DD  DISP=SHR,DSN=your.dsname
//CAIJRPR  DD  SYSOUT=*
//   PEND

Once you have completed customization of SMF/E, this procedure should be executed during your system IPL. SMF/E can be reactivated at any time to change any of the startup parameters.

SMF/E provides a facility that allows informed, individual users to choose the report types desired in each job execution by supplying the desired output format in the ACCT field defined by the systems programmer at SMF/E startup. Assuming SMF/E was enabled with ACCT(4) and OUT(STEP), the following JOB card eliminates step reporting and produce job and JOB LOG reports.

//GENER   JOB  (123,521,BIN4,JOB),CLASS=A,MSGCLASS=Z

The user may supply any of the keywords that are valid for the OUT parameter in the 4th positional ACCT field for this single JOB execution.

The following matrix shows the type of output that can be produced using the various combinations of OUT(options), used to activate SMF/E, and the Job Card Account Field.


Job Account(n) Field		OUT(option) Chosen at Startup
Coded Value	IVP		STEP or STEPP	JOB or JOBP	NONE
IVP	L,R		L,R	L,R	L,R
STEP or STEPP	L,S		L,S	L,S	L,S
JOB or JOBP	L,J		L,J	L,J	L,J
NONE
No match	L,S		L,J

L = JOB LOG Summary Report
J = JOB Detail (SYSMSG)
S = Step and Job Detail
R = Step and Job With Rates Displayed
blank = nothing

The following is a sample procedure that can be used to disable SMF/E:

//SMFDEACT PROC X=JARSTATS         SMF/E EXIT ROUTINE TO DISABLE
//SMFE     EXEC PGM=JSYJ1000,
// PARM=('DISABLE(&X.)')
//CAIJRPR  DD  SYSOUT=*
//   PEND

As another example, consider the following scenario which shows how IVP can be used by a limited group (for example, systems programmers) to gain familiarity with the product outputs and use of various rates:

S SMFE,O=IVP,A=3
1. The SMFE proc defined on the prior page is invoked here. SMF/E is being initialized in IVP mode.
2. The 3rd positional parameter is examined for a character string which determines what type of output (if any) is produced.
Given that SMFE has been started in IVP mode as in item 1 above:
1. User address spaces receive output from SMFE only if they code a recognizable character as the 3rd positional parameter in the JOB card.
2. For example: //TEST1 JOB (76251,,IVP),MYNAME,CLASS=A produces the JOB log summary report and step/job detail reporting with Rate information.
3. Another example: //TEST2 JOB (76251,,STEPP),MYNAME,CLASS=A produces the JOB log and abbreviated STEP data. STEPP is suggested for production.