Using CICSPlex SM metadata resource tables

The GETDEF command is used to obtain records describing the structure of the CICSPlex® SM managed objects, including general characteristics, valid actions, and object attributes. The OBJECT option of the GETDEF command identifies the type of metadata to be retrieved. The contents of the ATTR, ATTRAVA, METADESC, METANAME, METAPARM, OBJACT, OBJECT, and PARMAVA metadata resource tables are described in this topic.

The ATTR resource table contains detailed information for a specific attribute of a managed object.
The ATTRAVA resource table provides an acceptable value for a specific attribute of a managed object. The set of ATTRAVA base tables for a specific attribute provide the list of all acceptable values.
The METADESC resource table provides basic structure and layout information for a specific attribute of a managed object.
The METANAME resource table contains information about all CVDASs, CVDATs, and EYUDAs.
The METAPARM resource table contains information about a parameter for an action.
The OBJACT resource table contains action information for a specific managed object.
The OBJECT resource table contains detailed information for a specific managed object.
The PARMAVA resource table provides information about the values that may be specified for a parameter.

ATTR

The ATTR resource table contains detailed information for a specific attribute of a managed object.

Attribute name

OBJECT

The name of the managed object to which the specific attribute belongs.

TABLEVER

The version of the table identified by the OBJECT attribute.

NAME

The name of the specific attribute. 1 to 12 characters in length.

ID

The ID of the attribute

LENGTH

The length of the data associated with the attribute. Not to be confused with the length of the ATTR attribute NAME.

OFFSET

The offset in the resource table at which the attribute data begins.

DATATYPE

The data type of the attribute data:

COMPID: CICSPlex SM component ID
BINARY: Binary
RATE: Rate to 1 decimal place
PERCENT: Percentage to 1 decimal place
SUM: Sum of values to 1 decimal place
RATIO: Ratio
AVERAGE: Average to 1 decimal place
TIMESTP: Time stamp
BIT: Bit string
TEXT: Text
CHAR: Character
EYUDA: EYUDA
CVDAS: Standard CVDA
CVDAT: Terminal CVDA
RESTYPE: Restype
DECIMAL: Packed Decimal
DECDATE: Date in decimal form
ILABEL: Internal Label
HHMM: Binary Hours/Minutes
SCLOCK: CMF 8 byte interval store clock
SCLOCK12: CMF 12 byte interval store clock
INTUSEC: Interval in microseconds
INTMSEC: Interval in milliseconds
INT16US: Interval in 16 microseconds
INTSEC: Interval in Seconds
INTTSTP: Interval Timestamp Delta
DATETIME: Date Time Group
DECTSTP: Decimal Timestamp
ADDRESS: Address
CNUMERIC: Coded Numeric
HIDCHAR: Non Display Character
HEX: Hexadecimal
TBLVER: Resource table version
RATE3: Rate to 3 decimal places
PERCENT3: Percentage to 3 decimal places
SUM3: Sum of values to 3 decimal places
AVERAGE3: Average to 3 decimal places
DECTIME: Time in units of tenths of a second
DECTIMES: Time in units of seconds

SUMOPT

The default summary option used for the attribute:

AVG: Average
DIFF: Difference
LIKE: Like
MAX: Maximum
MIN: Minimum
SUM: Summary

IDATATYPE

A numeric value which represents the internal data type

0: Component
4: Numeric
8: Rate
12: Percent
16: Sum
20: Ratio
24: Average
28: Timestamp
32: Bit
36: Text
40: Character
44: EYUDA
48: CVDA standard
52: CVDA terminal
56: Resource type
60: Packed decimal
64: Packed decimal date
68: Internal label field
72: HHMM
76: Interval store clock, 8 byte
80: Interval microseconds
84: Interval milliseconds
88: Interval 16 microseconds
92: Interval seconds
96: Store clock delta
100: Date time group
104: Packed decimal timestamp to tenths of seconds
108: Address
112: Coded numeric
116: Non-display character
120: Hexadecimal
124: Table version
128: Binary derived rate to 3 decimal places
132: Binary derived percent to 3 decimal places
136: Binary derived sum to 3 decimal places
140: Binary derived average to three deecimal places
144: Packed decimal time to seconds
148: Packed decimal time to tenths of seconds
152: Interval store clock, 12 byte

SETVALID

Whether or not the attribute may be set/modified: Y or N

REQUIRED

Whether or not the attribute is required for CREATE: Y or N

AVAAVAIL

Whether or not attribute value assertion information is available for the attribute: Y or N. When available, refer to the ATTR attributes:

AVACOUNT

Use the ATTRAVA resource table to obtain attribute value assertion information.

CICSVALAVAIL

Whether or not CICS® validity data is available: Y or N. When available, refer to the ATTR attributes:

VALCICSESA
VALCICSVSE
VALCICSOS2
VALCICSWNT
VALCICSES2
VALCICSES3

HDRTXTAVAIL

Whether or not attribute header text is available: Y or N. When available, refer to the ATTR attributes:

HDRTEXT

VALSETAVAIL

Whether or not value set information is available: Y or N. When available, refer to the ATTR attributes:

VALCOUNT

Use the ATTRAVA resource table to obtain value set information.

SOURCE

The source of the attribute data:

V: Created by CICSPlex SM
I: Acquired from CICS INQ
S: Acquired from CICS STATS
P: Acquired from CICS CMF data

KEY

Whether or not the attribute participates in the key of the managed object: 0 or n, where 0 means the attribute is not part of the key, and n means the part number of the key.

AVACOUNT

The number of attribute value assertions for the attribute. This value corresponds to the number of ATTRAVA resource table records available with a LISTTYPE value of AVA for the attribute. Only present if the AVAAVAIL attribute is Y.

VALCOUNT

The number of value set values for the attribute. This value corresponds to the number of ATTRAVA resource table records available with a LISTTYPE value of VALUE for the attribute. Only present if the VALSETAVAIL attribute is Y.

VALCICSESA

First byte of flags indicating whether or not the attribute is valid in different versions of CICS Transaction Server for z/OS®:


1... ....    X'80'      CICS/MVS 2.1.2
.1.. ....    X'40'      CICS/ESA 3.3.0
..1. ....    X'20'      CICS/ESA 4.1.0
...1 ....    X'10'      CICS Transaction Server for OS/390, Version 1 Release 1
.... 1...    X'08'      CICS Transaction Server for OS/390, Version 1 Release 2
.... .1..    X'04'      CICS Transaction Server for OS/390, Version 1 Release 3             
.... ..1.    X'02'      CICS Transaction Server for z/OS, Version 2 Release 1 
.... ...1    X'01'      CICS Transaction Server for z/OS, Version 2 Release 2

The attribute is not valid in the version of CICS if the bit is set on.

VALCICSES2

Second byte of flags indicating whether or not the attribute is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 2 Release 3
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 3 Release 1
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 3 Release 2
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 4 Release 1
.... 1...    X'08'    CICS Transaction Server for z/OS, Version 4 Release 2
.... .1..    X'04'    CICS Transaction Server for z/OS, Version 5 Release 1
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 5 Release 2
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 5 Release 3

The action is not valid in the version of CICS if the bit is set on.

VALCICSES3

Third byte of flags indicating whether or not the attribute is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 5 Release 4
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 5 Release 5
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 5 Release 6
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 6 Release 1

The parameter is not valid in the version of CICS if the bit is set on.

VALCICSVSE

Flags indicating whether or not the attribute is valid in different versions of CICS/VSE:

1... ....    X'80'      CICS/VSE 2.2.0
.1.. ....    X'40'      CICS/VSE 2.3.0
..1. ....    X'20'      CICS/VSE 4.1.0 
...1 1111               Reserved

The attribute is not valid in the version of CICS if the bit is set on.

VALCICSOS2

Flags indicating whether or not the attribute is valid in different versions of CICS OS/2:

1... ....    X'80'      CICS OS/2 2.0.1
.1.. ....    X'40'      CICS OS/2 3.0.0
..1. ....    X'20'      CICS OS/2 3.1.0
...1 1111               Reserved

The attribute is not valid in the version of CICS if the bit is set on.

VALCICSWNT

Flags indicating whether or not the attribute is valid in different versions of TXSeries®:

1... ....    X'80'      CICS for TXSeries 4.3.0
.1.. ....    X'40'      CICS for TXSeries 5.0.0
..11 1111               Reserved

The attribute is not valid in the version of CICS if the bit is set on.

SETCICSESA

First byte of flags indicating whether or not the attribute is modifiable in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'      CICS/MVS 2.1.2
.1.. ....    X'40'      CICS/ESA 3.1.0
..1. ....    X'20'      CICS/ESA 4.1.0
...1 ....    X'10'      CICS Transaction Server for OS/390, Version 1 Release 1
.... 1...    X'08'      CICS Transaction Server for OS/390, Version 1 Release 2
.... .1..    X'04'      CICS Transaction Server for OS/390, Version 1 Release 3
.... ..1.    X'02'      CICS Transaction Server for z/OS Version 2 Release 1
.... ...1    X'01'      CICS Transaction Server for z/OS Version 2 Release 2

The attribute is not modifiable in the version of CICS if the bit is set on.

SETCICSES2

Second byte of flags indicating whether or not the attribute is modifiable in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 2 Release 3
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 3 Release 1
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 3 Release 2
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 4 Release 1
.... 1...    X'08'    CICS Transaction Server for z/OS, Version 4 Release 2
.... .1..    X'04'    CICS Transaction Server for z/OS, Version 5 Release 1
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 5 Release 2
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 5 Release 3

The attribute is not modifiable in the version of CICS if the bit is set on

SETCICSES3

Third byte of flags indicating whether or not the attribute is modifiable in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 5 Release 4
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 5 Release 5
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 5 Release 6
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 6 Release 1

SETCICSVSE

Flags indicating whether or not the attribute is modifiable in different versions of CICS/VSE:

1... ....    X'80'      CICS/VSE 2.2.0
.1.. ....    X'40'      CICS/VSE 2.3.0
..1. ....    X'20'      CICS/VSE 4.1.0
...1 1111               Reserved

The attribute is not modifiable in the version of CICS if the bit is set on.

SETCICSOS2

Flags indicating whether or not the attribute is modifiable in different versions of CICS OS/2:

1... ....    X'80'      CICS OS/2 2.0.1
.1.. ....    X'40'      CICS OS/2 3.0.0
..1. ....    X'20'      CICS OS/2 3.1.0
...1 1111               Reserved

The attribute is not modifiable in the version of CICS if the bit is set on.

SETCICSWNT

Flags indicating whether or not the attribute is modifiable in different versions of TXSeries:

1... ....    X'80'      CICS for TXSeries 4.3.0
.1.. ....    X'40'      CICS for TXSeries 5.0.0
..11 1111               Reserved

The attribute is not modifiable in the version of CICS if the bit is set on.

IGNVALUE

The value that signifies Not Applicable or Ignore for the attribute.

LOWVALUE

The lowest value allowed in the range of valid values for the attribute.

HIGHVALUE

The highest value allowed in the range of valid values for the attribute.

HDRTEXT

The header text of the attribute. Only present if the HDRTXTAVAIL attribute value is Y.

DESC

The description of the attribute.

DEFAULT

The default value for the attribute, if any.

UCHAR

Whether or not the attribute value is uppercase: Y or N.

CICSSETAVAIL

Indicates whether or not the SET command is valid for an attribute: Y or N. When set to Y, the following ATTR attributes indicate the levels of different CICS products for which the command is valid:

SETCICSESA
SETCICSVSE
SETCICSOS2
SETCICSWNT
SETCICSES2
SETCICSES3

SORT

Indicates whether or not the attribute participates in ORDER

Y: The attribute participates in ORDER
N: The attribute does not participate in ORDER

FILTER

Indicates whether or not the attribute participates in SPECIFY FILTER

Y: The attribute participates in SPECIFY FILTER
N: The attribute does not participate in SPECIFY FILTER

SUMMARISE

Eligibility of the attribute for summarizing

Y: The attribute may be summarized
N: The attribute may not be summarized

VIEWMOD

Eligibility of the attribute for view support

Y: The attribute is eligible for view support
N: The attribute is not eligible for view support

INHERIT

Indicates whether or not the attribute participates in inheritance

Y: The attribute participates in inheritance
N: The attribute does not participate in inheritance

ATTRAVA

Information in this resource table is available only when the AVAAVAIL or VALSETAVAIL attributes of the ATTR resource table have a value of Y.

The ATTRAVA resource table provides an acceptable value for a specific attribute of a managed object. The set of ATTRAVA base tables for a specific attribute provide the list of all acceptable values.

However, please note that the attribute may support a range of values (for example, zero to 999) and there are no ATTRAVA base tables for the range values. There also may not be an ATTRAVA base table for the default value for the attribute. The default value, and the highest and lowest in range values can be found from the ATTR base table for the attribute.

Attribute name

OBJECT

The name of the managed object to which the specific attribute belongs.

TABLEVER

The version of the table identified by the OBJECT attribute.

NAME

The name of the specific attribute. 1 to 12 characters in length.

AVAVALUE

A value for the attribute.

LISTTYPE

Indicates if the AVAVALUE data is an attribute value assertion or other acceptable value for the attribute:

AVA: A value derived from an attribute value assertion
VALUE: At present, this is only used to return the special value meaning "ignore"

IOTYPE

Indicates whether the attribute value is used for input, output, or input and output operations:

I: Input
O: Output
B: Input and output

METADESC

The METADESC resource table provides basic structure and layout information for a specific attribute of a managed object.

Attribute name

NAME

The name of the specific attribute. 1 to 12 characters in length.

LENGTH

The length of the data associated with the attribute. Not to be confused with the length of the METADESC attribute NAME.

OFFSET

The offset in the resource table at which the attribute data begins.

DATATYPE

The data type of the attribute data:

0: Component Identifier
4: Binary Numeric
8: Binary Derived Rate
12: Binary Derived Percent
16: Binary Derived Sum
20: Binary Derived Ratio
24: Binary Derived Average
28: Operating system timestamp
32: Bit
36: Text
40: Character
44: EYUDA
48: CVDA Standard
52: CVDA Terminal
56: Resource Type
60: Packed Decimal
64: Packed decimal date
68: Internal Label Field
72: Binary HHMM
76: Interval store clock, 8 byte
80: Interval Microseconds
84: Interval Milliseconds
88: Interval 16 Microseconds
92: Interval Seconds
96: Interval Store Clock delta
100: Date Time Group
104: Packed Decimal Timestamp to tenths of seconds
108: Address
112: Coded Numeric
116: Non Display Character
120: Hexadecimal
124: Table version
128: Binary derived rate to 3 decimal places
132: Binary derived percent to 3 decimal places
136: Binary derived sum to 3 decimal places
140: Binary derived average to three decimal places
144: Packed decimal timestamp to seconds
148: Packed decimal timestamp to tenths of seconds
152: Interval store clock, 12 byte

INHERIT

Whether or not the attribute value is inheritable: Y or N. Valid only for CICSPlex SM definition resource tables that participate in CICSplex inheritance.

METANAME

The METANAME resource table contains information about all CVDASs, CVDATs, and EYUDAs.

Attribute name

NAMETYPE

Type of data

1: CVDAS
2: CVDAT
3: EYUDA

VALUE

Numeric value of CVDA or EYUDA

NAME

Name of CVDA or EYUDA

DESCRIPTION

Description of CVDA or EYUDA

METAPARM

The METAPARM resource table contains information about a parameter for an action.

Attribute name

TABLE

Table name

ACTION

Action name

NAME

Parameter name as it appears in the API PARM string

ID

Parameter number

GROUP_ID

Multiple parameters may be related to each other in the sense that only one of a group may be specified. Parameters that are related in this way will have the same group ID.

REQUIRED

Indicates whether or not the parameter is required

Y: The parameter is required
N: The parameter is not required

WORKLOAD

Indicates whether or not the parameter is a workload name

Y: The parameter is a workload name
N: The parameter is not a workload name

WRKLOWNER

Indicates whether or not the parameter is the name of a workload owner

Y: The parameter is the name of a workload owner
N: The parameter is not the name of a workload owner

VALUE

Parameter value

MODE

Method by which parameter is applied

1: Copy from base table
2: Array of values
3: Bit setting
4: Keyword in API parameter string:
5: Filter string
6: API keyword with value
7: Base table field with existence bit
8: API modification string

Modes 3 and 4 appear in the API parameter string as stand-alone keywords. Modes 2, 5, 6 and 8 appear in the API parameter string as keywords with a value. Modes 1 and 7 do not appear in the API parameter string.

DESCRIPTION

Description

CICSVALAVAIL

Indicates whether or not CICS validity data is available

Y: CICS validity data is available
N: CICS validity data is not available

VALCICSESA

First byte of flags indicating whether or not the parameter is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS/MVS 2.1.2
.1.. ....    X'40'    CICS/ESA 3.3.0
..1. ....    X'20'    CICS/ESA 4.1.0
...1 ....    X'10'    CICS Transaction Server for OS/390, Version 1 Release 1
.... 1...    X'08'    CICS Transaction server for OS/390, Version 1 Release 2
.... .1..    X'04'    CICS Transaction Server for OS/390, Version 1 Release 3
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 2 Release 1
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 2 Release 2

The parameter is not valid in the version of CICS if the bit is set on.

VALCICSES2

Second byte of flags indicating whether or not the parameter is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 2 Release 3
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 3 Release 1
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 3 Release 2
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 4 Release 1
.... 1...    X'08'    CICS Transaction Server for z/OS, Version 4 Release 2
.... .1..    X'04'    CICS Transaction Server for z/OS, Version 5 Release 1
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 5 Release 2
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 5 Release 3

The parameter is not valid in the version of CICS if the bit is set on.

VALCICSES3

Third byte of flags indicating whether or not the parameter is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 5 Release 4
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 5 Release 5
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 5 Release 6
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 6 Release 1

The parameter is not valid in the version of CICS if the bit is set on.

VALCICSVSE

Flags indicating whether or not the parameter is valid in different versions of CICS Transaction Server for VSE:

1... ....    X'80'      CICS/VSE 2.2.0
.1.. ....    X'40'      CICS/VSE 2.3.0
..1. ....    X'20'      CICS/VSE 4.1.0
...1 1111               Reserved

The parameter is not valid in the version of CICS if the bit is set on.

VALCICSOS2

Flags indicating whether or not the parameter is valid in different versions of CICS OS/2:

1... ....    X'80'      CICS OS/2 2.0.1
.1.. ....    X'40'      CICS OS/2 3.0.0
..1. ....    X'20'      CICS OS/2 3.1.0
...1 1111               Reserved

The parameter is not valid in the version of CICS if the bit is set on.

VALCICSWNT

Flags indicating whether or not the parameter is valid in different versions of TXSeries:

1... ....    X'80'      CICS for TXSeries 4.3.0
.1.. ....    X'40'      CICS for TXSeries 5.0.0
..11 1111               Reserved

The parameter is not valid in the version of CICS if the bit is set on.

OBJACT

The OBJACT resource table contains action information for a specific managed object.

Attribute name

OBJECT

The name of the managed object to which the specific action applies.

TABLEVER

The version of the table identified by the OBJECT attribute.

ACTION

The name of the action. 1 to 12 characters in length.

VALCICSESA

First byte of flags indicating whether or not the action is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS/MVS 2.1.2
.1.. ....    X'40'    CICS/ESA 3.3.0
..1. ....    X'20'    CICS/ESA 4.1.0
...1 ....    X'10'    CICS Transaction Server for OS/390, Version 1 Release 1
.... 1...    X'08'    CICS Transaction server for OS/390, Version 1 Release 2
.... .1..    X'04'    CICS Transaction Server for OS/390, Version 1 Release 3
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 2 Release 1
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 2 Release 2

The action is not valid in the version of CICS if the bit is set on.

VALCICSES2

Second byte of flags indicating whether or not the action is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 2 Release 3
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 3 Release 1
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 3 Release 2
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 4 Release 1
.... 1...    X'08'    CICS Transaction Server for z/OS, Version 4 Release 2
.... .1..    X'04'    CICS Transaction Server for z/OS, Version 5 Release 1
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 5 Release 2
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 5 Release 3

The action is not valid in the version of CICS if the bit is set on.

VALCICSES3

Third byte of flags indicating whether or not the action is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 5 Release 4
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 5 Release 5
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 5 Release 6
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 6 Release 1

The action is not valid in the version of CICS if the bit is set on.

VALCICSVSE

Flags indicating whether or not the action is valid in different versions of CICS Transaction Server for VSE:

1... ....    X'80'      CICS/VSE 2.2.0
.1.. ....    X'40'      CICS/VSE 2.3.0
..1. ....    X'20'      CICS/VSE 4.1.0
...1 1111               Reserved

The action is not valid in the version of CICS if the bit is set on.

VALCICSOS2

Flags indicating whether or not the action is valid in different versions of CICS OS/2:

1... ....    X'80'      CICS OS/2 2.0.1
.1.. ....    X'40'      CICS OS/2 3.0.0
..1. ....    X'20'      CICS OS/2 3.1.0
...1 1111               Reserved

The action is not valid in the version of CICS if the bit is set on.

VALCICSWNT

Flags indicating whether or not the action is valid in different versions of TXSeries:

1... ....    X'80'      CICS for TXSeries 4.3.0
.1.. ....    X'40'      CICS for TXSeries 5.0.0
..11 1111               Reserved

The action is not valid in the version of CICS if the bit is set on.

DESCRIPTION

The description of the action

ID

The number of the action

PARMCOUNT

The number of parameters for this action

APIPERFORM

Indicates whether or not an action is valid for EXEC CPSM PERFORM, GET, SET, CREATE, UPDATE, and REMOVE.

N: The action is not valid.
Y: The action is valid.

OBJECT

The OBJECT resource table contains detailed information for a specific managed object.

Attribute name

NAME

The name of the managed object. 1 to 8 characters in length.

ID

The numeric resource table ID.

NUMTBLVER

The number of different versions of the managed object which are known to exist.

HIGHTBLVER

The number of the highest version of the managed object.

RELTBLVER

The version of the managed object at the current CICSPlex SM release.

OWNERNAME

The name of the component which owns the managed object.

CREATREL

CICSPlex SM release at which the managed object was introduced.

QUERYREL

CICSPlex SM release of the querying CMAS.

OBJTYPE

The object type of the managed object:

C: CICS Resource
M: Monitored CICS Resource
D: CPSM Definition
V: CPSM Resource
O: CPSM Metadata
N: CPSM Notification
R: CICS Resource Definition
L: CPSM Configuration Definition

CURTBLVER

Version of the managed object at the current CONNECT version

CURNUMATTR

Number of attributes in the managed object at the current CONNECT version

CURSTGSIZE

External length of the managed object at the current CONNECT version

CURCPSMREL

CICSPlex SM release when the version of the managed object at the current CONNECT version was created

CURVALRTA

Whether or not the managed object is valid for use with RTA: Y or N.

CURVALUTL

Whether or not the managed object is valid for use with the batch utility: Y or N.

CURGETVAL

Whether or not the managed object is valid for GET requests: Y or N.

CURSETVAL

Whether or not the managed object is valid for SET requests: Y or N.

CURCREVAL

Whether or not the managed object is valid for CREATE requests: Y or N.

CURUPDVAL

Whether or not the managed object is valid for UPDATE requests: Y or N.

CURREMVAL

Whether or not the managed object is valid for REMOVE requests: Y or N.

CURACTVAL

Whether or not the managed object has actions defined: Y or N.

Use the OBJACT resource table to obtain action information.

CURVALESA

First byte of flags indicating whether or not the managed object is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS/MVS 2.1.2
.1.. ....    X'40'    CICS/ESA 3.3.0
..1. ....    X'20'    CICS/ESA 4.1.0
...1 ....    X'10'    CICS Transaction Server for OS/390, Version 1 Release 1
.... 1...    X'08'    CICS Transaction Server for OS/390, Version 1 Release 2
.... .1..    X'04'    CICS Transaction Server for OS/390, Version 1 Release 3
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 2 Release 1
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 2 Release 2

The object is not valid in the version of CICS if the bit is set on.

CURVALES2

Second byte of flags indicating whether or not the managed object is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 2 Release 3
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 3 Release 1
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 3 Release 2
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 4 Release 1
.... 1...    X'08'    CICS Transaction Server for z/OS, Version 4 Release 2
.... .1..    X'04'    CICS Transaction Server for z/OS, Version 5 Release 1
.... ..1.    X'02'    CICS Transaction Server for z/OS, Version 5 Release 2
.... ...1    X'01'    CICS Transaction Server for z/OS, Version 5 Release 3

The managed object is not valid in the version of CICS if the bit is set on.

CURVALES3

Third byte of flags indicating whether or not the managed object is valid in different versions of CICS Transaction Server for z/OS:


1... ....    X'80'    CICS Transaction Server for z/OS, Version 5 Release 4
.1.. ....    X'40'    CICS Transaction Server for z/OS, Version 5 Release 5
..1. ....    X'20'    CICS Transaction Server for z/OS, Version 5 Release 6
...1 ....    X'10'    CICS Transaction Server for z/OS, Version 6 Release 1

The managed object is not valid in the version of CICS if the bit is set on.

CURVALVSE

Flags indicating whether or not the managed object is valid in different versions of CICS/VSE:

1... ....    X'80'      CICS/VSE 2.2.0
.1.. ....    X'40'      CICS/VSE 2.3.0
..1. ....    X'20'      CICS/VSE 4.1.0
...1 1111               Reserved

The object is not valid in the version of CICS if the bit is set on.

CURVALOS2

Flags indicating whether or not the managed object is valid in different versions of CICS OS/2:

1... ....    X'80'      CICS OS/2 2.0.1
.1.. ....    X'40'      CICS OS/2 3.0.0 
..1. ....    X'20'      CICS OS/2 3.1.0
...1 1111               Reserved

The object is not valid in the version of CICS if the bit is set on.

CURVALWNT

Flags indicating whether or not the managed object is valid in different versions of TXSeries:

1... ....    X'80'      CICS for TXSeries 4.3.0
.1.. ....    X'40'      CICS for TXSeries 5.0.0
..11 1111               Reserved

The object is not valid in the version of CICS if the bit is set on.

DESC

The description of the managed object.

VIEWMOD

Eligibility of the managed object for view support

Y: The managed object is eligible for view support
N: The managed object is not eligible for view support

APIPREFIX

Indicates whether or not an API prefix is required

Y: An API prefix is required
N: An API prefix is not required

SCOPESORT

Y: The API sorts by scope
N: The API does not sort by scope

SCOPEREQ

Y: Scope must be specified
N: Scope need not be specified

PARMAVA

The PARMAVA resource table provides information about the values that may be specified for a parameter.

Attribute name
PARMIDN: Parameter number
PARMAVAIDN: AVA number for parameter
LITERAL: Parameter literal
VALUE: Parameter value in numeric form
VALUENAME: Parameter value as a character string