SMF Recording

Contents
ce17
Contents
2
Enable SMF Recording
The SMF option records each action and each security violation that occurs during
CA Endevor SCM
processing. SMF recording is done on an Environment-by-Environment basis. Therefore, you can selectively enable SMF recording for each of your Environments. The SMF option can write out the following SMF records:
  • Security records
    For each security violation, or each error that is returned from the security exit (exit 1).
  • Activity records
    For each action executed, except for the following actions: Print, Display, Copy, and List. Activity records are written out at the end of action processing.
The administrator enables the SMF option in the Defaults table (C1DEFLTS). Per Environment, recording can be enabled for security records, activity records, or both.
Follow these steps:
  1. Edit the SMFREC# parameter in the C1DEFLTS TYPE=MAIN macro to specify an SMF record number for for your site.
    SMFREC#
    -- Specifies the SMF record number assigned to SMF records written by
    CA Endevor SCM
    at this site. Default is 0, which disables SMF recording.
    Talk to a systems programmer at your site to ensure that you are collecting the SMF records related to the record number specified in the SMFREC# parameter. Recording records is controlled in SYS1.PARMLIB(SMFPRMxx).
  2. Edit the following parameters in the C1DEFLTS TYPE=ENVRNMNT.
    SMFACT
    -- Specifies whether to write SMF activity records for this Environment.
    • Y
      Writes activity records for the Environment.
    • N
      Does not write activity records for the Environment. Default is N.
    SMFSEC
    -- Specifies whether to write SMF security records for this Environment.
    • Y
      Writes security records for the Environment.
    • N
      Does not write security records for the Environment. Default is N.
  3. Reassemble and link C1DEFLTS to activate the modifications.
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 Using the Comma-Separated Value (CSV) Utility.
Record Formats
CA Endevor SCM
uses several blocks to build the SMF security and activity records, each comprising one or more DSECTs. All SMF DSECTs are supplied by the following macros in iprfx.iqual.CSIQOPTN: $SMFBKDS, $SMFHDDS, $SMFREC1, $SMFREC2, $SMFREC4.
Each SMF record output by
CA Endevor SCM
starts with a standard SMF header block (DSECT $SMFHDDS), which contains fields required by SMF, and 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. 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:
  • DSECT $SMFREC1 for security records.
  • DSECT $SMFREC2 for activity records. For activity records, the $SMFREC2 block encompasses one or more action-specific blocks.
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, is described using the following DSECTs:
  • $SMFHDDS
  • $SMFREC1
SMF Activity Records
SMF activity records include data specific to the action being reported, and applies to all actions except PRINT, DISPLAY, COPY, and LIST. Each activity record has one occurrence of the $SMFREC2 DSECT, and one or more action-specific blocks from the $SMFBKDS macro, as appropriate to the action. Each action-specific block has an action-block header (DSECT SM2BHDDS), and either the type 1, 2, 3, 4 or 5 action-block detail information, respectively DSECT SM2ENVDS, SM2LCGDS, SM2LPRDS, SM2REQDS or SM2ALTDS.
For more information about each action block, identified separately, see $SMFBKDS DSECT: Action-Specific Blocks.
The combined format for SMF activity records, is described using the following DSECTs:
  • $SMFHDDS
  • $SMFREC2
  • SM2BHDDS action-block header
  • $SMFBKDS action-block detail (type n, includes up to five action blocks)
There are five 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)
Alter
Update (2)
Retrieve (2)
Generate (2)
Move (2)
Delete (2)
Transfer (2)
Archive (2)
Restore (2)
Information describing the Environment where the action took place: name of the Environment, site ID, and so on. 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.
5
Alter Info (SM2ALTDS)
Alter
Information specific to the Alter action: Before field value, after field value, and match (mask) value.
DSECT Descriptions
This section describes each of the DSECTs used to write out SMF activity 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.
SMF Header Block Field Descriptions
The header block, $SMFHDDS DSECT, is written at the beginning of each SMF record.
CA Endevor SCM
security and activity 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).
The following information describes the SMF header block fields:
  • SMHLEN
    Size of the (security or activity) record, in bytes. This includes the size of the header block as well as the data block:
    • $SMFREC1-Security records
    • $SMFREC2 (including all action-specific blocks)-activity records
  • 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.
    • SMH$RF00-This record was created by
      CA Endevor SCM
      release 2.2 or a prior release.
    • SMH$RF01-This record was created by
      CA Endevor SCM
      release 2.5 or a later release.
  • 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.
Security Record Data Block Field Descriptions
The security record data block, $SMFREC1 DSECT, applies to security records and includes data specific to the security violation being reported.
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:
    • 1 -- The record was created by a release of
      CA Endevor SCM
      prior to release 4.0.
    • 2 -- The record was created by
      CA Endevor SCM
      release 4.0 or a later release.
  • 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:
    • X-Describes the origin of the message.
    • NNNN-Defined by this field.
    • S-Severity code associated with the return code field, ECBRTCD, in DSECT $ECBDS.
  • 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
    (SM1RECVN version 1 records only) Applicable if SM1FUNC references a
    CA Endevor SCM
    action. Name of the Element specified for the current action.
  • SM1EAOFF
    (SM1RECVN 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:
    • Two byte field containing the length
    • Element name
  • SM1DSNAM
    (SM1RECVN 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
    (SM1RECVN 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:
    • Two byte field containing the length
    • File name
    The file name may be a traditional file or an USS path name.
  • SM1DSMEM
    (SM1RECVN 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
    (SM1RECVN 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:
    • Two byte field containing the length
    • File name
    The name may be a member name or an USS file name.
  • SM1BSIZ
    Base size of the record.
  • SM1BFAREA
    (SM1RECVN 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
Activity Record Data Block Field Descriptions
The activity record data block, $SMFREC2 DSECT, applies to activity records and includes information specific to the action being reported. Depending on the action type, one or more action-specific blocks are incorporated at the end of this DSECT.
The following information describes the activity 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 value was updated to 2 for addition of the Alter block. Use the SM2$CURV label to detect that either the record is the current version (2) or the previous version of the SMF activity record.
  • 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 MACRO Action-Specific Blocks
The action-specific block applies for activity records, and includes data specific to the action being reported. $SMFBKDS includes six DSECTs-one action-block header and five action-block detail DSECTs. These DSECTs are used in pairs, with each pair including a header and one type 1, 2, 3, 4 or 5 detail DSECT. The type of detailed information included can be identified through the SM2BTYP field in the header.
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:
    • Two-byte length field
    • Element name
  • 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:
    • Two-byte length field
    • Data set name
    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:
    • Two-byte length field
    • Member name (PDS file) or file name (HFS)
    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
    The return code associated with the current action request.
  • 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).
    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).
    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).
    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).
Alter Action Information Block Field Descriptions (SM2ALTDS)
The following information describes the Alter action-block detail fields:
  • SM2AFLD
    Contains the field ID requested for an Alter action. An SMF record is created for each field requested in an Alter action, meaning that one Alter action can create several Alter SMF records.
    An SMF record is only created if the Alter action is performed and the Master Control File is updated. No SMF record is created in the following cirsumstances:
    Possible values are as follows:
    1 -- Indicates the Alter action requested the replacement of a Generate CCID value in the Master Control File.
    2 -- Indicates the Alter action requested the replacement of a Last Action CCID value in the Master Control File.
    3 -- Indicates the Alter action requested the replacement of a Retrieve CCID value in the Master Control File.
    4 -- Indicates the Alter action requested the replacement of a Description value in the Master Control File.
    5 -- Indicates the Alter action requested the replacement of a Processor Group value in the Master Control File.
    6 -- Indicates the Alter action requested the replacement of a Signout Userid value in the Master Control File.
    7 -- Indicates the Alter action requested the replacement of a User Data value in the Master Control File.
  • SM2AUPDT
    Indicates whether the Master Control File was updated. Valid values are Y or N:
    Y -- Indicates that the Master Control File record was updated.
    N -- Indicates that the Master Control File record was not updated.
  • SM2ADATA
    Label for the beginning of the variable Alter data area. For the Alter action data area, only one group of fields exists per record, the data area is redefined for each group of fields. These fields correspond to the Alter action field IDs, refer to SMA2FLD for field ID values.
    Generate CCID fields:
  • SM2ACCGB
    Value of the Generate CCID before the Alter action.
  • SM2ACCGA
    Value of the Generate CCID after the Alter action.
  • SM2ACCGM
    Mask value specified as the from-value for the Generate CCID.
  • Last Action CCID fields:
  • SM2ACCLB
    Value of the Last Action CCID before the Alter action.
  • SM2ACCLA
    Value of the Last Action CCID after the Alter action.
  • SM2ACCLM
    Mask value specified as the from-value for the Last Action CCID.
  • Retrieve CCID fields:
  • SM2ACCRB
    Value of the Retrieve CCID before the Alter action.
  • SM2ACCRA
    Value of the Retrieve CCID after the Alter action.
  • SM2ACCRM
    Mask value specified as the from-value for the Retrieve CCID.
  • Description fields:
  • SM2ADESB
    Value of the Description before the Alter action.
  • SM2ADESA
    Value of the Description after the Alter action.
  • SM2ADESM
    Mask value specified as the from-value for the Description.
  • Processor Group fields:
  • SM2APRGB
    Value of the Processor Group before the Alter action.
  • SM2APRGA
    Value of the Processor Group after the Alter action.
  • SM2APRGM
    Mask value specified as the from-value for the Processor Group.
  •  Signout Userid fields:
  • SM2ASGNB
    Value of the Signout Userid before the Alter action.
  • SM2ASGNA
    Value of the Signout Userid after the Alter action.
  • SM2ASGNM
    Mask value specified as the from-value for the Signout Userid.
  • User Data fields:
  • SM2AUSRB
    Value of the User Data before the Alter action.
  • SM2AUSRA
    Value of the User Data after the Alter action.
  • SM2AUSRM
    Mask value specified as the from-value for the User Data.
  • SM2AUSR_FPOS
    From-position specified for the User Data.
  • SM2AUSR_FTXL
    Length of the mask value (from-value) text string for the User Data.
  • SM2AUSR_TPOS
    To-position specified for the User Data.
  • SM2AUSR_TLEN
    To length specified for the User Data.
  • SM2AUSR_TTXL
    Text length of the replacement value specified for the User Data.
  • SM2AUSR_TPAD
    Pad character specified for the User Data. This field is required if the “to” length (SM2AUSR_TLEN) is greater than the length of the replacement value (SM2AUSR_TTXL)