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 described below:
Note: If an attribute participates in the native key of the resource class, the attribute value is shown in reverse highlighting with a numeric value appended to the end for example,  Name-1 . 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.
Name
A unique 1- to 12-character name, which is used to identify the attribute.
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 Web User Interface (WUI), 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 listed here.

When times are displayed as a formatted value, they can include fractions of a second. In the descriptions which follow, for times that include fractions of a second, t is tenths of seconds, h is hundredths of seconds, m is milliseconds, i is ten-thousandths of seconds, j is hundred-thousandths of seconds, and u is microseconds.

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.
BITSTRIP
Maintained internally as a binary value of a set of 32 flags. Displayed as single bit values or sequences of bits, separated by commas; for example 4-7, 9, 11-12, 15, 17, 19-20, 26-29.
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 z Systems® Store Clock value. Displayed externally as a 24-digit formatted value MT/DY/YYYY-HH:MM:SS.thmi. When specified in an RTA Evaluation definition (EVALDEF object), the fractions of a second (thmi) are not required. The other data must be entered exactly as specified with leading zeros, if necessary. For Assembler and COBOL resource tables, the CPSM translator generates a single doubleword (8 bytes) sized field definition. However, for PL/I and C resource tables a two-fullword array is generated for the DATETIME fields.
DECDATE
Date. 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.
DECIMAL
Decimal value. Maintained internally in packed decimal form. Displayed externally as zoned decimal digits.
DECTIME
Time 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.
DECTIMES
Time 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.
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.
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 17-digit formatted value HHHH:MM:SS.thmiju (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, i is ten-thousandths of seconds, j is hundred-thousandths of seconds, and u is microseconds). 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 Evaluation definition (EVALDEF object), the fractions of a second (thmi) are 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 17-digit formatted value HHHH:MM:SS.thmiju (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, i is ten-thousandths of seconds, j is hundred-thousandths of seconds, and u is microseconds). When specified in an RTA Evaluation definition (EVALDEF object), the fractions of a second (thmi) are 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.thmi. When specified in an RTA Evaluation definition (EVALDEF object), the fractions of a second (thmi) are 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 Evaluation definition (EVALDEF object), 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.

For attributes which have a length of 4 bytes, this is displayed externally as a 17-digit formatted value HH:MM:SS.thmiju(where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, i is ten-thousandths of seconds, j is hundred-thousandths of seconds, and u is microseconds). Note that the precision of the HH value is such that a wrap-around will occur in approximately 18 hours.

For attributes which have a length of 8 bytes, you can specify either HH:MM:SS.thmiju, or HHHH:MM:SS.thmiju in an RTA Evaluation definition (EVALDEF object).

When specified in an RTA Evaluation definition (EVALDEF object), the fractions of a second (thmi) are 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 monitoring facility (CMF) 8 byte interval store clock. Maintained internally as a binary value.

The first 4 bytes contain the time accumulated by the clock, and they are displayed externally as a formatted value, with the default format HH:MM:SS.thmi. Note that for the standard SCLOCK, the capacity of the clock is such that a wrap-around will occur in approximately 19 hours.

The last 4 bytes contain a count of the measurement periods during which the time was accumulated. The count can also be displayed externally. In the Monitor data for local or dynamic transactions (MLOCTRAN) views, and the MLOCTRAN resource table, the count and time components are available as separate attributes. However, in other cases, the count is displayed externally by selecting the count formatting option for the attribute.

EXEC CPSM API programs have access to the entire internal SCLOCK data value, but REXX applications only have access to the first 4 bytes containing the time.

When specified in an RTA Evaluation definition (EVALDEF object), the last 4 bytes containing the count are not available. The other data must be entered in one of the following formats, with leading zeros, if necessary:
  1. HH:MM:SS
  2. HH:MM:SS.thmi
  3. HHHH:MM:SS.thmi
For more information about clocks see the Clocks and time stamps.
SCLOCK12
CICS monitoring facility (CMF) 12 byte interval store clock. Maintained internally as a binary value.

The first 8 bytes contain the time accumulated by the clock, and they are displayed externally as a formatted value, with the default format HHHH:MM:SS.thmiju.

The last 4 bytes contain a count of the measurement periods during which the time was accumulated. The count can be displayed externally by selecting the count formatting option for the attribute.

EXEC CPSM API programs have access to the entire internal SCLOCK12 data value, but REXX applications only have access to the first 8 bytes containing the time.

When specified in an RTA Evaluation definition (EVALDEF object), the last 4 bytes containing the count are not available. The other data must be entered in one of the following formats, with leading zeros, if necessary:
  1. HH:MM:SS
  2. HH:MM:SS.thmi
  3. HHHH:MM:SS.thmi
  4. HHHH:MM:SS
  5. HHHH:MM:SS.thmiju
Only the first three of these formats are compatible with earlier releases of CICSPlex SM. If you need to use an Evaluation definition (EVALDEF object) involving SCLOCK12 data with an earlier release of CICSPlex SM, do not use format 4 or 5. This applies to Evaluation definitions (EVALDEF object) installed directly on a back-level CICSPlex SM system, and also to Evaluation definitions (EVALDEF object) installed as part of a batched repository update job (BATCHREP) or using the batch utility EYU9XDBT.
For more information about clocks, see Clocks and time stamps.
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.thmi. When specified in an RTA Evaluation definition (EVALDEF object) the fractions of a second (thmi) are 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 CICSPlex SM services
INQ
From CICS SPI Inquire
STAT
From CICS SPI Statistics
CMF
From CICS Monitor Performance class record
Note: Attributes sourced from CICS statistics are likely to be reset periodically, either as a result of a scheduled statistics reset, or one that is manually requested. When the reset happens, attribute values that are related to count values, or time interval accumulations, are reset to zero.
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 only shown for the CPSM Definition object type.

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 by specifying a summary expression on the SUMOPT option of the GROUP command. The following summary options can be specified on the GROUP command:
Keyword
Description
AVG
Average of values
DIF
Different character pattern
LIKE
Like values
MIN
Minimum value
MAX
Maximum value
SUM
Sum of values
CICSPlex SM notifications and the OBJSTAT resource table do not participate in summary operations. See Developing CICSPlex SM applications for more information about the OBJSTAT resource table.
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:
E620
CICS® TS for z/OS®, Version 2.2
E630
CICS TS for z/OS, Version 2.3
E640
CICS TS for z/OS, Version 3.1
E650
CICS TS for z/OS, Version 3.2
E660
CICS TS for z/OS, Version 4.1
E670
CICS TS for z/OS, Version 4.2
E680
CICS TS for z/OS, Version 5.1

In addition, you might also see the release followed by PLUS; that is, E620PLUS, E630PLUS, E640PLUS, E650PLUS, E660PLUS, E670PLUS, or E680PLUS. This syntax means that the field is not valid for the specified release and all later releases.

Default
For CPSM Definition objects, the default value assumed for the attribute. 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 Evaluation definition (EVALDEF object) 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).