CICSPlex SM resource tables

This section provides detailed reference information about the CICSPlex® SM resource tables. Each resource table is described, including a summary of how it is used, the operations that are valid, and all the attributes. Key fields (where applicable) are highlighted in the tables.

Each resource object that CICSPlex SM manages is represented by a resource table. Resource tables are used by the following CICSPlex SM facilities:

CICS® management client interface (CMCI)
CICSPlex SM Web User Interface (WUI)
CICSPlex SM application programming interface (API)
CICSPlex SM batched repository-update facility
Real-time analysis (RTA) evaluation definitions (EVALDEF).

Each resource is represented by a resource table that describes all the attributes of that resource. Each resource table is presented as a set of tables that describe the resource as a whole and the individual attributes of the resource table.

General characteristics of the resource table

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

Table (in documentation, this is the page title)

The name of the managed object that this resource table describes. This name is used to identify the object in all CICSPlex SM API commands and from the batched repository-update facility.

Description

A 1- to 30-character description of the resource table.

External resource name

An external name used to reference the resource table.

Object Type

The type of managed object, as one of the following:

CICS Definition
CICS Resource
CICS Monitored
CICSPlex SM Definition
CICSPlex SM Configuration
CICSPlex SM Manager
CICSPlex SM MetaData
CICSPlex SM Notification

Length

The external length of the resource table. This is a fullword value which indicates the length of the resource table records that are returned in response to a CICSPlex SM API FETCH command.

Usage

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.
CICS Management Client Interface(CMCI): It can be referenced from the CICS Management Client Interface.
EVALDEF: It can be named in a Real Time Analysis evaluation definition.
WUI: It can be processed using the CICSPlex SM WUI.

API View

Indicates if the resource table can be referenced in a CICSPlex SM API SPECIFY VIEW command.

CMAS Context

Indicates if the CMAS context is used for the operations of this resource table. If the value is "No", the context is the CICSplex.

SCOPE applies

Indicates if the scope applies. (Scope is a subset of the CICSPlex SM context which limits the effects of CICSPlex SM commands.)

Only query CMASs in workload

Indicates the scope of CMASs to be processed.

Yes: Resource information is retrieved only from the CMASs that participate in the workload.
No: All CMASs within the current Scope return resource information.

Copybook identifier

A unique name for copybook version of the resource table in each language. The copybook names take the form: EYUtnnnn where:

t

Identifies which language the copybook supports, as one of the following:

A for Assembler
P for PL/I
L for COBOL
C for C

nnnn

Is a 4-character numeric resource table identifier.

CICS Commands subject to CICS Security

These are the CICS commands that are executed as part of the actions that apply to querying, setting and installing a resource. They are provided to help you make the correct updates to resource security configuration in your organization.

Security Class

The group to which the BAS function belongs. See BAS security considerations.

Table Invalid CICSREL (in documentation, this is shown as Unsupported CICS Releases)

For tables with an object type of CICS Definition or CICS Resource, the releases of CICS that do not support the managed object. The values for the CICS releases are:

E700: CICS Transaction Server for z/OS®, Version 5.3
E710: CICS Transaction Server for z/OS, Version 5.4
E720: CICS Transaction Server for z/OS, Version 5.5
E730: CICS Transaction Server for z/OS, Version 5.6
E740: CICS Transaction Server for z/OS, Version 6.1
E750: CICS Transaction Server for z/OS, Version 6.2
E760: CICS Transaction Server for z/OS, Version 6.3

In documentation, the following characteristics are shown in a table.

Valid API Operations (shown as Operations): Identifies which standard CICSPlex SM API operations (GET, SET, CREATE, UPDATE, and REMOVE) can be requested of the resource table.
Valid CICS Management Client HTTP methods: Identifies which standard HTTP methods (DELETE, GET, POST, or PUT) can be requested of the resource table.
ACTION (shown as Actions): The valid actions for the object. For resource tables with an object type of CICS Resource, any restrictions of CICS release are shown.
PARMS (shown as Parameters): For objects that require the PARM operand for standard CICSPlex SM API operations, the valid parameter values. The logical OR character (|) indicates values that are mutually exclusive.
FEEDBACK Error Codes: The error codes and values that can appear in the FEEDBACK resource table when an error occurs for this object. In the documentation, the FEEDBACK error codes are shown in a table.

Attributes in the resource table

Another table defines the specific attributes in the resource table. The attributes are discrete, named elements that represent characteristics that are specific to a resource.

The following list includes all the possible characteristics. The description of a characteristic indicates the object types to which the characteristic applies.

Note: If a resource table attribute participates in the native key of the resource, the value of the attribute is shown in reverse highlighting with a numeric value appended to the end for example, Name-1 . When a resource uses multiple attributes to identify its native key, the numeric value indicates which segment of the native key, in the range of 1 to 9, that 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 an attribute is accessed by any other CICSPlex SM API command, the attribute value is presented in its unchanged internal form. Possible data types are:

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.

CNUMERIC

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/OS Store Clock value. Displayed externally as a 24-digit formatted value MT/DY/YYYY-HH:MM:SS.thmi, (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds). 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 CICSPlex SM translator generates a single doubleword (8 bytes) sized field definition. 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 z/OS 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 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.

INTTSTP

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 (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds). 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 (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds and i is ten-thousandths of seconds). 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:

HH:MM:SS
HH:MM:SS.thmi (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds)
HHHH:MM:SS.thmi (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds)

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.(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 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.

CICSPlex SM 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.

HH:MM:SS
HH:MM:SS.thmi (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds)
HHHH:MM:SS.thmi (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds)
HHHH:MM:SS
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)

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

z/OS Timestamp. Maintained internally as a Store Clock value. Displayed externally as a 13-digit formatted value HH:MM:SS.thmi, (where t is tenths of seconds, h is hundredths of seconds, m is milliseconds, and i is ten-thousandths of seconds). 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:

CPSM: Using CICSPlex SM services
INQ: From CICS INQUIRE
STAT: From CICS Statistics. 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.
CMF: From CICS Monitor Performance class record

CICS Source

Identifies the CICS object which provides this attribute's information. When the Source is INQ, this is the name of the CICS Resource. When the Source is STAT, this identifies the CICS Statistics DSECT.

CICS Field

Identifies the name of the attribute within the CICS Resource or DSECT which maps to this CICSPlex SM attribute. When a field is derived or results from a calculation, this is reported as Calculated.

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.

A value of YES indicates that an attribute value must be provided when using the batched repository-update facility 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 CICSPlex SM definition but they are maintained internally by CICSPlex SM. You should not attempt to change their value in any way.

Sum

Identifies the default summary option that is used if a CICSPlex SM API GROUP command is issued. The summary option can 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:

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 An overview of the CICSPlex SM API for more information about the OBJSTAT resource table.

Set

Whether the attribute can be modified by using the CICSPlex SM API SET command. A value of YES indicates modification is allowed. This column is shown only 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:

E700: CICS Transaction Server for z/OS, Version 5.3
E710: CICS Transaction Server for z/OS, Version 5.4
E720: CICS Transaction Server for z/OS, Version 5.5
E730: CICS Transaction Server for z/OS, Version 5.6
E740: CICS Transaction Server for z/OS, Version 6.1
E750: CICS Transaction Server for z/OS, Version 6.2
E760: CICS Transaction Server for z/OS, Version 6.3

In addition, you might also see the release followed by PLUS; that is, E680PLUS, E690PLUS, E700PLUS, E710PLUS, E720PLUS, E730PLUS, E740PLUS, E750PLUS or E760PLUS. This syntax means that the field is not valid for the specified release and all later releases.

Default

For CICSPlex SM Definition objects, the default value assumed for the attribute. If the attribute is required, an explicit value must be provided.

Value Range

For CICSPlex SM 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. Note that, 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). Up to three different sets of values can 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 input and output cases.