Statements/parameters for BLSCUSER, BLSCECT, and embedded parmlib members

Note: These statements and their parameters can be used in the BLSCUSER member, the BLSCECT member, and all parmlib members embedded in these members.
CTRACE statement
Enables components to collect CTRACE data without necessarily registering, get the data into an unformatted dump, and have the IPCS subcommand "CTRACE COMP(component-name)..." accepted to locate the component's CTRACE data in a dump.
COMPONENT(component-name)
Specifies the name of the component.
FORMATTABLE(table-epname)
Specifies the entry point of the format table containing the component-supplied find routine.
ENVIRONMENT(ALL)
ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that IPCS should support the data type in environments that exploit freeway architecture and those that do not.
DATA statement
Associates specific types of areas or structures with an exit routine, a model, or a group of areas or structures. Use one DATA statement for each type of data specification. For information about the exit routines, see z/OS MVS IPCS Customization.
AREA(namelist)
STRUCTURE(namelist)
Identifies one or more names of areas or structures. Each name in the namelist is 1 to 31 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase. Separate names with blanks or commas, or in other ways used in TSO/E commands.
FIND(epname)
Specifies the name of the entry point in a find exit routine that is used to locate the data types within this group. (See the description of the GROUP parameter.) See the find exit routine in z/OS MVS IPCS Customization.

The epname is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

FORMAT(name[,level])
Specifies the name of the control block formatter exit routine to be used to format the data types within this group. See the control block formatter exit routine in z/OS MVS IPCS Customization.

The name is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

The level is a function systems mode ID (FMID), which indicates a version and release of the MVS™ system and which associates the formatter with that level application programming interface (API) support. The level option may be specified as one of the following values:
  • JBB2125 indicates that the formatter expects the structure that it formats will reside in 31-bit virtual or real storage, storage that can be described without the use of BLSRESSY structures.
  • HBB3310 indicates that the formatter expects the structure that it formats will reside in 31-bit storage. The description may be provided by one or more 31-bit BLSRESSY structures or using the JBB2125 API.
  • HBB7703 indicates that the formatter expects the structure that it formats will reside in 64-bit storage. The description may be provided by one or more 31-bit or 64-bit BLSRESSY structures or using the JBB2125 API.

Default: HBB3310

PROCEDURE(procname)
An alternative data definition to FORMAT that specifies the designated data type. FORMAT and PROCEDURE are mutually-exclusive keywords. When the CBFORMAT subcommand or service routine is asked to format the designated data type during the session, issue the procedure command with the syntax: %procname X.
GROUP(groupname)
Specifies the name of a control block group, such as RBs and UCBs. Pointers in other control blocks (such as TCBs) may address one of these blocks, and IPCS may need to record the existence of the block in the dump directory before it is determined whether the block is, in fact, a PRB instead of another type of RB or a UCBTAPE instead of another type of UCB.

The groupname specifies the type of control blocks to be associated with each type of data being defined by this DATA statement. Do not reference an area or structure as a groupname if the AREA or STRUCTURE parameter references another group data type. If an attempt is made to establish such a relationship, IPCS will detect an error, and the group data type associated with the explicitly-referenced group will be used instead.

The groupname is 1 to 31 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

MODEL(modelname)
Specifies a model to format data types within this group. See format models in z/OS MVS IPCS Customization.

The modelname is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

SCAN(scanname[,level])
Specifies the name of a scan routine that is to verify each instance of a data type in this group. See the scan exit routine in z/OS MVS IPCS Customization.

The scanname is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

The level is a function systems mode ID (FMID), which indicates a version and release of the MVS. The level option may be specified as one of the following values:
  • Omission of level indicates that the scan routine expects the structure that it scans will reside in 31-bit storage. The description will be provided to the scan routine by a 31-bit BLSRSASY structure, and the results of the scan should be returned in that format.
  • HBB7703 indicates that the scan routine expects the structure that it scans will reside in 64-bit storage. The description will be provided to the scan routine by a 64-bit BLSRSASY structure, and the result of the scan should be returned in that format.
    Note: The BLSRSASY structure passed to a scan routine contains a field that indicates whether it is in 31-bit or 64-bit format. If a scan routine needs to be written for use with the HBB7703 API as well as the earlier API, it can use this information to determine the format of the BLSRSASY structure.
ENVIRONMENT(ALL)
ENVIRONMENT(IPCS)
ENVIRONMENT(SNAP)
ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that IPCS should support the data type in IPCS and SNAP environments and in environments that exploit freeway architecture and those that do not.

Default Value: ALL

DIALOG statement
Specifies an analysis dialog that a user may select from the IPCS MVS Dump Component Data Analysis panel of the IPCS dialog. See option 2.6 in the z/OS MVS IPCS User's Guide.
NAME(dialogname)
Specifies the name for the analysis dialog. The dialogname is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase. Each dialogname must be unique. It must not duplicate another dialog name on a DIALOG statement or a verb name on an EXIT statement specified in BLSCECT and its embedded parmlib members.
ABSTRACT(‘text’)
Specifies text to appear on the IPCS MVS Dump Component Data Analysis panel. The text describes the analysis dialog processing.
The format of the line displayed on the panel is:
dialogname - text

The text is 1 to 60 alphabetic characters and must be enclosed in single quotation marks. Uppercase and lowercase letters are accepted; both cases are shown on the panel.

PARM(‘text’)
Specifies data to be passed to the ISPF SELECT service when the analysis dialog is active. The text is 1 to 32,767 alphanumeric characters and must be enclosed in single quotation marks. Lowercase alphabetic characters are accepted and treated as uppercase.
ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that IPCS naming conventions for symbols should apply in environments that exploit freeway architecture and those that do not.
END statement
Ends processing of an embedded parmlib member. Any statement following an END statement in an embedded parmlib member is not processed. Processing of the member containing the IMBED statement continues.

If a parmlib member contains a CLIST, the system considers the CLIST as part of the member. If a CLIST generates an END statement, the CLIST generating the END statement, any other CLIST invoked by the currently embedded member, and the currently embedded member are ended.

An END statement is useful to prevent processing of a block of statements that you want IPCS to ignore for the time being.

EXIT statement
Specifies an exit routine. The user can invoke the exit routine during IPCS processing by a subcommand:
  • By an ANALYZE subcommand if ANALYZE is specified
  • By an ASCBEXIT subcommand if ASCB is specified
  • By a CBSTAT STRUCTURE(name) subcommand if CBSTAT(name) is specified
  • By a TCBEXIT subcommand if TCB is specified
  • By a VERBEXIT verbname subcommand if VERB(verbname) is specified
The ABSTRACT, HELP, and PARM parameters tell IPCS how to make the component analysis from your exit routine available through the IPCS dialog.
EP(pgmname[,level])
The pgmname option specifies the name of the entry point for the exit routine. The pgmname is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @).
The level is a function systems mode ID (FMID), which indicates a version and level of the MVS system. The level option pertains to CBSTAT and post-formatting exits and may be specified as one of the following values:
  • Omission of level indicates that the scan routine expects the structure of interest will reside in 31-bit storage. The description will be provided by a 31-bit structure.
  • HBB7703 indicates that the routine expects the structure of interest will reside in 64-bit storage. The description will be provided by a 64-bit structure.
Note: The structure passed contains a field that indicates whether it is in 31-bit or 64-bit format. If a routine needs to be written for use with the HBB7703 API as well as the earlier API, it can use this information to determine the format of the structure.
ANALYZE
Specifies that IPCS invoke the exit routine during contention analysis in response to an ANALYZE subcommand. The system invokes the ANALYZE exit routines in the order they are specified in BLSCECT and its embedded parmlib members. See the ANALYZE exit routine in z/OS MVS IPCS Customization.

If VERB(verbname) is also specified, the exit routine will also be invoked by the VERBEXIT verbname subcommand. If ABSTRACT is also specified, the exit routine will also be invoked through the IPCS MVS Dump Component Data Analysis panel of the IPCS dialog.

In the following example, the exit routine analyzes GRS ENQ contention.
EXIT EP(ISGDCONT) ANALYZE
ASCB
Specifies that IPCS invoke the exit routine when an ASCBEXIT subcommand is entered. The system invokes the ASCB exit routines in the order they are specified in BLSCECT and its embedded parmlib members. See the ASCB exit routine in z/OS MVS IPCS Customization.

If VERB(verbname) is also specified, the exit routine will also be invoked by the VERBEXIT verbname subcommand.

CBSTAT(name)
Specifies that IPCS invoke the exit routine when a CBSTAT STRUCTURE(name) subcommand is entered and, for CBSTAT exit routines associated with units of work, when an ANALYZE subcommand is entered for the unit of work. See the ANALYZE and CBSTAT exit routines in z/OS MVS IPCS Customization.

The name is 1 to 31 alphanumeric characters and must begin with an EBCDIC letter (A-Z). Lowercase alphabetic characters are accepted and treated as uppercase.

This example is for a RTM ASCB status exit.
EXIT EP(IEAVTRCA) CBSTAT(ASCB)
FORMAT(name)
Specifies that IPCS invoke the exit routine when the following are entered:
  • A SUMMARY subcommand
  • A CBFORMAT subcommand with an EXIT parameter and a STRUCTURE(cbname) parameter.

See the post-formatting exit routine in z/OS MVS IPCS Customization.

For the SUMMARY subcommand, the system invokes the FORMAT exit routines in the order they are specified in BLSCECT and its embedded parmlib members.

The name is 1 to 31 alphanumeric characters and must begin with an EBCDIC letter (A-Z). Lowercase alphabetic characters are accepted and treated as uppercase.

TCB
Specifies that IPCS invoke the exit routine when a TCBEXIT subcommand is entered. The system invokes the TCB exit routines in the order they are specified in BLSCECT and its embedded parmlib members. See the TCB exit routine in z/OS MVS IPCS Customization.

If VERB(verbname) is also specified, the exit routine will also be invoked by the VERBEXIT verbname subcommand.

The following example provides COMM TASK TCB exit for WTORs.
EXIT EP(IEAVG701) CBSTAT(TCB)
VERB(verbname)
Specifies that IPCS invoke the exit routine when a VERBEXIT verbname subcommand is entered. See the verb exit routine in z/OS MVS IPCS Customization.

If ANALYZE, ASCB, or TCB is also specified, the exit routine will also be invoked by the ANALYZE, ASCBEXIT, or TCBEXIT subcommand.

The verbname is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase. Each verbname must be unique. It must not duplicate another verb name on an EXIT statement or a dialog name on a DIALOG statement specified in BLSCECT and its embedded parmlib members.

To specify more than one verbname for the same EP pgmname, code a separate EXIT statement for each verbname.

The following example specifies a VERBEXIT VLFDATA subcommand, which will analyze VLF control blocks.
EXIT EP(IGVSFMAN) VERB(VLFDATA)
ABSTRACT(‘text’)
Specifies text to appear on the IPCS MVS Dump Component Data Analysis panel. The text describes the exit routine processing. Specify this parameter when VERB is also specified.
The format of the line displayed on the panel is:
verbname - text

The text is 1 to 60 alphabetic characters and must be enclosed in single quotation marks. Uppercase and lowercase letters are accepted; both cases are shown on the panel. If an exit routine is invoked by multiple verb names, the first verb name associated with the exit in the parmlib member(s) is used on the panel.

AMASK(X'00FFFFFF' | X'7FFFFFFF')
Specifies a logical AND mask. The exit routine uses the mask when it passes storage addresses to the dump access service. Any TSO/E INTEGER specification equivalent to these values is accepted. A TSO/E integer may be specified as decimal, hexadecimal, or binary. Hexadecimal is recommended.

The following example is for VTAM®.

EXIT EP(VTAMMAP) AMASK(X'00FFFFFF')

Default Value: X'7FFFFFFF'

ENVIRONMENT(ALL)
ENVIRONMENT(IPCS)
ENVIRONMENT(SNAP)
ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that IPCS should support the data type in IPCS and SNAP environments and in environments that exploit freeway architecture and those that do not.

Default Value: ALL

HELP(name)
Specifies the name of the help panel that is to be displayed when a user enters a question mark in the selection field of a exit selection panel in the IPCS dialog. The help panel should be an online description of the content of the report generated by the exit routine. Specify this parameter when ABSTRACT is also specified.

The name is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

PARM(‘text’)
Specifies a parameter that IPCS is to pass to the exit routine when it is invoked from the IPCS MVS Dump Component Data Analysis panel. Specify this parameter when ABSTRACT is also specified.

The text is 1 to 32,767 alphanumeric characters and must be enclosed in single quotation marks. Mixed upper and lowercase alphabetic characters will be accepted and passed as is to the routine.

IMBED statement
Embeds other parmlib members. The embedded parmlib members can embed additional parmlib members.
MEMBER(membername)
Specifies the name of the parmlib member that IPCS should process before the processing of the current parmlib member is resumed.

The membername is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.

REQUIRED
Specifies that IPCS treat a failure to locate the parmlib member as an error. If you omit the REQUIRED parameter, IPCS accepts failure to locate the member and issues no messages.
ENVIRONMENT(IPCS)
ENVIRONMENT(SNAP)
ENVIRONMENT(ALL)
Specifies that IPCS should support exit routines in the parmlib members in an IPCS or SNAP environment or in both. For an ABEND or SNAP dump to be processed correctly, specify ALL.

Default Value: IPCS

NOTE statement
Transmits messages to the terminal, to FILE(IPCSPRNT), or to both. The statement is a problem determination aid for construction and maintenance of parmlib members that are embedded in BLSCECT and in members embedded in BLSCECT.

NOTE statement syntax is identical to the syntax of the IPCS NOTE subcommand.

PANDEF statement
Specifies an input panel or help panel that is to be displayed in the IPCS dialog.
In the parameters on the PANDEF statement, each name is 1 to 8 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.
SUBCOMD(CTRACE)
Specifies the name of the IPCS subcommand with which the panel is to be associated; only the CTRACE subcommand supports the PANDEF statement.
COMPONENT(component name)
Specifies the name of the component that defines the options to be captured (input panel) or explained (help panel).
INPUT(panel name)
Specifies the name of the input panel used to obtain user specifications of component-specific options.
HELP(panel name)
Specifies the name of the help panel displayed to describe component-specific options to the user.
ENVIRONMENT(ALL)
ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that IPCS should support the data type in environments that exploit freeway architecture and those that do not.
SYMBOL statement
Defines a group of special symbols to IPCS.
PREFIX(prefixname)
Specifies the initial characters, prefixname, for a group of special symbols, such as ASCBnnnnn, TCBnnnnnaaaaa, UCBxxxx, or ASTnnnnn.
The prefixname is 1 to 30 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are treated as uppercase. The number of characters allowed in the prefixname depends on the associated suffix:
SUFFIX Value Maximum Prefix Length
COUNT0 1 to 26 characters
COUNT1 1 to 26 characters
COUNT1NAME 1 to 25 characters
CPU 1 to 29 characters
DUALCOUNT 1 to 21 characters
NAME No longer than 31 characters minus the length of the prefix
UNIT 1 to 26 characters
SUFFIX(suffix)
Specifies the syntax requirements for the final characters for a group of special symbols. The values for the suffix are:
COUNT0
Specifies a decimal suffix of 0 - 99999. An example is the suffix of 0 in the symbol AST0.
COUNT1
Specifies a decimal suffix of 1 - 99999. Some examples are the suffixes of 5 in the symbol ASCB5 and of 534 in ASXB534.
COUNT1NAME
Specifies a suffix of a decimal number of 1 - 99999 plus a name. The name consists of alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, @, #). An example is the suffix of 75PSFA in the symbol WTRFSCB75PSFA.
CPU
Specifies a suffix of a decimal number of 0 - 99. Some examples are the suffixes of 0 in the symbol LCCA0, of 15 in PCCA15, and of 7 in PSA7.
DUALCOUNT
Specifies a suffix of 2 numbers:
  • First, a decimal number of 1 - 99999
  • Second, a number of 1 - 5 EBCDIC letters (A-Z), which is a base-26 value in which leading A's may be omitted.

Some examples are the suffixes of 34C in the symbol JSABA34C, of 1A in PGT1A, and of 5F in TCB75F.

NAME
Specifies a suffix that is a name. The name consists of 1 or more alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, @, #). An example is the suffix of ABC in the symbol JOBABC.
UNIT
Specifies a suffix of a hexadecimal number of 0-1FFFF and is intended to be a device number. An example is the suffix of 01D0 in the symbol UCB01D0.
NAME(name)
Specifies the complete name of the symbol. The name is 1 to 30 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, @, #). Lowercase alphabetic characters are accepted and treated as uppercase.

Examples are: CVT, GDA, or PRIVATE.

AREA(name)
STRUCTURE(name)
Specifies the data type for the symbol. The name is 1 to 31 alphanumeric characters and must begin with an EBCDIC letter (A-Z) or national character ($, #, @). Lowercase alphabetic characters are accepted and treated as uppercase.
This parameter allows an IPCS user to enter a shortened version of a command. For example, an IPCS user can enter:
list cvt
This subcommand is the same as:
list cvt structure(cvt)
ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that IPCS name conventions for symbols should apply in environments that exploit freeway architecture and those that do not.
SYSDDIR dsname statement
Identifies the name of the data set for the sysplex dump directory. The dsname must be fully qualified. The name can be specified with or without apostrophes enclosing it.

Default: SYS1.DDIR

ENVIRONMENT({ESAME|ZARCHITECTURE})
ENVIRONMENT(ESA)
Specifies that the same sysplex dump directory is used by systems that exploit freeway architecture and those that do not.
TSO command statement
Invokes a TSO/E command, CLIST, or REXX exec during the processing of the parmlib member. TSO statement syntax is identical to the syntax of the IPCS TSO subcommand.

Use the TSO statement when the TSO/E command, CLIST name, or REXX exec name duplicates the name of a BLSCUSER statement. A TSO/E command with a name that does not duplicate a BLSCUSER statement name can be specified without TSO before it.

A CLIST that generates BLSCUSER statements can also be specified in the parmlib member; place a percent sign (%) before the CLIST name.

TSO/E commands and REXX execs may use the TSO/E stack to leave BLSCUSER statements for processing after the command or exec ends processing.

TSO/E commands supplied with IPCS, IPCS primary commands and IPCS subcommands try to lighten this burden in two ways: Some keywords that you tend to use often, e.g. CHARACTER, support explicit, short aliases, C in this case. All keywords can be truncated, entering just enough of their characters to make what you have entered unambiguous. For example, LENGTH is a keyword accepted on many subcommands. Entering LEN instead of LENGTH is currently unambiguous on them all. If you are composing a command procedure that you hope will remain useful for a long time, do not truncate keywords in it. As IPCS responds to new demands, new keywords can be introduced that make truncations ambiguous. Support for truncation is solely intended to make manual entry of commands and writing command procedures intended for brief use faster and easier.