RULERecordType

RULE Record

Fields

CICSRelease (String)
InstallationTime (String)

The local date and time when the definition was installed.

WLMOpenStatus (String)

The value to which z/OS WLM health OPENSTATUS is to be set. Values are:

  • CLOSED - Start decreasing the z/OS WLM health value
  • IMMCLOSE - Immediately set the z/OS WLM health value to 0
  • OPEN - Start increasing the z/OS WLM health value
  • NOTAPPLIC - OPENSTATUS not applicable for rules with a ACTION value of ABEND, EVENT, MESSAGE, or REJECT.
abendCode (String)

The abend code to be used when a task exceeds the values specified for a task rule threshold which has an ACTION value of ABEND.

action (String)

The action to be taken should all the conditions for this rule become true. Values are:

  • ABEND - Abend the task.
  • EVENT - Output an event.
  • MESSAGE - Output a message.
  • REJECT - Return a INVREQ response to the application
  • WLMHEALTH - Set the z/OS WLM health value
actionCount (Long)

The count of the number of times that the action for the rule has been performed since the region started.

actionCountStat (Long)

The count of the number of times that the action for the rule has been performed within the current statistics interval.

actualThresholdValue (NaLongType)

The actual value used to determine if a threshold has been exceeded for a task if the rule has a RULEGROUP value of TASK. It is derived from combining the VALUE and UNIT attributes.

baseApplicationMajorVersion (Long)

The major version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.

baseApplicationMicroVersion (Long)

The micro version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.

baseApplicationMinorVersion (Long)

The minor version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.

baseApplicationName (String)

The name of the application for which policy rules are being returned. If no application name is returned, then rules that apply to all applications are returned.

baseLevel (String)

The level from where this rule was originally installed. E.g. If the query is for a scope of APPLICATION and this rule was installed for the PLATFORM in which the application runs then PLATRTYPE would be shown. Value are:

  • APPLICATION - The policy rule applies at an application level.
  • APPLMAJVER - The policy rule applies at an application major version level.
  • APPLMICVER - The policy rule applies at an application micro version level.
  • APPLMINVER - The policy rule applies at an application minor version level.
  • OPERATION - The policy rule applies at an operation level.
  • PLATFORM - The policy rule applies at a platform or a region type level.
  • REGION - The policy rule applies at a region level.
basePlatformName (String)

The name of the platform to which the policy rule applies.

bundleDirectoryName (String)

The fully-qualified name of the directory on zFS for the bundle in which the policy that defines the rule was installed.

bundleID (String)

The ID of the bundle in which the rule's policy was installed.

bundleMajorVersion (Long)

The major version of the bundle in which the rule's policy was installed.

bundleMicroVersion (Long)

The micro version of the bundle in which the rule's policy was installed.

bundleMinorVersion (Long)

The minor version of the bundle in which the rule's policy was installed.

bundleName (String)

The name of the CICS BUNDLE resource in which the rule's policy was installed.

creationTime (String)

The local date and time when the resource definition record was created on DFHCSD or EYUDREP.

epAdapter (String)

The name of the event processing adapter that will be called when an action is performed for a rule with an ACTION value of EVENT.

epAdapterSet (String)

The name of the event processing adapter set that encapsulates the event processing adapters that will be called when an action is performed for a rule with an ACTION value of EVENT.

installationAgent (String)

The install agent identifier that made the installation:

  • BUNDLE - The resource was installed as a result of the installation of an XML bundle.
installationUserID (String)

The user ID that installed the resource definition.

lastActionTime (String)

Timestamp of the last occasion when the action for the rule was performed.

lastActionTimeStat (String)

Timestamp of the last occasion when the action for the rule was performed within the current statistics interval.

lastModificationAgent (String)

The change agent identifier that made the last modification.

  • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CSDBATCH - The resource was last changed by a DFHCSDUP job.
  • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
  • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
  • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
  • AUTOINSTALL - The resource was last autoinstalled.
  • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
  • NOTAPPLIC - This is not applicable for this resource.
lastModificationAgentRelease (String)

The CICS release level of the agent that made the last modification to the resource definition.

lastModificationTime (String)

The local date and time when the definition was last changed.

lastModificationUserID (String)

The user ID that made the last modification to the resource definition.

operationName (String)

The name of the application operation to which the policy rule applies. If no application operation name is returned, then the rule was applied to all operations.

operator (String)

The operator that will be used on the value to establish whether the task rule's condition has become true. Values are:

  • GT - Greater than.
  • NOTAPPLIC - operator not applicable for rules with a RULEGROUP value of SYSTEM.
policyName (String)

The name of the policy to which the rule belongs.

policyRule (String)

The name of the Policy Rule.

policySet (String)

The name of the run time policy set that contains the rule if the rule has a RULEGROUP value of TASK.

regionName (String)
ruleGroup (String)

The group to which this rule belongs. Values are:

  • TASK - Task rules.
  • SYSTEM - System rules.
ruleItem (String)

The type of request being monitored by a task rule. All blanks if the rule has a RULEGROUP value of SYSTEM. Values are:

  • cpulimit - CPU time
  • containerstorage - Container storage used
  • delete - File delete request
  • dlicommand - DLI command request
  • elapsedlimit - Elapsed time
  • getcounter - Get named counter request
  • link - Program link request
  • mqicommand - MQI request
  • read - File read request
  • readnext - File read next request
  • readprev - File read previous request
  • readq - TDQ read request or TSQ read request
  • readupdate - File read for update request
  • rewrite - File rewrite request
  • runtransid - Run Transid request
  • shared24 - Shared, 24 bit storage request
  • shared24request - Shared, 24 bit storage request
  • shared31 - Shared, 31 bit storage request
  • shared31request - Shared, 31 bit storage request
  • shared64 - Shared, 64 bit storage request
  • shared64request - Shared, 64 bit storage request
  • sqlcommand - SQL command request
  • start - START request
  • startbr - File start browse request
  • syncpoint - SYNCPOINT request
  • task24 - 24 bit storage request
  • task24request - 24 bit storage request
  • task31 - 31 bit storage request
  • task31request - 31 bit storage request
  • task64 - 64 bit storage request
  • task64request - 64 bit storage request
  • write - File write request
  • writeq - TDQ write request, TSQ write request or bytes written to TSQ
  • writeqaux - TSQ write auxiliary request or bytes written to auxiliary TSQ
  • writeqmain - TSQ write main request or bytes written to main TSQ
  • writeqshr - TSQ write shared request or bytes written to shared TSQ
ruleType (String)

The type of a task or system rule: Values are:

  • aidThreshold - Monitor the number AIDs in the CICS region.
  • asyncrequest - Monitor the number of asynchronous requests (i.e. CICS Run Transid commands) issued by a user task.
  • bundleAvailable- Monitor changes in availability status of a CICS BUNDLE resource.
  • bundleEnable - Monitor changes in enable status of a CICS BUNDLE resource.
  • compound - Monitor two or more system conditions and take action when all conditions are met.
  • containerstorage - Monitor the amount of container storage used by a user task.
  • databaserequest - Monitor the number of database requests (i.e. SQL or DLI commands) issued by a user task.
  • db2Connection - Monitor changes in status of a CICS DB2CONN resource.
  • dbctlConnection - Monitor changes in status of a connection to DBCTL.
  • fileEnable - Monitor changes in enable status of a CICS FILE resource.
  • fileOpen - Monitor changes in open status of a CICS FILE resource.
  • filerequest - Monitor the number of file access requests (i.e. CICS Read, Read update, Write, Rewrite, Delete, Start browse, Read next, or Read previous commands) issued by a user task.
  • ipicConnection - Monitor changes in status of a CICS IPCONN resource.
  • message - Monitor when CICS or CPSM messages are produced.
  • mroConnection - Monitor changes in status of a CICS MRO connection.
  • mqConnection - Monitor changes in status of a CICS MQCONN resource.
  • ncrequest - Monitor the number of named counter requests issued by a user task.
  • pipelineEnable - Monitor changes in enable status of a CICS PIPELINE resource.
  • programEnable - Monitor changes in enable status of a CICS PROGRAM resource.
  • programrequest - Monitor the number of EXEC CICS LINK requests issued by a user task.
  • startrequest - Monitor the number of EXEC CICS START requests issued by a user task.
  • storage - Monitor the amount of task or user storage below the line (24 bit), above the line (31 bit) or above the bar (64 bit) allocated by a user task.
  • storagerequest - Monitor the number of requests for task or user storage below the line (24 bit), above the line (31 bit) or above the bar (64 bit) issued by a user task.
  • syncpointrequest - Monitor the number of EXEC CICS SYNCPOINT requests issued by a user task.
  • taskThreshold - Monitor when the number of active tasks in a CICS system goes above or below a specific threshold.
  • tclassThreshold - Monitor when the number of active tasks in a CICS transaction class goes above or below a specific threshold.
  • tdqrequest - Monitor the number of transient data requests (i.e. CICS Read TD and Write TD commands) issued by a user task.
  • time - Monitor the amount of time (i.e CPU or elapsed) consumed by a user task.
  • transactionAbend - Monitor when a transaction encounters an unhandled abend.
  • transactionDump - Monitor the number of transaction dumps in the CICS region.
  • tsqbytes - Monitor the number of bytes for temporary storage written (i.e. CICS Write TS, Write TS Aux, Write TS Main and Write TS shared commands) by a user task.
  • tsqrequest - Monitor the number of temporary storage requests (i.e. CICS Read TS, Write TS, Write TS Aux, Write TS Main and Write TS shared commands) issued by a user task.
  • wmqrequest - Monitor the number of IBM MQ requests issued by a user task.
sourceOfTheResourceDefinition (String)

The source of the definition, depending on which made the last change.

specifiedThresholdValue (NaLongType)

The threshold value specified by the user if the rule has a RULEGROUP value of TASK.

userTag (String)

The user tag of the policy that contains the rule as specified by the policy XML.

valueUnits (String)

The unit qualifier that applies to the THRESHOLD value if the rule has a RULEGROUP value of TASK. Values are:

  • BYTE - unit scale relates to bytes of storage
  • KILOBYTE - unit scale relates to kilobytes of storage
  • MEGABYTE - unit scale relates to megabytes of storage
  • GIGABYTE - unit scale relates to gigabytes of storage
  • THOUSAND - unit is scaled in thousands
  • SECOND - unit relates to one second time intervals
  • MILLISECOND - unit relates to one millisecond time intervals
  • MICROSECOND - unit relates to one microsecond time intervals
  • NONE - no unit qualifier is applied
  • NOTAPPLIC - unit not applicable for rules with a RULEGROUP value of SYSTEM.