Keywords

The syntax for specifying keyword options is free format and keyword-oriented.

Any number of blanks, commas, slashes, or parentheses can be interspersed in the text between keywords to improve readability; they are ignored during request processing. The equal sign between keyword and operand is optional, but is recommended to improve readability.

The keywords define a timer request function. The following table describes each function and the keywords that are used. The table is an index to the tables that follow. Each table groups the keywords by function, lists the keywords alphabetically, defines applicable operands, and describes what the keyword does.

Keyword summary

Table title

Keywords

Keywords to Define Requests

BLK

MOD

PRG

REQ

Keywords to Define Request Activation

INTERVALI

RST

START

STOP

STOPCNT

TARGET | TGT

Keywords to Define Warnings (monitors only)

WIF

WIN

WLIM

WMAX | WVAL

WMSG

Keywords to Define Special Options

LOG

PLOTMAX

QIS

RANGES

TITLE | T

Keywords to Define Application Trace Parameters

GROUPEIP

LOGTRAC

STORAGEST

TRBUFF

TRSIZE

TYPE

WRAP

Keywords to Define Workload Selection Criteria for Application Trace and Workload Monitors

CLASS is valid for Workload Monitors only.

AND logic is used for keywords. OR logic is used for keyword operands.

CLASS PROG

TRAN TERM

USERID XPROG

XTRAN XTERM

XUSERID

Keywords to Define Trace Logging for Application Trace

TRARCSTC

TRCYL

TRDISP

TRDSN

TRNUMDS

TRREUSE

TRSMSDCL

TRSMSMCL

TRSMSSCL

TRSWTIME

TRSUFFIX

TRVOLS

Keywords to Define Exception Filters for Application Trace

ABORT

CTRVOLSICS4GL

CICSFILE

CICSMQQN

CPU

DB2C

DBRC

DBRQ

DBRQC

DBRT

ELAP

FCCAL

FCWT

FCWTC

IRWT

IRWTC

MQTC

MQTT

PLAN

PSB

SHWM

SHWME

STGOE

SUST

USTGO

XCWT

XCWTC

Keywords to define requests

Keyword

Operand

Description

Service

BLK

n/a

identifies a member in BBPARM that contains predefined service requests

All

mname

is a member name in BBPARM

RRR

resets all requests according to their RST options

This operand is the same as starting CICS after the requests were quiesced. This operand could be used at midnight to reset statistics for daily monitors.

SSS

is used internally to start services at CICS startup

ZZZ

is used internally to quiesce services at CICS shutdown

MOD

reqid

modifies an existing request

All

PRG

n/a

purges existing request or requests (frees the request block)

All

reqid

purges a single request

ALL

purges all existing requests if the user is authorized

REQ

reqid

defines a new request

All

Keywords to define request activation

Keyword

Operand

Description

Service

INTERVAL | I

hh:mm:ss

specifies the time interval between successive invocations of the requested service

The default is one minute (00:01:00) or as specified by the user in the BBIISP00 member of the BBPARM data set.

It can be used with the LOG keyword to request automatic logging of a display to the BBI-SS PAS Image log.

All

RST

 

defines the restart option to be used when a service is quiesced because of an inactive CICS region or BLK=RRR request

The default is HOT.

All

HOT

restarts the service automatically without the loss of history data

The intervals during which CICS was terminated show values of zero.

COLD

restarts the service automatically (all previously collected data is deleted)

PUR

purges the service automatically when the target CICS starts

QIS

keeps the service in a quiesced state until it is purged by an authorized user

START

hh:mm:ss

requests processing start time

If the time specified is more than 10 minutes prior to the current time, 24 hours are added to the specified time and the request is started the next day. To start a request at midnight, specify 24:00:00.

The default is the next full minute.

All

STOP

nnn

requests processing duration in minutes

All

hh:mm:ss

requests processing stop timeIf the time specified is the same as the START time, 24 hours are added to the STOP time.Processing ends at the end of the last interval before the specified stop time. This time is displayed in the STOP field when the request is viewed with the R, P, M, and W line commands.

STOPCNT

n

specifies the number of intervals to be processed

Requests that have completed processing without collecting history data are purged.

The default is no limit. Requests are processed until stopped or purged or until the BBI-SS PAS is terminated.

TARGET | TGT

id

specifies a 1- to 8-character CICS region identifier

TARGET is used to override the default target CICS region identified in the TGT field.

(MainView AutoOPERATOR must be installed.) TARGET is required if the IMFC command is used in a MainView AutoOPERATOR EXEC to request monitor services. A message is issued to the BBI-SS PAS Journal log if this keyword is not coded in the request.

All

Keywords to define warnings (monitor services only)

Keyword

Operand

Description

Service

WIF

n

defines the number of times the exception is to be detected before the first message is sent

The default is 1.

Monitors

WIN

n

defines the number of times the exception is to be detected between messages

The default is 1.

Monitors

WLIM

n

  • defines the maximum number of warning messages to be sent for one continuous occurrence of the warning condition

  • resets automatically when condition no longer exists

The default is 10.

Monitors

WMAX | WVAL

n | <n

specifies a warning threshold

The warning condition exists if the current data measurement exceeds the defined threshold. If <n is specified, a warning is issued when the sampled value is less than or equal to the threshold.

Monitors

NZ

(not zero)

issues a warning when the measured value is greater than zero

The default is 0 or no warnings.

If the service measures time, the measurement units are specified in seconds and tenths of seconds (optional).

WMSG

WTO | LOG

directs warning messages to the system console (WTO) in addition to the active BBI-SS PAS Journal log

The default is to write only to the log.

An existing warning message to the WTO can be reset to the Journal log only by using the LOG operand.

Routing and descriptor codes can be specified for WTO messages in the BBIISP00 member of the BBPARM data set.

Monitors

Keywords to define special options

Keyword

Operand

Description

Service

LOG

 

specifies if and when automatic logging occurs

Analyzer, DMON or DWARN, or PLOT displays can be logged to the BBI-SS PAS Image log. For the monitors, a PLOT of the latest data is written to the BBI-SS PAS Image log.

All

NO

indicates no logging

This operand is the default for monitor services.

ATSTOP

indicates logs are displayed when processing of this request is stopped

If QIS=Y has been specified in the request, LOG=ATSTOP is invoked at CICS termination and at BBI-SS PAS termination.

ATPD

indicates logs are displayed at each period of 10 intervals

ATINTVL

logs display at each interval as specified by the user with the INTERVAL parameter or in the BBIISP00 member of the BBPARM data set

This operand is the default for analyzers.

ATWARN

logs a plot whenever a warning message is generated by the associated monitor

NO is the default for the monitor services. ATINTVL is the default for the analyzer services.

PLOTMAX

n

specifies the maximum value for the X-axis of a PLOT graph

The minimum is 50. The specified value is adjusted to the nearest multiple of 50. Percentages displayed by some services are always set at 100.

Monitors

QIS

 

defines the action to be taken for the service when CICS is not active

All

YES

specifies that the service is to be quiesced

This operand is the default for all monitor services.

NO

specifies that the service is to start or continue running

When QIS=NO is specified, monitors that require CICS continue to be scheduled at each interval; however, they return zero values. The BBI-SS PAS Image log contains screen images of these services.

RANGES

n [,n,n,n]

specifies the distribution range of any data collection monitor service

Up to four upper-limit values can be specified. An implied limit of the maximum data measurement value is always defined internally. This information is used to produce a frequency distribution of the data measurement value at the bottom of the plot display.

If RANGES is defined, the distribution is updated at each interval with the current measurement value. A plot of the history displays this distribution.

The default is no ranges.

Monitors

TITLE | T

text

defines a service display title and the contents of a warning message (1 to 24 characters)

This user-defined title replaces the default service title.

If the title is specified in a BBPARM member as a series of requests, it must be enclosed in single quotation marks.

Application Trace

Keywords to define application trace parameters

Keyword

Operand

Description

Service

GROUPEIP

Y | N

identical EIP calls are grouped into one call for detail traces to reduce buffer storage usage

Application Trace

LOGTRAC

N | Y

Y writes all trace records for this request to a unique trace log data set (TLDS) for this trace.

The default is N.

If Y is specified with no additional summary or detail trace logging options, a single data set is dynamically allocated using the defaults specified in CMRBEX00 for this CICS.

Application Trace

STORAGE | ST

nnnK

size of the BBI-SS PAS display buffer to be used by the Application Trace service

The default is obtained from member IMFISP00/BBIISP00 of the BBPARM data set.

Application Trace

TRBUFF

nnn

number of trace buffers to allocate

The default is obtained from member CMRBEX00 of the BBPARM data set.

Application Trace

TRSIZE

nnnK

size of trace buffer to use

The default is obtained from member CMRBEX00 of the BBPARM data set.

Application Trace

TYPE

S | D

S requests a summary application trace of completed transactions

D requests a detail application trace that collects major events in the life of the transaction, including all exception events. The default is a summary trace.

Application Trace

WRAP

YES | NO

determines trace data wrap in the BBI-SS PAS buffer

The default is YES; new data overlays oldest data. NO stops the trace when the buffer is full. MOD=ATRAC, WRAP=YES resumes the trace.

Application Trace

Keywords to define workload selection criteria

Keyword

Operand

Description

Service

CLASS

nn

qualifies workload monitor data collection by the class (0-10) in which the transaction executed (not valid for a workload trace request)

Blank collects data for all classes.

Workload Monitors

PROG

program name

qualifies a workload trace or monitor data collection by the program used to process the task

Application TraceWorkload Monitors

TRAN

id

qualifies a workload trace or monitor data collection by the transaction ID used to process the task

Application TraceWorkload Monitors

TERM

id

qualifies a workload trace or monitor data collection by the terminal ID used to process the task

A 1- to 4-character CICS terminal ID or a 1- to 8-character VTAM ID can be specified.

Application TraceWorkload Monitors

USERID

id

qualifies a workload trace or monitor data collection by the user ID used to process the task

A 1- to 3-character CICS OPID or a 1- to 8-character user ID can be specified.

Application TraceWorkload Monitors

XPROG

program name

excludes a workload trace or monitoring by the program name used to process the task

Application TraceWorkload Monitors

XTRAN

id

excludes a workload trace or monitoring by the transaction ID used to process the task

Application TraceWorkload Monitors

XTERM

id

excludes a workload trace or monitoring by the terminal ID used to process the task

A 1- to 4-character CICS terminal ID or a 1- to 8-character VTAM ID can be specified.

Application TraceWorkload Monitors

XUSERID

id

excludes a workload trace or monitoring by the user ID used to process the task

A 1- to 3-character CICS OPID or a 1- to 8-character user ID can be specified.

Application TraceWorkload Monitors

Keywords to define trace logging

Keyword

Operand

Description

Service

TRARCSTC

name

name of the started task (STC) to be initiated to archive data sets for this trace

The default is no archive STC.

Application Trace

TRCYL

n

primary allocation in cylinders for trace log data sets

The default value specified in CMRBEX00 with the TRCYL keyword is 3.

Application Trace

TRDISP

NEW | OLD

status of the data sets

NEW (default) indicates none of the data sets exist. All the data sets are allocated when the trace request is processed. If any of the data sets cannot be allocated, the trace request fails, and the data sets that were successfully allocated are deleted.

OLD indicates all the data sets exist and are valid trace data sets. Existing data will be overlaid.

If your user authorization specifies TRALLOC=NO, only OLD will be accepted.

Application Trace

TRDSN

name.V01

name of the first log data set

It must end in .V01. The default name is generated if this keyword is omitted and TRDISP=NEW.

If the keyword value has quotation marks, the name is used as specified. If quotes are not used, the TRPREFIX value specified in CMRBEX00 for this CICS region is added in front of the value supplied. If TRPREFIX was not specified, the ID of the user requesting the trace is used.

If TRDSN= is specified without LOGTRAC=, LOGTRAC=Y is assumed.

Application Trace

TRNUMDS

n

number of trace log data sets to be used for this trace

The default is 1. If TRNUMDS= is specified without LOGTRAC=, LOGTRAC=Y is assumed.

Application Trace

TRREUSE

Y | N

indicates whether to overwrite a log data set that has not been reset

The default is Y.

Application Trace

TRSMSDCL

name

name of the SMS Data Class to be used when allocating this trace data set

The default is specified in CMRBEX00 with the TRSMSDCL keyword.

Application Trace

TRSMSMCL

name

name of the SMS Management Class to be used when allocating this trace data set

The default is specified in CMRBEX00 with the TRSMSMCL keyword.

Application Trace

TRSMSSCL

name

name of the SMS Storage Class to be used when allocating this trace data set

The default is specified in CMRBEX00 with the TRSMSSCL keyword.

Application Trace

TRSWTIME

hh:mm

time at which an automatic log switch from the current log to the next log will occur

Application Trace

TRSUFFIX

c...

suffix to be appended to the cluster data set name to make the name of the data component

The default value specified in CMRBEX00 with the TRSUFFIX keyword is D.

Application Trace

TRVOLS

(x,y...)

volumes to use when allocating a trace log data set

You can specify up to seven volumes. The default value specified in CMRBEX00 with the TRVOLS keyword is SYSDA.

Parentheses are required to specify multiple volumes.

Application Trace

Keywords to define exception filters for application trace

Keyword

Operand

Description

Service

ABORT

Y | N

selects only the transactions that have abended

Application Trace

CICS4GL

name

qualifies a trace by a 1- to 8-character 4GL name

Application Trace

CICSFILE

name

qualifies a trace by a 1- to 8-character file name

Application Trace

CICSMQQN

name

qualifies a trace by a 1-48 character queue name

Application Trace

CPU

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by transaction CPU time

Application Trace

DB2C

nnn[K] | <nnn[K]

qualifies a trace by the number of DB2 SQL and IFI calls

Application Trace

DBRC

nnn[K] | <nnn[K]

qualifies a trace by the number of other database calls, which includes DB2 and MQ, but not DBCTL

Application Trace

DBRQ

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by DBCTL I/O time

Application Trace

DBRQC

nnn[K] | <nnn[K]

qualifies a trace by the number of DBCTL I/O waits

Application Trace

DBRT

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by other database calls, which includes DB2 and MQ, but not DBCTL

Application Trace

ELAP

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by transaction response time

Application Trace

FCCAL

nnn[K] | <nnn[K]

qualifies a trace by the number of File Control calls

Application Trace

FCWT

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by File Control I/O time

Application Trace

FCWTC

nnn[K] | <nnn[K]

qualifies a trace by the number of File Control I/O waits

Application Trace

IRWT

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by interregion wait time

Application Trace

IRWTC

nnn[K] | <nnn[K]

qualifies a trace by the number of interregion waits

Application Trace

MQTC

nnn[K] | <nnn[K]

qualifies a trace by the number of WebSphere MQ queue accesses

Application Trace

MQTT

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by WebSphere MQ queue total elapsed time

Application Trace

PLAN

name

qualifies a trace by a 1- to 8-character DB2 plan name

Application Trace

PSB traces

name

qualifies a trace by a 1- to 8-character PSB name

Application Trace

SHWM

nnn[K] | <nnn[K]

qualifies a trace by the DSA storage high-water mark

Application Trace

SHWME

nnn[K] | <nnn[K]

qualifies a trace by the EDSA storage high-water mark

Application Trace

STGOE

nnn[K] | <nnn[K]

qualifies a trace by EDSA storage occupancy

Application Trace

SUST

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by transaction suspend time

Application Trace

USTGO

nnn[K] | <nnn[K]

qualifies a trace by DSA storage occupancy

Application Trace

XCWT

hh:mm:ss | ss | <hh:mm:ss | <ss

qualifies a trace by File Control exception wait time

Application Trace

XCWTC

nnn[K] | <nnn[K]

qualifies a trace by the number of File Control exceptions

Application Trace

Was this page helpful? Yes No Submitting... Thank you

Comments