The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

BMC AMI DevOps for Application Checkpoint Analysis

BMC DevOps for CFA Plugin: BMC AMI DevOps for Application Checkpoint Analysis

  • server : String
    URL or IP address.
  • port : String
    z/OSMF Port
  • user : String
    z/OS user name
  • jclContent : String
  • chkfreq : String
  • jobCard : String
  • acctno : String
  • thresh : String
  • sortby : String
  • pswd : String
  • prilog : String
  • cfaLoadLibs
      Array / List of Nested Object
    • lib : String
  • cfaSldsLibs
      Array / List of Nested Object
    • sldsname : String
    • sldsver : String
    • sldsunit : String
    • sldsvolser : String
  • cfaDliLibs
      Array / List of Nested Object
    • dliname : String
    • dliver : String
    • dliunit : String
    • dlivolser : String
  • cfaJobnames
      Array / List of Nested Object
    • jobname : String
  • cfaReconSets
      Array / List of Nested Object
    • recon1 : String
    • recon2 : String
    • recon3 : String
  • goodRC : String
    Any value that is above the acceptable return code will be considered as FAILURE.
  • bmcSlds : boolean

    You can use the SLDS keyword on the ANALYZE control statement to identify explicitly an input log data set to use as input to the analysis process. SLDS=(dataSetName,Rvr, unit,volser) If you want CFA to read multiple log data sets, specify multiple instances of the SLDS keyword.
    Example: IMSA is an IMS version 14.1 system and creates generations of SLDSs that use the naming convention imsid.SLDS.Ddate.GENnnn. The SLDSs are cataloged. To analyze log records that IMSA wrote to generations 10 through 12 on March 29, 2015, specify the following keywords on the ANALYZE control statement:
    SLDS=(IMSA.SLDS.D2008088.GEN010, R141)
    SLDS=(IMSA.SLDS.D2008088.GEN011, R141)
    SLDS=(IMSA.SLDS.D2008088.GEN012, R141)

  • bmcDb2log : boolean

    You can use the DB2LOG keyword on the ANALYZE control statement to identify a DB2 log data set that was created by a DB2 subsystem.
    Note: If you specify the DB2LOG keyword, do not specify the DB2BSDS keyword.

  • db2log : String
    Specify the fully qualified data set name. No default value is provided.
    If you omit the DB2LOG keyword, CFA does not read any DB2 logs.
  • db2bsds : String
  • limit : String
  • skip : String
  • maxlogs : String

    If you specify a value from 1 through 999, Log Analyzer stops reading log data sets after it reaches the specified number of log data sets. If Log Analyzer does not read other log data sets because the specified limit was reached, a warning message indicates the number of log data sets that were not read.

    If you want Log Analyzer to read all log data sets, specify MAXLOGS=999.

    The default is MAXLOGS=100 (Log Analyzer reads a maximum of 100 log data sets).

  • bmcDb2bsds : boolean

    You can use the DB2BSDS keyword on the ANALYZE control statement to identify a DB2 bootstrap data set (BSDS).
    Specify the fully qualified data set name. This name should refer to a VSAM key-sequenced data set (KSDS).
    Do not specify the name of a BSDS archive copy, which is not a VSAM KSDS. BSDS cannot be a TAPE dataset.
    Note:

    • No default value is provided. If you omit the DB2BSDS keyword, CFA does not read any DB2 BSDSs.
    • If you specify the DB2BSDS keyword, do not specify the DB2LOG keyword.

  • bmcLimit : boolean

    You can use the LIMIT keyword (or the LIM abbreviation) on the ANALYZE control statement to set a limit on the number (1 through 9999999999) of log records to process from an input log data set.
    Note:

    • The default is LIMIT=9999999999.
    • If you specify the LIMIT keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.

  • bmcSkip : boolean

    You can use the SKIP keyword on the ANALYZE control statement to specify a number (1 through 9999999999) of log records in an input log data set to skip before CFA begins to process records.
    The default is SKIP=0, which skips no records.
    Note:
    If you specify the SKIP keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.

  • bmcActiveOlds : boolean
    You can use the ACTIVEOLDS keyword (or the AOLDS abbreviation) on the ANALYZE control statement to specify whether CFA can select an active OLDS during RECON processing
  • bmcImsid : boolean

    You can use the IMSID keyword on the ANALYZE control statement to specify one or more IMSIDs.
    If you do not check this option,then the the default IMSID=ALL will be taken and all log records for all IMS systems that are associated with the input RECON data set (or data sets) will be considered.
    Note:
    If you specify the SLDS keyword, you cannot specify the IMSID keyword. The IMSID keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.

  • bmcDlilog : boolean

    You can use the DLILOG keyword on the ANALYZE control statement to identify explicitly an input dli log data set to use as input to the analysis process.
    Specify the keyword values as follows:
    DLILOG=(dataSetName,Rnn)
    DLILOG=(dataSetName,Rvr,unit,volser)
    Notes:

    • This keyword is used only for the APPCHECK report.
    • The DLILOG datasets that are processed for the APPCHECK report for DLI are the DLI logs created by using the DLI batch job that uses the //IEFRDER DD statement. For more information about //IEFRDER DD, refer to the IBM IMS Program Restart Facility for z/OS documentation.
  • bmcMaxlogs : boolean
    You can use the MAXLOGS keyword (or the MAXL abbreviation) on the ANALYZE control statement to control the number of log data sets that Log Analyzer processes.

    Use this keyword when you are using implicit specification of log data sets and Log Analyzer is reading RECON data sets to determine which log data sets to process. In this case, the number of log data sets to be processed is unknown. The MAXLOGS keyword can help you prevent a problem that could result from processing an excessive number of log data sets.

    The MAXLOGS keyword works differently, depending on how you specify the value:

  • bmcJobname : boolean

    You can use the JOBNAME keyword on the ANALYZE control statement to specify one or more JOBNAMEs. Each JOBNAME (one to eight characters) identifies a Job name. Log Analyzer uses the JOBNAME when determining which dli log data sets to use as input.
    To process log records for all Job names that are associated with the input RECON data set (or data sets), specify JOBNAME=ALL.
    If you omit the JOBNAME sub-keyword, Log Analyzer uses the default value ALL.
    Note:

    • If you specify the DLILOGS keyword, you cannot specify the JOBNAME keyword. The JOBNAME keyword applies only if Log Analyzer is reading RECON data sets to determine which log data sets to process.
    • Log Analyzer will process all the jobs in the DLILOGs that get selected by the JOBNAME filter.
    • To later filter the report by job name, use the JOB sub-keyword of the APPCHECK report.

  • cfaImsids
      Array / List of Nested Object
    • imsid : String
  • bmcRecon : boolean

    You can use the RECON keyword on the ANALYZE control statement to specify the names of a set of RECON data sets to examine during the CFA job.

    If you want CFA to examine multiple sets of RECON data sets, you must specify each set with a separate RECON keyword.

    If you specify the RECON keyword, your user ID must have Security Access Facility (SAF) READ access to the RECON data sets.

    You can specify from one to three data set names. One of the specified data set names must be designated as COPY1 by IMS.

    Example:
    The RECON data sets for the IMSA system are named IMSA.RECON1 and IMSA.RECON2, and the RECON data sets for the IMSB system are named IMSB.RECON1 and IMSB.RECON2. To examine IMSA and IMSB RECON data sets in the CFA job, specify the following keywords on the ANALYZE control statement:
    RECON=(IMSA.RECON1, IMSA.RECON2)
    RECON=(IMSB.RECON1, IMSB.RECON2)
    Note:
    If you specify the RECON keyword, you must specify the INTERVAL control statement with a START time value and a STOP time value.

  • bmcTimezone : boolean
    You can use the TIMEZONE keyword on the ANALYZE control statement to specify how time values are interpreted when you are specifying time input values and when CFA is displaying time values in reports and on panels.
    Note:
    The default is TIMEZONE=LOCAL.
  • bmcStartInterval : boolean

    You can use the START keyword on the INTERVAL control statement for the following purposes:

    • Specify the beginning a range of log records to identify as candidates for the record selection process.
    • Control the beginning of range of log data sets to allocate from RECON information.
    • Reduce the overall number of log records that are selected from input SLDS or extract files.

  • bmcStopInterval : boolean

    You can use the STOP keyword on the INTERVAL control statement for the following purposes:
    � Specify the end of a range of log records to identify as candidates for the record selection process
    � Control the end of range of log data sets to allocate from RECON information
    � Reduce the overall number of log records that are selected from input SLDS or extract files

  • start
      Nested Object
    • value : String
    • startDate : String
    • startlogSeq : String
  • stop
      Nested Object
    • value : String
    • stopDate : String
    • stoplogSeq : String
  • tz
      Nested Object
    • value : String
    • timezoneoffset : String
  • jobInclude : String
  • jobExclude : String
  • psbInclude : String
  • psbExclude : String
  • maxlogsRc : String

    If you specify a value from 1 through 999 followed by literal R and a return code (08 through 99), Log Analyzer issues the specified return code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the return code at the conclusion of the RECON analysis phase without reading any input log data sets.

    Example:

    If you want Log Analyzer to issue return code 16 and terminate the job step if more than 10 log data sets would be read, specify the following keyword on the ANALYZE control statement:

    MAXLOGS=(10,R16)

  • maxlogsAbend : String

    If you specify a value from 1 through 999 followed by an abend code (1 through 4095), Log Analyzer issues a user abend code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the user abend at the conclusion of the RECON analysis phase without reading any input log data sets.

    Example:

    If you want Log Analyzer to issue a user abend, with abend code U4000, if more than 120 log data sets would be read, specify the following keyword on the ANALYZE control statement:

    MAXLOGS=(120,4000)

  • bmcJobInc : boolean
    This OPTION includes information for BMP jobs with the specified job names and omits information for all other jobs that CFA finds in the input logs.
  • bmcJobExc : boolean
    This OPTION omits information for BMP jobs with the specified job names and includes information for all other jobs that CFA finds in the input logs. For jobName, specify the name of each job to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %)
  • bmcPsbInc : boolean
    This OPTION includes information for BMP jobs with the specified PSB names and omits information for all other BMP jobs that CFA finds in the input logs
  • bmcPsbExc : boolean
    This OPTION omits information for BMP jobs with the specified PSB names and includes information for all other BMP jobs that CFA finds in the input logs. For psbName, specify the name of each PSB to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %)
  • bmcChkfreq : boolean
    You can use the CHKFREQ subkeyword in an APPCHECK expression to filter the information in the Application Checkpoint report, based on checkpoint frequency.
  • bmcThresh : boolean
    You can use the THRESH subkeyword in an APPCHECK expression to specify the time unit to use for the threshold value in a checkpoint frequency filter. Valid values are MIN (minutes) and SEC (seconds). If you omit the THRESH subkeyword, CFA uses the default value MIN.
  • bmcPrilog : boolean

    You can use the PRILOG keyword on the ANALYZE control statement to specify the logs type associated with the input RECON data set (or data sets) to use as input to the analysis process.
    You can select one of the following values:

    • SLDS - Process SLDS associated with the input RECON data set (or data sets).
    • DLI - Process DLI datasets associated with the input RECON data set (or data sets).
    • BOTH - Process SLDS and DLI datasets associated with the input RECON data set (or data sets).
    Note:
    • If you omit the PRILOG option, Log Analyzer uses the default value SLDS.
    • If you select the SLDS keyword, you cannot specify the PRILOG keyword. The PRILOG keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.

  • bmcAppcheck : boolean
    You can use the APPCHECK keyword on the REPORTS control statement to control production of the Application Checkpoint report.
  • bmcAll : boolean
    To produce the Application Checkpoint report with default filters, specify APPCHECK=ALL. With this keyword, CFA includes all batch message processing (BMP) jobs that are found in the input logs, and does not filter the information by checkpoint frequency.
  • bmcLsec : boolean
    You can use the LSEC subkeyword in an APPCHECK expression to display the LUOW information with job duration of less than a second for jobs in the Application Checkpoint report.
  • chkfreqval : String
  • bmcPlanInc : boolean
    This OPTION includes information for batch jobs with the specified Plan names and omits information for all other batch jobs that CFA finds in the input logs.
  • planInclude : String
  • bmcPlanExc : boolean
    This OPTION omits information for batch jobs with the specified Plan names and includes information for all other batch jobs that CFA finds in the input logs. For PlanName, specify the name of each Plan to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %).
  • planExclude : String
  • bmcSortby : boolean
    You can use the SORTBY subkeyword in an APPCHECK expression to sort the information in the Application Checkpoint report, based on either checkpoint frequency or start time.
  • bmcCsv : boolean
    You can use the CSVRPT subkeyword to create output file in CSV form. Log Analyzer writes the CSV reports to SYSOUT-type data sets.
  • bmcFullreport : boolean
    View Full report shows CSV file in MS excel application.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.