STATDEF Resource Table

A CICSPlex® SM Real Time Analysis Definition that describes a site-defined status probe program to be run in a CICS® system as part of Real Time Analysis processing.

The First key field for this resource is NAME.

The following actions are supported:

ADDTOGRP

Add to resource group

The parameter data for the ADDTOGRP action is:

   PARM('RESGROUP(rtagroup) [ACTIVETIME(period)].')

     where:

     period   = The name of a PERIODEF definition.
     rtagroup = The name of a RTAGROUP definition.

INSTALL

Install the definition into each active CICS system that has Real Time Analysis active within the specified scope. If provided the PERIODEF is used to provide the valid operational time of the STATDEF.

The parameter data for the INSTALL action is:

   PARM('[PERIOD(period)].')

     where:

     period = The name of a PERIODEF definition.

The STATDEF is installed in each active CICS system in the current scope that has Real Time Analysis active. If provided, the PERIODEF is used to determine the valid operational time of the STATDEF.

External resource name(CMCI): CICSRTAStatusDefinition
Object type: CICSPlex SM Definition
Length: 192
Usage: API, Batch Utility, WUI, CICS Management Client Interface(CMCI)
API view: No
CMAS context: No
SCOPE applies: No
Only query CMASs in workload: No
Copybook identifier: EYUt3516
Security Class: ANALYSIS.DEF
Unsupported CICS Releases: None

Table 1. Valid CPSM operations
Operations	Actions	Parameters	Required
CREATE		None	N/A
GET		None	N/A
REMOVE		None	N/A
UPDATE		None	N/A
PERFORM SET, PERFORM OBJECT	ADDTOGRP	ACTIVETIME(value)	No
		RESGROUP(value)	Yes
	INSTALL	PERIOD(value)	No
		SCOPE(value)	No

Table 2. STATDEF FEEDBACK error codes
Value	Code	Description
1	STATDEF_INV_DATA	Attribute data invalid
2	STATDEF_REC_NOT_FOUND	Requested resource not found
3	STATDEF_INV_REFERENCE	Attribute references an invalid resource
4	STATDEF_REC_EXISTS	Resource already exists
5	STATDEF_REC_CHANGED	Resource definition already changed
6	STATDEF_INV_RESTYPE	Invalid resource type
21	STATDEF_NONE_INSTALLED	None installed
22	STATDEF_PARTIAL_INSTALL	Partial install
23	STATDEF_NO_ACTIVE_SYSTEMS	No active systems

Table 3. STATDEF resource table attributes
Name	Datatype	Source	Len	Req	Sum	Description	Default	Value Range
NAME-1	CHAR	CPSM	8	Yes	DIFF	Name
ACTION	CHAR	CPSM	8	No	DIFF	Action definition name
CHANGEAGENT	CVDAS	CPSM	4	No	LIKE	Last modification agent
CHANGEAGENT Input/output valid values	DREPAPI N_A
CHANGEAGREL	CHAR	CPSM	4	No	DIFF	Last modification agent release
CHANGETIME	DATETIME	CPSM	8	Yes	MAX	Last modification
CHANGEUSRID	CHAR	CPSM	8	No	DIFF	Last modification user ID
CREATETIME	DATETIME	CPSM	8	Yes	MAX	Time created
DESC	CHAR	CPSM	58	No	DIFF	Description
DESCCODEPAGE	BINARY	CPSM	4	No	DIFF	Description code page	37	0-99999999
FREQ	BINARY	CPSM	4	Yes	AVG	Interval between calls to status program (seconds)	300	1-86400
HSENTRY	BINARY	CPSM	4	Yes	AVG	Evaluation count with HS true before event	1	1-9999
HSEXIT	BINARY	CPSM	4	Yes	AVG	Evaluation count with HS false before resolution	1	1-9999
HWENTRY	BINARY	CPSM	4	Yes	AVG	Evaluation count with HW true before event	1	1-9999
HWEXIT	BINARY	CPSM	4	Yes	AVG	Evaluation count with HW false before resolution	1	1-9999
LSENTRY	BINARY	CPSM	4	Yes	AVG	Evaluation count with LS true before event	1	1-9999
LSEXIT	BINARY	CPSM	4	Yes	AVG	Evaluation count with LS false before resolution	1	1-9999
LWENTRY	BINARY	CPSM	4	Yes	AVG	Evaluation count with LW true before event	1	1-9999
LWEXIT	BINARY	CPSM	4	Yes	AVG	Evaluation count with LW false before resolution	1	1-9999
STATPGM	CHAR	CPSM	8	No	DIFF	Status program name
TRANID	CHAR	CPSM	4	No	DIFF	Transaction ID for task
USERID	CHAR	CPSM	8	No	DIFF	User ID for task
VHSENTRY	BINARY	CPSM	4	Yes	AVG	Evaluation count with VHS true before event	1	1-9999
VHSEXIT	BINARY	CPSM	4	Yes	AVG	Evaluation count with VHS false before resolution	1	1-9999
VLSENTRY	BINARY	CPSM	4	Yes	AVG	Evaluation count with VLS true before event	1	1-9999
VLSEXIT	BINARY	CPSM	4	Yes	AVG	Evaluation count with VLS false before resolution	1	1-9999