Previous Topic: Predefining CCIDsNext Topic: Performance Improving Options


Using SMF Recording

This section contains the following topics:

SMF Recording

Record Formats

DSECT Descriptions

SMF Recording

If the SMF interface is implemented at your site, CA Endevor SCM can write out SMF records during operation as follows:

CA Endevor SCM writes out SMF records if requested during installation, through the Defaults Table. It writes Security Records if the Defaults Table specifies SMFSEC=Y, and it writes Action Records if the Defaults Table specifies SMFACT=Y. A third Defaults Table option, SMFENV, is not supported with this release of the software. SMF records are specific to an environment. For example, you might request SMF records for one environment but not another.

Note: You can use the CSV utility to extract SMF record data corresponding to activity related to CA Endevor SCM actions or to security violations recorded by CA Endevor SCM. For more information see the chapter Using the Comma Separated Value (CSV) Utility in the Utilities Guide.

Record Formats

CA Endevor SCM uses several blocks to build the SMF Security and Action Records, each comprising one or more DSECTs. All DSECTs are supplied in iprfx.iqual.CSIQOPTN.

Each SMF record output by CA Endevor SCM starts with a standard SMF header block (DSECT $SMFHDDS), which contains fields required by SMF, as well as the environment and user names for the element being processed. CA Endevor SCM records can be identified by the record type field in the header block (SMHRECTY), which is defined in the Defaults Table for each site (230 by default). This field is the same for each CA Endevor SCM SMF record, and identifies the records as being specific to CA Endevor SCM.

Following the header block, each record has a data block that is specific to the record type:

For Action Records, the $SMFREC2 block encompasses one or more action-specific blocks.

Note: For more information about each DSECT used to format SMF records, see DSECT Descriptions.

SMF Security Records

SMF Security Records include data specific to the security violation being reported. The data block for Security Records is written out using DSECT $SMFREC1. The combined format for SMF Security Records, then, is described using the following DSECTs:

SMF Action Records

SMF Action Records include data specific to the action being reported, and apply for all actions except PRINT, DISPLAY, COPY, and LIST. Each Action Record has one occurrence of the $SMFREC2 DSECT, and one or more action-specific blocks from the $SMFBKDS DSECT, as appropriate to the action. Each action-specific block has an action-block header (DSECT $SM2BHDDS), and either the type 1, 2, 3, or 4 action-block detail information (respectively, DSECT SM2ENVDS, SM2LCGDS, SM2LPRDS, or SM2REQDS.

Note: For more information about each action block, identified separately, see $SMFBKDS DSECT: Action-Specific Blocks.

The combined format for SMF Action Records, then, is described using the following DSECTs:

There are four different types of action-block detail information, each having a different format, or DSECT (within the $SMFBKDS DSECT). Each format applies to specific actions, described briefly as follows. Where two occurrences of a DSECT are used by an action, "(2)" follows the action name, below.

Action Block Detail Type #

DSECT Type

Actions

Description

1

Environment (SM2ENVDS)

Add (2)

Update (2)

Retrieve (2)

Generate

Move (2)

Delete

Transfer (2)

Archive (2)

Restore (2)

Information describing the environment where the action took place: name of the environment, site ID, etc. Where two blocks are used, one represents the source environment for the element, while the other represents the target environment.

2

Last Change (SM2LCGDS)

Add

Update

Generate

Move

Delete

Transfer

Restore

Information about the last processor executed: processor name, date and time of execution, etc. Used for actions that can invoke a processor.

3

Processor Info (SM2LPRDS)

Add

Update

Generate

Move

Delete

Transfer

Restore

Information about the last processor executed: processor name, date and time of execution, etc. Used for actions that can invoke a processor.

4

Request Parameter Info (SM2REQDS)

All actions

General information about the action: CCID, comments, and so forth.

DSECT Descriptions

This section describes each of the DSECTs used to write out SMF Action and Security Records. In cases where specific fields are not applicable for the current processing, alphabetic fields are space-filled and numeric fields are zero-filled.

$SMFHDDS DSECT: SMF Header Block

The header block is written at the beginning of each SMF record. CA Endevor SCM Security and Action Records can be identified by the record type field in the header, SMHRECTY, which has the same value in every CA Endevor SCM SMF record. This value is defined in the Defaults Table (defaults to 230).

     $SMFHDDS
$SMFHDDS DSECT
$SMFHDDS DS  0D         ALIGN IT
*********************************************************************
*                                                                   *
* $SMFHDDS - HEADER FOR THE SMF RECORDS FOR CA Endevor SCM-C1 *
*                                                                   *
*********************************************************************
SMHLEN   DS  H         		LENGTH OF THE OVERALL RECORD
SMHSEGID DS  H         		** RESERVED **
SMHSID   DS  XL1        		SYSTEM TYPE ID
SMH$VS2  EQU  X'02'         	    VS2 INDICATOR
SMH$VS1  EQU  X'01'         	    VS1 INDICATOR
SMHRECTY DS  XL1        		SMF RECORD TYPE ( DEFAULT 230)
SMH$230  EQU  230          	    SMF RECORD TYPE DEFAULT
SMHTIME  DS  XL4        		TIME IN HUNDREDTHS OF A SECOND
SMHDATE  DS  XL4        		DATE
SMHCPUID DS  CL4        		CPU FROM SYSTEM WRITING RECORD
SMHHDLEN DS  H         		LENGTH OF THIS HEADER
SMHC1VER DS  X         		ENDEVOR-C1 RECORD FORMAT VERSION
SMH$RF00 EQU  X'00'         	    RELEASE 2.2 AND PRIOR RELEASES
SMH$RF01 EQU  X'01'         	    RELEASE 2.5 THRU CURRENT
SMHCTLTY DS  X         		ENDEVOR-C1 RECORD SUBTYPE
SMH$SEC  EQU  X'01'         	    SECURITY RECORD TYPE
SMH$ACT  EQU  X'02'         	    ACTION RECORD TYPE
SMH$ESI  EQU  X'03'         	    ESI EXCEPTION WARNING RECORD
SMH$ENV  EQU  X'04'         	    ENVIRONMENT MCF CHANGES
SMH$MAX  EQU  SMH$ENV        	    ** MAX RECORD NUM DEFINED **
SMHCONT  DS  H         		CONTINUATION FLAG FOR RECORD
SMHSEQ   DS  H          		SEQUENCE NUMBER OF RECORD
SMHC1ENV DS  CL8       		ENDEVOR-C1 ENVIRONMENT NAME
SMHUSER  DS  CL8       		USER ISSUING REQUEST
     DS  0D
SMHSIZE  EQU  *-$SMFHDDS     	SIZE OF THE HEADER ( FOR SMHHDLEN)
SMHDATA  EQU  *         	        START OF THE DATA
         MEND

SMF Header Block Field Descriptions

The following information describes the SMF header block fields:

SMHLEN

Size of the (Security or Action) record, in bytes. This includes the size of the header block as well as the data block:

SMHSEGID

Not used.

SMHSID

Operating system against which the SMF record is written. Always X'02' with release 3.7.

SMHRECTY

Number that identifies this SMF record as specific to CA Endevor SCM. This number is defined to CA Endevor SCM through the Defaults Table.

SMHTIME

Time the SMF record was created (binary time of day in 100ths of a second-1 = .01 second).

SMHDATE

Date the SMF record was created (packed yyddd).

SMHCPUID

Number to identify the CPU model on which CA Endevor SCM is running.

SMHHDLEN

Size of the header block (DSECT $SMFHDDS), in bytes.

SMHC1VER

Code that identifies the format of the SMF record.

SMHCTLTY

Code that identifies the next record format in the SMF record.

SMHCONT

Not used.

SMHSEQ

Not used.

SMHC1ENV

Environment name associated with the current processing.

SMHUSER

User ID associated with the current processing.

SMHSIZE

Size of the $SMFHDDS DSECT.

$SMFREC1 DSECT: Security Record Data Block

This DSECT applies for Security Records, and includes data specific to the security violation being reported.

     $SMFREC1
$SMFREC1 DSECT
$SMFREC1 DS  0D         ALIGN IT
**********************************************************************
*                                  				    *
*     $SMFREC1 - DESCRIPTION FOR THE SECURITY RECORD      	    *
*                                  				    *
*                                  				    *
**********************************************************************
SM1REC1  EQU  *              START OF THE SMF 1 RECORD
SM1RECLN DS  H               LENGTH OF THE SECURITY RECORD
SM1RECVN DS  H          	     VERSION OF THE RECORD
SM1$V1   EQU  X'01'              VERSION 1
SM1$V2   EQU  X'02'              VERSION 2
SM1$CURV EQU  SM1$V2             CURRENT VERSION
SM1FUNC  DS  F               FUNCTION CODE ( CURRENT ACTION VERB)
SM1FUNNM DS  CL8             FUNCTION NAME
**********************************************************************
*                                  				    *
*     MESSAGE AREA                        			    *
*                                  				    *
**********************************************************************
SM1ERRCD DS  CL4             SECURITY MESSAGE CODE
SM1ERRLN DS  H               LENGTH OF SECURITY MESSAGE
SM1MSGSZ EQU  132                 LENGTH OF MESSAGE AREA MAX
SM1ERMSG DS  CL(SM1MSGSZ)    SIZE OF MESSAGE AREA
**********************************************************************
*                                  		   	    	    *
*     ENVIRONMENT INFORMATION                			    *
*                                 				    *
**********************************************************************
SM1SITE  DS  CL1        	     SITE CODE
SM1STGID DS  CL1             STAGE ID
SM1STGCD DS  CL1             STAGE CODE
SM1IFUNC DS  XL2             INTERNAL SECURITY FUNCTION
*                 	     SEE ECBFUNC OF $ECBDS FOR LIST OF
*                 	     ACTIONS
     DS  CL3        	     ** RESERVED **
SM1ENVM  DS  CL8             ENVIRONMENT NAME
SM1STAGE DS  CL8             STAGE NAME
SM1SYSTM DS  CL8             SYSTEM NAME
SM1SUBSY DS  CL8             SUBSYSTEM NAME
SM1STYPE DS  CL8             TYPE
SM1ELEMT DS  CL10            ELEMENT NAME (VERSION 1)
         ORG  SM1ELEMT       VERSION 2
SM1EAOFF DS  XL2               V2: ELMT AREA OFFSET FROM $SMFREC1
         DS  CL8               V2: RESERVED
**********************************************************************
*            				                            *
*     ASSOCIATED FILE INFORMATION IF ANY    		            *
*              				  	                    *
**********************************************************************
SM1DSNAM DS  CL44   	     ASSOC DATA SET NAME  (VERSION 1)
     ORG  SM1DSNAM  	     VERSION 2: (DSN/PATH)
SM1FAOFF DS  XL2    	        V2: FILE AREA OFFSET FROM $SMFREC1
     DS  CL42       		V2: RESERVED
*
SM1DSMEM DS  CL10   	     ASSOC DATA SET MEMBER (VERSION 1)
     ORG  SM1DSMEM  	     VERSION 2: (MBR/FILE NAME)
SM1NAOFF DS  XL2         	V2: NAME AREA OFFSET FROM $SMFREC1
     DS  CL8         		V2: RESERVED
SM1BSIZ  EQU  *-$SMFREC1     BASE SIZE OF THE RECORD
*
SM1BFAREA DS  XL(1030)       AREA BUFFER SPACE.
*
        DS  0D
SM1SIZ  EQU  *-$SMFREC1      SIZE OF THE RECORD
        MEND

Security Record Data Block Field Descriptions

The following information describes the fields in the Security Record data block:

SM1RECLN

Size of this data block (DSECT $SMFREC1), in bytes.

SM1RECVN

Version number. Identifies the CA Endevor SCM release that created the record. Valid values are:

SM1FUNC

Number that identifies the current activity: generally the type of action.

SM1FUNNM

Applicable if SM1FUNC references a CA Endevor SCM action. Name of the current action (ADD, UPDATE, etc.).

SM1ERRCD

The 4 characters that are used to construct the error code written to the CA Endevor SCM Execution Report for the current action in the ECBMSGCD field. The error code is formatted as C1XNNNNS, where:

SM1ERRLN

Not used.

SM1ERMSG

Error message associated with the current activity for the ECBMSG field.

SM1SITE

CA Endevor SCM site ID, as defined to the Defaults Table.

SM1STGID

Stage number for the current action request: 1 or 2.

SM1STGCD

Applicable if SM1FUNC references a CA Endevor SCM action. Stage ID for the current action request.

SM1IFUNC

Action information that is used internally by CA Endevor SCM.

SM1ENVM

Environment name for the current processing.

SM1STAGE

Applicable if SM1FUNC references a CA Endevor SCM action. Stage name for the current action request.

SM1SYSTM

Applicable if SM1FUNC references a CA Endevor SCM action. System name for the current action.

SM1SUBSY

Applicable if SM1FUNC references a CA Endevor SCM action. Subsystem name for the current action.

SM1STYPE

Applicable if SM1FUNC references a CA Endevor SCM action. Element type for the current action.

SM1ELEMT

(Version 1 Records Only) Applicable if SM1FUNC references a CA Endevor SCM action. Name of the element specified for the current action. row.

SM1EAOFF

(Version 2 Records Only) Element area offset. When the offset is added to the beginning of the record's address, the resulting address points to an area with in the SM1BFAREA. The element area is comprised of two adjacent components:

SM1DSNAM

(Version 1 Records Only) Applicable for security violations that relate to ADD, UPDATE, RESTORE, ARCHIVE, and RETRIEVE action requests. Data set name associated with the external file used by the current action.

SM1FAOFF

(Version 2 Records Only) File area offset. When the offset is added to the beginning of the record's address, the resulting address points to an area with in the SM1BFAREA. The file area is comprised of two adjacent components:

The file name may be a traditional file or an USS path name.

SM1DSMEM

(Version 1 Records Only) Applicable for security violations that relate to ADD, UPDATE, RESTORE, ARCHIVE, and RETRIEVE action requests. Member name associated with the element for which the current action applies, within the above data set. Applicable when the data set is a library.

SM1NAOFF

(Version 2 Records Only) Name area offset. When the offset is added to the beginning of the record's address, the resulting address points to an area with in the SM1BFAREA. The name area consists of two adjacent components:

The name may be a member name or an USS file name.

SM1BSIZ

Base size of the record.

SM1BFAREA

(Version 2 Records Only) This is reserved record space containing the various areas such as element, file and name.

SM1SIZ

Size of the $SMFREC1 DSECT

$SMFREC2 DSECT: Action Record Data Block

This DSECT applies for Action Records, and includes information specific to the action being reported. Depending on the action type, one or more action-specific blocks (pairs of DSECTs) are incorporated at the end of this DSECT.

Note: For more information, see $SMFBKDS DSECT: Action-Specific Blocks.

     $SMFREC2
$SMFREC2 DSECT
$SMFREC2 DS   0D         ALIGN IT
***********************************************************************
*                                                                     *
*    $SMFREC2 - DESCRIPTION FOR THE ACTIVITY RECORD                   *
*                                                                     *
***********************************************************************
SM2REC1  EQU  *         		START OF THE SMF 2 RECORD
SM2RECLN DS  H          		LENGTH OF THE ACTIVITY RECORD
SM2RECVN DS  H          		VERSION OF THE RECORD
SM2$V1   EQU  X'01'          	     VERSION 1
SM2$CURV EQU  SM2$V1          	     CURRENT VERSION 1
SM2FUNC  DS  F          		ACTION CODE
*                 		SEE ECBFUNC OF $ECBDS FOR LIST OF
*                 		ACTIONS.
SM2FUNNM DS  CL8         	 FUNCTION NAME
SM2BLKS  DS  F          		 NUMBER OF BLOCKS IN RECORD
SM2$ENV  EQU  1            		ENVIRONMENT BLOCK
SM2$LCHG EQU  2            		LAST CHANGE BLOCK
SM2$PROC EQU  3            		PROCESSOR INFO BLOCK
SM2$REQP EQU  4            		REQUEST PARMS BLOCK
SM2RECHD DS  H          		 SIZE OF THE SM2 HEADER
SM2IFUNC DS  H           	 INTERNAL SECURITY FUNCTION
*                 		SEE ECBFUNC OF $ECBDS FOR LIST OF
*                 		ACTIONS.
SM2DATA  DS  0D
SM2HDRLN EQU  *-SM2REC1     	OFFSET TO START OF RECORD
     	 DS  (SM2LCHLN)CL1      		ONE LAST ACTION BLOCK
     	 DS  (SM2PRCLN)CL1     		ONE PROCESSOR INFO
     	 DS  (SM2REQLN)CL1     		ONE REQUEST PARM BLOCK
     	 DS  (SM2ENVLN)CL1      		ENV 1 BLOCK
     	 DS  (SM2ENVLN)CL1      		ENV 2 BLOCK
     	 DS  100CL1       	EXTRA ROOM
SM2SIZ   EQU  *-$SMFREC2     SIZE OF THE RECORD
     MEND

Action Record Data Block Field Descriptions

The following information describes the Action Record data block fields:

SM2RECLN

Size of this data block (DSECT $SMFREC2), in bytes, including all action-specific blocks included at the end (DSECT $SMFBKDS).

SM2RECVN

Version number to identify this data block ($SMFREC2). This should always be 1. Use the SM2$VERS label to verify that the correct version of this DSECT was used. For example, a value of one with the label SM2$VERS means the version for that block is 1.

SM2FUNC

Number that identifies the current activity: generally the current type of action.

SM2FUNNM

Applicable if SM2FUNC references a CA Endevor SCM action. Name of the current action (ADD, UPDATE, and so forth).

SM2BLKS

Count of action-specific blocks included at the end of this DSECT: 1-5.

SM2RECHD

Size of this data block (DSECT $SMFREC2), in bytes, excluding the action-specific blocks (DSECT $SMFBKDS).

SM2IFUNC

Action information that is used internally by CA Endevor SCM.

SM2HDRLN

Size of the $SMFREC2 DSECT, excluding the action-specific blocks

SM2SIZ

Size of the $SMFREC2 DSECT, including all action-specific blocks incorporated at the end.

$SMFBKDS DSECT: Action-Specific Blocks

This DSECT applies for Action Records, and includes data specific to the action being reported. $SMFBKDS includes five DSECTs-one action-block header and four action-block detail DSECTs. These DSECTs are used in pairs, with each pair including a header and one type 1, 2, 3, or 4 detail DSECT. The type of detailed information included can be identified through the SM2BTYP field in the header.

*********************************************************************** 00140001
*                                                                     * 00149801
*        $SMFBKDS - DSECTS FOR EACH BLOCK OF SMF2 DATA                * 00120000
*                                                                     * 00150001
*  EACH BLOCK IS PRECEDED BY A HEADER:                                * 00130000
*          TYPE 1 - ENVIRONMENT INFORMATION                           * 00130000
*          TYPE 2 - LAST CHANGE INFORMATION                           * 00130000
*          TYPE 3 - PROCESSOR INFORMATION                             * 00130000
*          TYPE 4 - REQUEST PARAMETER INFORMATION                     * 00130000
*********************************************************************** 00150101
*                                                                     * 00130000
*        BLOCK  HEADER                                                * 00150301
*                                                                     * 00130000
*********************************************************************** 00130000
*                                                                     * 00130000
* NOTE: IF THIS CONTROL BLOCK IS CHANGED, CHECK C1BR3020 (CONRPT42)   * 00130000
*       TO SEE IF THAT PGM NEEDS TO CHANGE AS WELL.  SINCE C1BR3020   * 00130000
*       DOES NOT INCLUDE THIS CONTROL BLOCK, IT IS EASY TO FORGET TO  * 00130000
*       UPDATE IT.                                                    * 00130000
*                                                                     * 00130000
*********************************************************************** 00150201
SM2BHDDS DSECT                                                          00150600
SM2BLEN  DS    H                   LENGTH OF THE BLOCK                  00151100
SM2BTYP  DS    H                   TYPE OF BLOCK                        00151200
SM2BVER  DS    H                   VERSION OF BLOCK                     00151300
SM2B$V1  EQU   1                    VERSION 1                           00151400
SM2B$V2  EQU   2                    VERSION 2 (LONG NAME ELM)           00151400
SM2B$V3  EQU   3                    VERSION 3 (PROC GROUP)              00151400
SM2B$V4  EQU   4                    VERSION 4 (SEARCH)                  00151400
SM2B$V5  EQU   5                    VERSION 5 (R14 BASE FEATURES)       00151400
SM2BFLG1 DS    CL1                 FLAG 1 FOR BLOCK                     00151500
SM2BFLG2 DS    CL1                 FLAG 2 FOR BLOCK                     00151600
         DS    0D                                                               
SM2BHDR  EQU   *-SM2BHDDS          LENGTH OF HEADER                     00151700
*********************************************************************** 00151801
*                                                                     * 00130000
*        ENVIRONMENT BLOCK  TYPE 1                                    * 00151901
*                                                                     * 00130000
*********************************************************************** 00152001
SM2ENVDS DSECT                                                          00152500
         DS    0D            ** START OF HEADER                                 
SM2ELEN  DS    H                   LENGTH OF THE BLOCK                  00430001
SM2ETYP  DS    H                   TYPE OF BLOCK                        00440001
SM2EVER  DS    H                   VERSION OF BLOCK (SM2B$V1/V2)        00450001
SM2EFLG1 DS    CL1                 FLAG 1 FOR BLOCK                     00460001
SM2EFLG2 DS    CL1                 FLAG 2 FOR BLOCK                     00470001
         DS    0D            ** END OF HEADER                                   
SM2SITE  DS    CL1                 SITE CODE                            00153000
SM2STGCD DS    CL1                 STAGE SELECTION CODE FROM C1DEFLTS           
SM2STGID DS    XL1                 STAGE ID - 1 OR 2                            
SM2SRCHR DS    CL1                 SRCHREPL UTILITY FLAG                        
SM2$ELEM EQU   C'E'                 SRCHREPL PROCESSING AN ELEMENT              
SM2$COMP EQU   C'O'                 SRCHREPL PROCESSING OUTPT COMPONENT         
SM2VER   DS    H                   VERSION OF THE ELEMENT               00153204
SM2LVL   DS    H                   LEVEL OF THE ELEMENT                 00153304
SM2ENVM  DS    CL8                 ENVIRONMENT NAME                     00153200
SM2STAGE DS    CL8                 STAGE NAME                           00153300
SM2SYSTM DS    CL8                 SYSTEM NAME                          00153400
SM2SUBSY DS    CL8                 SUBSYSTEM NAME                       00153500
SM2STYPE DS    CL8                 TYPE                                 00153600
SM2ELEMT DS    CL10                ELEMENT NAME   (VERSION 1)           00153700
         ORG   SM2ELEMT            VERSION 2:                           00153700
SM2EAOFF DS    XL2                   V2: ELE AREA OFFSET FROM SM2ENVDS          
SM2PRGRP DS    CL8                   V3: PROCESSOR GROUP                        
*********************************************************************** 00154401
*                                                                     * 00153800
*        ASSOCIATED FILE INFORMATION IF ANY                           * 00153900
*                                                                     * 00154000
*********************************************************************** 00154401
SM2DSNAM DS    CL44                ASSOC DATA SET NAME   (VERSION 1)    00154100
         ORG   SM2DSNAM            VERSION 2:  (DSN/PATH)                       
SM2FAOFF DS    XL2                   V2: FILE AREA OFFSET FROM SM2ENVDS         
         DS    CL42                  V2: RESERVED                               
*                                                                               
SM2DSMEM DS    CL10                ASSOC DATA SET MEMBER (VERSION 1)    00154200
         ORG   SM2DSMEM            VERSION 2:  (MBR/FILE NAME)                  
SM2NAOFF DS    XL2                   V2: NAME AREA OFFSET FROM SM2ENVDS         
         DS    CL8                   V2: RESERVED                               
SM2EBSIZ EQU   *-SM2ENVDS          ENV BASE SIZE                                
SM2EAREA DS    XL(1030)            AREA BUFFER SPACE                            
SM2EDATA DS    0D                                                               
SM2ENVLN EQU   *-SM2ENVDS          LENGTH OF ENV BLOCK                  00690001
*********************************************************************** 00154401
*                                                                     *         
*        LAST CHANGE BLOCK  TYPE 2                                    * 00154501
*                                                                     *         
*********************************************************************** 00154601
SM2LCGDS DSECT                                                          00155100
         DS    0D            ** START OF HEADER                                 
SM2LLEN  DS    H                   LENGTH OF THE BLOCK                  00820001
SM2LTYP  DS    H                   TYPE OF BLOCK                        00830001
SM2LVER  DS    H                   VERSION OF BLOCK (SM2B$V1)           00840001
SM2LFLG1 DS    CL1                 FLAG 1 FOR BLOCK                     00850001
SM2LFLG2 DS    CL1                 FLAG 2 FOR BLOCK                     00860001
         DS    0D            ** END OF HEADER                                   
SM2CCOM  DS    CL40                LAST CHANGE COMMENT                  00155600
SM2MLDTE DS    CL6                 LAST CHANGE LVL DATE(YYMMDD)         00155700
SM2MLTME DS    CL4                 LAST CHANGE LVL TIME(HHHH)           00155800
SM2LUSID DS    CL8                 LAST LEVEL - USERID                  00155900
SM2MLACT DS    CL8                 LAST ACTION                          00156000
         DS    CL2                 ** RESERVED **                       00156100
SM2MLTOT DS    F                   LAST LEVEL TOTAL                     00156200
SM2LDATA DS    0D                                                               
SM2LCHLN EQU   *-SM2LCGDS          LENGTH OF LAST CHANGE BLOCK          00960001
*********************************************************************** 00156401
*                                                                     *         
*        PROCESSOR INFO BLOCK  TYPE 3                                 * 00156501
*                                                                     *         
*********************************************************************** 00156601
SM2LPRDS DSECT                                                          00157100
         DS    0D            ** START OF HEADER                                 
SM2PLEN  DS    H                   LENGTH OF THE BLOCK                  01090001
SM2PTYP  DS    H                   TYPE OF BLOCK                        01100001
SM2PVER  DS    H                   VERSION OF BLOCK (SM2B$V1)           01110001
SM2PFLG1 DS    CL1                 FLAG 1 FOR BLOCK                     01120001
SM2PFLG2 DS    CL1                 FLAG 2 FOR BLOCK                     01130001
         DS    0D            ** END OF HEADER                                   
SM2LPRON DS    CL10                PROCESSOR NAME                       00157600
SM2LPROD DS    CL6                 GENERATE - LAST DATE                 00157700
SM2LPROT DS    CL4                 GENERATE - LAST TIME                 00157800
SM2LPROU DS    CL8                 GENERATE - LAST USERID               00157900
SM2LPHRC DS    H                   GENERATE - HIGHEST RETURN CODE       00158002
SM2LPRC1 DS    H                   GENERATE - C1 RETURN CODE            00158102
SM2PDATA DS    0D                                                               
SM2PRCLN EQU   *-SM2LPRDS          LENGTH OF PROCESSOR BLOCK            01220001
*********************************************************************** 00159001
*                                                                     *         
*        REQUEST PARAMETER INFORMATION  TYPE 4                        * 00160001
*                                                                     *         
*********************************************************************** 00170001
SM2REQDS DSECT                                                          00190001
         DS    0D            ** START OF HEADER                                 
SM2RLEN  DS    H                   LENGTH OF THE BLOCK                  01350001
SM2RTYP  DS    H                   TYPE OF BLOCK                        01360001
SM2RVER  DS    H                   VERSION OF BLOCK                     01370001
SM2RFLG1 DS    CL1                 FLAG 1 FOR BLOCK                     01380001
SM2RFLG2 DS    CL1                 FLAG 2 FOR BLOCK                     01390001
         DS    0D            ** END OF HEADER                                   
SM2RCCID  DC    CL12' '            CCID ASSOC W/ ACTION                         
SM2RCOMM  DC    CL40' '            COMMENT ASSOC W/ ACTION                      
SM2RFLAG  DC    F'0'               ANY SPECIAL FLAGS                    00282001
SM2RSISO  DC    CL1' '             SIGNIN/SIGNOUT FORCE ( Y OR N)       00283001
SM2RSICO  DC    CL1' '             SIGNIN/SIGNOUT COPY ONLY ( Y OR N)   00286001
SM2REXPN  DC    CL1' '             EXPAND INCLUDES ( Y OR N)            00287001
SM2ROVER  DC    CL1' '             WRITE OVER EXISTING RETR MBR         00288001
SM2RRTCD  DC    F'0'               ACTION RETURN CODE                   00288103
SM2RDEL   DC    CL1' '             DELETE REQUEST FLAG                          
*                                  BLANK IF N/A                                 
*                                  Y - YES, DELETE WAS REQUESTED                
*                                  N - NO, DELETE WAS NOT REQUESTED             
SM2RIGNF  DC    CL1' '             IGNORE GENERATE FAILED    (Y / N)            
SM2RBGNP  DC    CL1' '             BYPASS GENERATE PROCESSOR (Y / N)            
SM2RBDLP  DC    CL1' '             BYPASS DELETE PROCESSOR   (Y / N)            
SM2RSYNC  DC    CL1' '             SYNC OPTION SPECIFIED     (Y / N)            
SM2RONCP  DC    CL1' '             DELETE ONLY COMPONENTS    (Y / N)            
SM2RMVWH  DC    CL1' '             MOVE/TRANSFER W/ HISTORY  (Y / N)            
SM2RAWUP  DC    CL1' '             ADD W/ UPDATE OPTION      (Y / N)            
SM2RPGRP  DC    CL8' '             PROCESSOUR GROUP OVERRIDE                    
SM2RSIUS  DC    CL8' '             SIGNOUT TO USERID                            
SM2REMCH  DC    CL1' '             VALIDATE ACT - ELEMENT MASTER CHK            
SM2RSYCH  DC    CL1' '             VALIDATE ACT - SYNCHRONIZATION CHK           
SM2RCMCH  DC    CL1' '             VALIDATE ACT - COMP VALIDATION CHK           
SM2RTMSG  DC    CL1' '             VALIDATE ACT - TERSE MESSAGES                
SM2RAUTG  DC    CL1' '             AUTOGEN OPT FOR ADD, UPD, AND GEN            
SM2RAUTX  DC    CL1' '             AUTOGEN ON BEHALF OF A COMPONENT             
SM2RNSRC  DC    CL1' '             ELEMENT SOURCE-LESS FLAG                     
SM2RSPAN  DC    CL1' '             AUTOGEN SPAN OPTION (N/A/S/B)                
          DC    CL12' '            ** RESERVED **                               
SM2RDATA DS    0F                                                               
SM2REQLN EQU   *-SM2REQDS          LENGTH OF PROCESS BLOCK              01550001

Action-Block Header Field Descriptions (SM2BHDDS)

The following information describes the fields in action-block header:

SM2BLEN

Size of this action-specific block (action-block header, SM2BHDDS, plus the action-block detail DSECT), in bytes.

SM2BTYP

Code that indicates the DSECT used to write out the action-block detail for this action- specific block:

SM2BVER

Version number to identify this DSECT ($SMFBKDS). This should always be 1 except for the action block header.

SM2BFLG1

Not used.

SM2BFLG2

Not used.

SM2BHDR

Size of the action-block header ($SM2BHDDS).

Environment Action-Block Detail Field Descriptions (SM2ENVDS)

The following information describes the Environment action-block detail fields:

SM2SITE

CA Endevor SCM site ID, as defined to the Defaults Table.

SM2STGCD

Stage ID for the current action request.

SM13STGID

Stage number for the current action request: 1 or 2.

SM2SRCHR

Search and Replace utility flag.

SM2$ELEM

Search and Replace utility action on an element.

SM2$COMP

Search and Replace utility action on an output component.

SM2VER

Version number associated in the MCF with the element for the action request.

SM2LVL

Number to identify the current level of the element for the current action request.

SM2STAGE

Stage name for the current action request.

SM2SYSTM

System name for the current action request.

SM2SUBSY

Subsystem name for the current action request.

SM2STYPE

Element type for the current action request.

SM2ELEMT

(Version 1 Record Only) Name of the element specified for the current action request.

SM2EAOFF

(Version 2 Record Only) Element area offset. The element name for the current action request is stored in the buffer area located near the end of the record. When the offset is added to the beginning of this record's address, the resulting address points to an area within SM2EAREA buffer space. The element area is composed of two adjacent components:

SM2PRGRP

Processor group name for the current action request.

SM2DSNAM

(Version 1 Record Only) Applicable for ADD, UPDATE, RESTORE, ARCHIVE, and RETRIEVE action requests. Data set name associated with the external file used by the current action.

SM2FAOFF

(Version 2 Record Only) File area offset. The file name for the current action request is stored in the buffer area located near the end of the record. When the offset is added to the beginning of this record's address, the resulting address points to an area within SM2EAREA buffer space. The file area is composed of two adjacent components:

The file name may be a traditional data set or an USS path name.

SM2DSMEM

(Version 1 Record Only) Applicable for ADD, UPDATE, RESTORE, ARCHIVE, and RETRIEVE action requests. Member name associated with the element for which the current action applies, within the above data set. Applicable when the data set is a library; blank otherwise.

SM2NAOFF

(Version 2 Record Only) Name area offset. The member name for the current action request is stored in the buffer area located near the end of the record. When the offset is added to the beginning of this record's address, the resulting address points to an area within SM2EAREA buffer space. The name area is composed of two adjacent components:

If a member/file name is not applicable to the current action, the offset value is set to zero.

SM2EAREA

(Version 2 Record Only) Space reserved in the record containing various data such as the element, file and member name.

SM2ENVLN

Size of the action-specific block (header and detail) if the action-block detail uses the Environment DSECT ($SM2ENVDS).

Last Change Action-Block Detail Field Descriptions (SM2LCGDS)

The following describes the Last Change action-block detail fields:

SM2CCOM

Current-level comment for the element.

SM2MLDTE

Current-level date for the element.

SM2MLTME

Current-level time for the element.

SM2LUSID

Current-level user ID for the element.

SM2MLACT

Last action executed for the element.

SM2MLTOT

Count of source statements for the element, as of the current level.

SM2LCHLN

Size of the action-specific block (header and detail) if the action-block detail uses the Last Change DSECT ($SM2LCGDS).

Processor Information Action-Block Detail Field Descriptions (SM2LPRDS)

The following describes the Processor Information action-block detail fields:

SM2LPRON

(Element) name of the processor last run for the element.

SM2LPROD

Processor date for the element.

SM2LPROT

Processor time for the element.

SM2LPROU

Processor user ID for the element.

SM2LPHRC

Processor return code for the element.

SM2LPRC1

CA Endevor SCM return code for the element.

SM2PRCLN

Size of the action-specific block (header and detail) if the action-block detail uses the Processor Information DSECT ($SM2LPRDS).

Request Parameter Info Action-Block Detail Field Descriptions (SM2REQDS)

The following describes the Request Parameter Info action-block detail fields:

SM2RCCID

CCID associated with the current action request.

SM2RCOMM

Comments associated with the current action request.

SM2RFLAG

Not used.

SM2RSISO

Indicates whether the current action requested a signout override: Y (Yes) or N (No).

SM2RSICO

Applicable for a RETRIEVE action. Indicates whether the current action specified copy-only: Y (Yes) or N (No).

SM2REXPN

Applicable for a RETRIEVE action. Indicates whether the current action requested that INCLUDEs be expanded: Y (Yes) or N (No).

SM2ROVER

Applicable for a RETRIEVE action. Indicates whether the current action requested an overwrite if a member by the same name exists already in the output library: Y (Yes) or N (No).

SM2RRTCD

Not used.

SM2RDEL

Indicates whether the element was deleted upon completion of the requested action: Y (Yes) or N (No). This value is X'40' if a delete does not apply for the current action.

SM2REQLN

Size of the action-specific block (header and detail) if the action-block detail uses the Request Parameter Information DSECT ($SM2REQDS).

SM2REMCH

Indicates whether the Validate action with the Element Master option was specified. Possible values are: Y (Yes) or N (No).

Note: This field is currently not in use and will not be populated.

SM2RSYCH

Indicates whether the Validate action with the Synchronization option was specified. Possible values are: Y (Yes) or N (No).

Note: This field is currently not in use and will not be populated.

SM2RCMCH

Indicates whether the Validate action with the Component Validation option was specified. Possible values are: Y (Yes) or N (No).

Note: This field is currently not in use and will not be populated.

SM2RTMSG

Indicates whether the Validate action with the Terse option was specified. Possible values are: Y (Yes) or N (No).

Note: This field is currently not in use and will not be populated.

SM2RAUTG

Indicates whether the AUTOGEN element option was specified on the ADD, UPDATE or GENERATE action. Possible values are: Y (Yes) or N (No). If the value of this field is Y, the value of the SM2AUTX field will be N.

SM2RAUTX

Indicates whether this where-used element was generated on behalf of a component element. Possible values are: Y (Yes) or N (No). If the value of this field is Y, the value of the SM2AUTG field will be N.

SM2RNSRC

Indicates whether the NOSOURCE action option was in effect for the Generate, Add, or Update action. Possible values are: Y (Yes) or N (No).

SM2RSPAN

Indicates whether one of the Autogen Span options was specified on the Add, Update or Generate action. Possible values are: N (span none), A (span all), S (span Systems), B (span Subsystems).