How to read resource table descriptions

Each resource class is represented by a resource table that fully describes the attributes of that resource. In this book, the information for a resource table is presented in two tables: one that describes the resource table as a whole, and one that describes the individual attributes of the resource table.

Resource table definition

The first table presented for each resource table defines the general characteristics of the resource table.

The characteristics of a resource table are:

Characteristic
Meaning
Table
The name of the managed object that this resource table describes. This name is used to identify the object in all API commands and from the batched repository-update facility.
Description
A 1- to 30-character description of the resource table.
Length
The external length of the resource table. Start of changeThis is a fullword value whichEnd of change indicates the length of the resource table records returned in response to an API FETCH command.
Usage
Identifies the valid uses for the resource table, as one of the following:
API
It can be referenced from the CICSPlex® SM API.
Batch Utility
It can be processed using the batched repository-update facility.
EVALDEF
It can be named in a real-time analysis evaluation definition.
API View
A value of YES indicates the resource table can be referenced in an API SPECIFY VIEW command.
Object Type
The type of managed object, as one of the following:
Valid API Operations
Identifies which standard API operations (GET, SET, CREATE, UPDATE, and REMOVE) can be requested of the resource table.
Table Invalid CICSREL
For tables with an object type of CICS Definition or CICS Resource, the releases of CICS that do not support the managed object. The CICS release values are shown as follows:
E530
CICS TS for OS/390 Release 3
E620
CICS TS for z/OS Version 2 Release 2
Start of changeE630End of change
Start of changeCICS Transaction Server for z/OS, Version 2 Release 3End of change
N430
CICS for Windows component of IBM® TXSeries 4.3.0
N500
CICS for Windows component of IBM TXSeries 5.0
PARMS
For objects that require the PARM operand for standard API operations, the valid parameter values. The logical OR character (|) indicates values that are mutually exclusive.
ACTION
The valid actions for the object. For tables with an object type of CICS Resource, CICS release restrictions, if any, are also shown.
Active FEEDBACK Error Codes
The error codes that can appear in the FEEDBACK resource table when an error occurs for this object. The resource table copybooks provided for use with the API contain the actual binary value for each error code.

Resource table attribute definitions

The second table presented for each resource table defines the attributes in the resource table.

Attributes are discrete named elements that represent specific characteristics of a resource class. The attributes are presented in a tabular format that is consistent with the object type of the resource table. Different attribute characteristics may be shown based on the object type. The following list includes all the characteristic columns. The description of a characteristic indicates the object types to which the characteristic applies.

The characteristics of a resource table attribute are:

Name
A unique 1- to 12-character name, which is used to identify the attribute. If the attribute participates in the native key of the resource class, the value is shown in reverse highlighting with a numeric value appended to the end. When a resource class uses multiple attributes to identify its native key, the numeric value indicates which segment, in the range of 1 to 9, of the native key this attribute reflects.
Datatype
The data type of the values returned for this attribute. The data types identify the internal format of the data. When an attribute is accessed by the batched repository-update facility, the ISPF end-user interface, or after conversion by a REXX TPARSE API command, the data is displayed in an appropriate formatted manner. When accessed by any other API command, the attribute value is presented in its unchanged internal form. The valid data type keywords are:
Keyword
Description
ADDRESS
Storage Address. Displayed externally as a printable hexadecimal value.
AVERAGE
Average. Maintained internally as a binary value with a single implied decimal place. Displayed externally as a zoned decimal value of the form NNN.t.
AVERAGE3
Average. Maintained internally as a doubleword binary value with three implied decimal places. Displayed externally as a zoned decimal value of the form NNN.ttt.
BINARY
Binary value. Displayed externally as zoned decimal digits. The null value is binary zero.
BIT
Bit string. Maintained internally as a binary value. Displayed externally as a printable hexadecimal value.
CHAR
Character string. Maintained and displayed as the character data. The null value is blanks.
CODEDBIN
CICS coded Binary value. Displayed externally as zoned decimal digits, or a value of N/A if the value is -1.
CVDAS
CICS CVDA value. Maintained internally as an encoded binary integer. Displayed externally as a 16-character value.
CVDAT
CICS CVDA value Terminal Device Type. Maintained internally as an encoded binary integer. Displayed externally as a 16-character value.
DATETIME
Date Time Group. Maintained internally as a System/390® Store Clock value. Displayed externally as a 24-digit formatted value MT/DY/YYYY-HH:MM:SS.mmmm. When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.
Start of changeDECDATEEnd of change
Start of changeDate. Maintained internally as a 4-byte packed decimal field of the form 0CYYDDD+ where C is the century code, YY is the last two digits of the year, DD is the day number within the year, and + indicates a positive number. A century code of 0 indicates a year in the 20th century (19xx) and a century code of 1 indicates a year in the 21st century (20xx). Displayed as a character string of the form YYYY/DDD.End of change
DECIMAL
Decimal value. Maintained internally in packed decimal form. Displayed externally as zoned decimal digits.
Start of changeDECTIMEEnd of change
Start of changeTime in units of tenths of a second. Maintained internally as a 4-byte packed decimal field of the form HHMMSST+ where HH is the number of hours, MM is the number of minutes, SS is the number of seconds, T is the number of tenths of a second, and + indicates a positive number. Displayed as a character string of the form HH:MM:SS.End of change
Start of changeDECTIMESEnd of change
Start of changeTime in units of seconds. Maintained internally as a 4-byte packed decimal field of the form 0HHMMSS+ where HH is the number of hours, MM is the number of minutes, SS is the number of seconds, and + indicates a positive number. Displayed as a character string of the form HH:MM:SS.End of change
EYUDA
CPSM value. Maintained internally as an encoded binary integer. Displayed externally as a 16-character value.
HIDCHAR
Hidden character string. Maintained as the character data. Not displayed through the CICSPlex SM end-user interface or GUI.
HEX
Hexadecimal value. Maintained internally as a binary value. Displayed externally as a printable hexadecimal value. The null value is blanks.
HHMM
Hours and Minutes. Maintained internally as an encoded binary value. Displayed externally as 4 zoned decimal digits.
INTSTCK
Time Interval in System/390 form. Maintained internally as a binary value. Displayed externally as a 15-digit formatted value HHHH:MM:SS.mmmm. The value is usually the result of an arithmetic operation (such as subtraction) being applied to System/390 Store Clock values. When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.
INTUSEC
Time Interval in microseconds. Maintained internally as a binary value. Displayed externally as a 15-digit formatted value HHHH:MM:SS.mmmm. When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.
INTMSEC
Time Interval in milliseconds. Maintained internally as a binary value. Displayed externally as a 15-digit formatted value HHHH:MM:SS.mmmm. When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.
INTSEC
Time Interval in seconds. Maintained internally as a binary value. Displayed externally as a 10-digit formatted value HHHH:MM:SS When specified in an RTA EVALDEF the data must be entered exactly as specified with leading zeros, if necessary.
INT16US

Time Interval in 16 microseconds. Maintained internally as a binary value.

Start of changeFor attributes which have a length of 4 bytes, End of change this is displayed externally as a 13-digit formatted value HH:MM:SS.mmmm. Note that the precision of the HH value is such that a wrap-around will occur in approximately 18 hours.

Start of changeFor attributes which have a length of 8 bytes, you can specify either HH:MM:SS.mmmm, or HHHH:MM:SS.mmmm in an RTA EVALDEF.End of change

When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.

PERCENT
Percentage. Maintained internally as a binary value with a single implied decimal place. Displayed externally as a zoned decimal value of the form NNN.t.
PERCENT3
Percentage. Maintained internally as a fullword binary value with three implied decimal places. Displayed externally as a zoned decimal value of the form NNN.ttt.
RATE
Consumption rate. Maintained internally as a binary value with a single implied decimal place. Displayed externally as a zoned decimal value of the form NNN.t. The value presented describes the resource consumption over the sample period, which is expressed in seconds. For example, a rate of 1.5 is read as 1.5 consumption units per second.
RATE3
Consumption rate. Maintained internally as a doubleword binary value with three implied decimal places. Displayed externally as a zoned decimal value of the form NNN.ttt. The value presented describes the resource consumption over the sample period, which is expressed in seconds. For example, a rate of 1.575 is read as 1.575 consumption units per second.
RESTYPE
Resource type. Maintained internally as a binary value. Displayed externally as zoned decimal digits.
SCLOCK
CICS/ESA CMF SCLOCK. Maintained internally as a binary value. Displayed externally as a 13-digit formatted value HH:MM:SS.mmmm. Note that the precision of the HH value is such that a wrap-around will occur in approximately 18 hours. Start of changeThe last 4 bytes, which are usually available in another attribute of the managed object, contain a count. Usually the value displayed externally is the first 4 bytes of the CICS/ESA CMF SCLOCK and the last 4 bytes are ignored, but in some cases the count contained in the last 4 bytes is also displayed. To see which is the case, refer to the attribute descriptions in the tables concerned.End of change API programs have access to the entire internal SCLOCK data value. When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.Start of changeFor more information about clocks see the CICS Performance Guide.End of change
SUM
Sum of values. Maintained internally as a binary value with a single implied decimal place. Displayed externally as a zoned decimal value of the form NNN.t.
SUM3
Sum of values. Maintained internally as a doubleword binary value with three implied decimal places. Displayed externally as a zoned decimal value of the form NNN.ttt.
TIMESTP
System/390 Timestamp. Maintained internally as a System/390 Store Clock value. Displayed externally as a 13-digit formatted value HH:MM:SS.mmmm. When specified in an RTA EVALDEF the mmmm value is not required. The other data must be entered exactly as specified with leading zeros, if necessary.
Source
How the attribute value was acquired. The valid source keywords are:
Keyword
Description
CPSM
Using CICSPlax SM/ESA services
INQ
From CICS SPI Inquire
STAT
From CICS SPI Statistics
CMF
From CICS Monitor Performance class record
Len
The internal length of the value for the attribute. All length values identify the number of bytes occupied by the attribute value, regardless of the datatype.
Req
Whether the attribute is required when constructing an instance of a CPSM definition. This column is shown only for the CPSM definition object type.

Start of changeA field that is not required may end up being required if other optional fields are also set. For example, in the WLMSPEC and TRANGRP resource tables, if a value is specified for Affinity Relation and Affinity Lifetime, a value for Create Affinity must also be specified.End of change

A value of YES indicates that an attribute value must be provided when using the Batch Utility or the API CREATE or UPDATE commands to create object instances.

A value of n/a appears for the CREATETIME and CHANGETIME attributes only. This is because these attributes are required for the construction of a CPSM definition but are maintained internally by CICSPlex SM. You should not attempt to change their value in any way.

Sum
Identifies the default summary option that will be used if an API GROUP command is issued. The summary option may be changed using the SUMOPT operand of GROUP. Valid values are:
Keyword
Description
AVG
Average of values
DIF
Different character pattern
LIKE
Like values
MIN
Minimum value
MAX
Maximum value
SUM
Sum of values
Start of changeNote that CICSPlex SM Notifications and the OBJSTAT resource table do not participate in summary operations. See the CICSPlex System Manager Application Programming Guide for more information about the OBJSTAT resource table.End of change
Set
Whether the attribute may be modified using the API SET command. A value of YES indicates modification is allowed. This column is only shown for CICS or Monitored CICS resources.
Description
1 to 30 characters of text that describes the attribute.
Get/Set Invalid
For CICS Resource and CICS Monitored objects, identifies releases of CICS that do not support either the attribute itself (if the heading is Get), or modification of the attribute (if the heading is Set). The CICS release values are shown as follows:
E530
CICS TS for OS/390 Release 3
E620
CICS TS for z/OS Version 2 Release 2
Start of changeE630End of change
Start of changeCICS Transaction Server for z/OS, Version 2 Release 3End of change
N430
CICS for Windows component of IBM TXSeries 4.3.0
N500
CICS for Windows component of IBM TXSeries 5.0
Default
For CPSM Definition objects, the default value assumed for the attribute. This value is displayed when an ISPF end-user interface command is used to create an object of this type. If the attribute is required, an explicit value must be provided.
Value Range
For CPSM Definition objects, identifies the range of valid values that are accepted when an object of this type is created or updated.
Attr ID
The number of the attribute in the table. This is the "relative ID" used in processing ASYNCREQ and FEEDBACK data.
Valid Values
For attributes with a data type of EYUDA, CVDA, or CVDT, identifies the valid values for the attribute. Up to three different sets of values may be shown:
Input Valid Values
Values that can be specified in API actions or with the batched repository-update facility.
Output Valid Values
Values that can be tested in an EVALDEF or that may be visible when an instance of the object is fetched.
Input/Output Valid Values
Values that are valid in both cases.
Note:
For attributes with a datatype of CHAR, the value shown may be a valid value in a value range (as opposed to a character string).

[[ Contents Previous Page | Next Page Index ]]